Shipment Status EDI - JSON Specification

Summary

The EDI-flavored JSON for shipment-status EDI, used as the Chain.io file type "chainioEventEDI". A single "freight_status" object drives EDI 214 (Transportation Carrier Shipment Status) and EDI 315 (Ocean Status Details) depending on the adapter's "output_type" configuration. A downstream JSONata map serializes the X12, so values are pre-coded to X12 code lists and any segment references are logical correspondence. There is no "version" or "doc_type". This is a denormalized superset of the canonical Event format; the tables below list every field the adapter emits. The adapter produces this JSON when its file format is set to JSON (otherwise it emits the equivalent XML).

Objects

Name	Description
Root	The top level document.
FreightStatus	The shipment status. Most values are strings and are omitted when the source has no value. Named port summaries sit at the root as "<port>_port" objects: by default departure_port, arrival_port, pickup_port, loading_port and delivery_port, plus transshipment_port. When the adapter has a port mapping configured, the mapping replaces the default port set, and the root carries one "<key>_port" object per configured key (a key already ending in "_port" is used as-is) plus transshipment_port.
NamedPort	A named port summary at the root. Unlike the "ports" loop, the date is kept split.
EventPortLocation	The event location as a port.
Port	A port in the "ports" loop.
Vessel	Vessel details.
Carrier	Carrier details.
StatusShipment	A shipment detail entry.
ShipmentDetails	The event status detail of a shipment.
PurchaseOrder	A purchase order.
NativeReferenceNumber	A coded reference number from the source system.
EntityName	A party keyed by X12 entity code.
Party	A party linked to the shipment.
ReferenceNumber	A configured additional reference number.
ConsolidationDetails	Consolidation references.
Container	A container.
ShipmentLeg	A transport leg. Datetimes are ISO 8601, null when not set.
LegCarrier	The carrier of a shipment leg.

Root top

Name	Data Type	Description	Required
`freight_status`	FreightStatus	The single shipment-status object.	YES

FreightStatus top

Name	Data Type	Description
`additional_reference_numbers`	Array<ReferenceNumber>	The additional reference numbers configured on the adapter. Only references with a value are included.
`airway_bill`	String	Air waybill number.
`all_marks_and_numbers`	Array<String>	Marks and numbers from every package group that has them.
`arrival_port`	NamedPort	Arrival port (arrival port date). A named port summary; present only when the shipment has a date for it (or the port mapping requires one).
`arrival_port_actual`	DateTime	Actual port arrival. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`arrival_port_estimated`	DateTime	Estimated port arrival. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`arrival_unlocode`	String	The arrival port UN/LOCODE.
`arrival_unlocode_description`	String	The arrival port description.
`carrier`	Carrier	Carrier details.
`carrier_booking_number`	String	The carrier booking number.
`carrier_instructions`	String	Carrier instructions.
`company_code`	String	The forwarder controlling company code.
`consolidation_details`	ConsolidationDetails	References of the consolidation the shipment belongs to.
`containerization_type`	String	The containerization type.
`containers`	Array<Container>	Container loop.
`customer_reference`	String	Customer reference.
`cutoff_time`	DateTime	The physical cutoff time. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`date_time`	DateTime	The event datetime (ISO 8601 UTC). Taken from the event, or from the shipment date or milestone the event mapping names.
`date_time_local`	DateTime	The event datetime in the event's local time zone, with offset.
`delivery_actual`	DateTime	Actual delivery. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`delivery_estimated`	DateTime	Estimated delivery. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`delivery_port`	NamedPort	Delivery (final port, delivery date). A named port summary; present only when the shipment has a date for it (or the port mapping requires one).
`departure_actual`	DateTime	Actual departure. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`departure_estimated`	DateTime	Estimated departure. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`departure_port`	NamedPort	Departure (port of lading, departure date). A named port summary; present only when the shipment has a date for it (or the port mapping requires one).
`entity_names`	Array<EntityName>	Party loop keyed by X12 entity code. For 214 (and 204) the CN and SH blocks are always written; for other output types a block is written only when the shipment names that party. Absent when there are no parties.
`equipment_initial`	String	Container owner prefix (first 4 characters of the container number). Optional unless listed in the adapter's additional required fields.
`equipment_number`	String	Container serial number (container number after the first 4 characters). Optional unless listed in the adapter's additional required fields.
`equipment_size`	String	Container size code. Optional unless listed in the adapter's additional required fields.
`equipment_status_code_override`	String	The equipment status code override configured for the event mapping.
`event_date_local_time_zone`	String	The local time zone of the event; UTC when none is known or recognized.
`event_port_location`	EventPortLocation	The event location as a port. Always present.
`firms_code`	String	The arrival terminal FIRMS code. Optional unless listed in the adapter's additional required fields.
`flow_execution_uuid`	String	The Chain.io flow execution id that produced the file.
`forwarder_controlling_branch_code`	String	The forwarder controlling branch.
`house_bill`	String	House bill of lading.
`lloyds_imo`	String	The vessel Lloyds / IMO number. Optional unless listed in the adapter's additional required fields.
`loading_port`	NamedPort	Loading (port of lading, loading date). A named port summary; present only when the shipment has a date for it (or the port mapping requires one).
`location_identifier`	String	The event location (UN/LOCODE), taken from the shipment or event field the event mapping names. Optional unless listed in the adapter's additional required fields.
`location_qualifier`	String	Always UN.
`master_bill`	String	Master bill of lading. Required unless listed in the adapter's additional optional fields.
`notes`	String	The event message.
`parties`	Array<Party>	Role-keyed party loop for the parties linked to the shipment. Only parties with a name are included.
`pickup_actual`	DateTime	Actual pickup. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`pickup_estimated`	DateTime	Estimated pickup. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`pickup_port`	NamedPort	Pickup (port of lading, pickup date). A named port summary; present only when the shipment has a date for it (or the port mapping requires one).
`port_of_entry_code_mapped`	String	The mapped port of entry code. Optional unless listed in the adapter's additional required fields.
`ports`	Array<Port>	Port loop with ISO datetimes: one entry per port in the default set (or the configured port mapping) that has a date, plus a relay port when the shipment has a second leg. Transshipment is not included here.
`pro_number`	String	PRO number for a truck shipment. Optional unless listed in the adapter's additional required fields.
`receiving_exception_code`	String	The event receiving exception code.
`reference_number`	String	The forwarder reference. Optional unless listed in the adapter's additional required fields.
`relay_arrival_actual`	DateTime	Actual arrival of the first shipment leg; present only when the shipment has a second leg. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`relay_arrival_estimated`	DateTime	Estimated arrival of the first shipment leg; present only when the shipment has a second leg. A milestone datetime lifted from the adapter's date collection (ISO 8601); null when the shipment has no value.
`service_level`	String	The shipment service level.
`service_level_description`	String	The shipment service level description.
`ship_to_name`	String	The shipment ship-to name.
`shipment_identifier`	String	The shipment identifier from the event.
`shipment_import_entry_number`	String	The import entry number. Optional unless listed in the adapter's additional required fields.
`shipment_legs`	Array<ShipmentLeg>	Transport leg loop, ordered by leg sequence number.
`shipment_mode`	String	The transport mode. Required unless listed in the adapter's additional optional fields.
`shipments`	Array<StatusShipment>	Shipment detail loop (status, weights, POs, references). Always a single entry.
`shipper_reference`	String	Shipper reference. Optional unless listed in the adapter's additional required fields.
`shipper_shipment_id`	String	The shipper's shipment id from the event.
`source_system_shipment_id`	String	The shipment identifier from the system of record.
`status_code`	String	The mapped event / status code from the adapter's event mapping.
`status_reason_code`	String	The status reason code: the mapped reason code, or the source event reason code.
`stop_number`	String	The event stop number.
`transshipment_port`	NamedPort	Transshipment port (transshipment arrival date). Always part of the named set, with or without a port mapping. A named port summary; present only when the shipment has a date for it (or the port mapping requires one).
`vessel`	Vessel	Vessel details.

NamedPort top

Name	Data Type	Description
`city`	String	The UN/LOCODE description.
`code`	String	The port key (e.g. departure, arrival_port, transshipment).
`code_qualifier`	String	Always UN.
`country`	String	Country code (2 characters).
`date`	String	The date in YYYYMMDD. Optional unless the port mapping requires the date.
`date_qualifier`	String	140 when the actual date is used, 139 when the estimate is used.
`time`	String	The time in HHmm. Optional unless the port mapping requires the date.
`unlocode`	String	The UN/LOCODE. Optional unless the port mapping (or the additional required fields) requires the location.

EventPortLocation top

Name	Data Type	Description
`code`	String	The port key whose location matches the event location, or triggered_event when none does (the unlocode then comes from the event).
`code_qualifier`	String	Always UN.
`date_qualifier`	String	139 when the event mapping marks the date as an estimate, otherwise 140.
`date_time`	DateTime	The event datetime (ISO 8601).
`unlocode`	String	The event location UN/LOCODE.

Port top

Name	Data Type	Description
`city`	String	The UN/LOCODE description.
`code`	String	The port key: departure, arrival_port, pickup, loading or delivery by default, the configured keys when a port mapping is set, or relay for the relay port.
`code_qualifier`	String	Always UN.
`country`	String	Country code (2 characters).
`date_qualifier`	String	140 when the actual date is used, 139 when the estimate is used.
`date_time`	DateTime	The datetime (ISO 8601).
`unlocode`	String	The UN/LOCODE. Optional unless the port mapping (or the additional required fields) requires the location.

Vessel top

Name	Data Type	Description
`arrival_date`	DateTime	The estimated port arrival date (midnight UTC).
`departure_date`	DateTime	The estimated departure date (midnight UTC).
`vessel_code`	String	The vessel name.
`vessel_name`	String	Vessel name.
`voyage_number`	String	Voyage number.

Carrier top

Name	Data Type	Description
`name`	String	Carrier name.
`scac`	String	Carrier SCAC. Required unless listed in the adapter's additional optional fields.
`voyage`	String	Voyage number.

StatusShipment top

Name	Data Type	Description
`assigned_number`	String	Always 01.
`chargeable_weight`	String	Chargeable weight in kilograms.
`chargeable_weight_original_uom`	String	The source chargeable weight unit.
`native_reference_numbers`	Array<NativeReferenceNumber>	Coded reference numbers from the source system.
`package_count`	String	Package count.
`package_type_code`	String	Package type code.
`purchase_orders`	Array<PurchaseOrder>	Purchase orders.
`shipment_details`	ShipmentDetails	The event status detail.
`volume`	String	Volume in cubic meters.
`volume_original_uom`	String	The source volume unit.
`weight`	String	Gross weight in kilograms.
`weight_original_uom`	String	The source gross weight unit.

ShipmentDetails top

Name	Data Type	Description
`city`	String	The event city, from the source the event mapping names. Present only when the event mapping sets a city source, and then required unless listed in the additional optional fields.
`country`	String	The event country, from the source the event mapping names. Present only when the event mapping sets a country source, and then required unless listed in the additional optional fields.
`date_time`	DateTime	The event datetime (ISO 8601).
`event_name`	String	The source event name.
`shipment_identifier`	String	The shipment identifier from the event.
`state`	String	The event state, from the source the event mapping names. Present only when the event mapping sets a state source.
`status_code`	String	The source event code. Required.

PurchaseOrder top

Name	Data Type	Description	Required
`customer_order_number`	String	The purchase order number.

NativeReferenceNumber top

Name	Data Type	Description
`code`	String	The reference code.
`data_source`	String	The source system.
`description`	String	A description of the reference.
`value`	String	The reference value.
`value_context`	String	Context of the value (e.g. DateTime).

EntityName top

Name	Data Type	Description
`address_1`	String	Address line 1. Required for CN / SH on 214 and 204 unless listed in the additional optional fields.
`address_2`	String	Address line 2.
`city`	String	City.
`code`	String	The X12 entity code: CN = ship-to, SH = ship-from, N5 = the party that received the shipment (name only).
`contact_name`	String	Contact name.
`country`	String	Country code.
`location_id`	String	Location identifier.
`name`	String	Party name.
`postal_code`	String	Postal / ZIP code.
`state`	String	State / province, translated through the configured state code mapping when one is set.
`unlocode`	String	UN/LOCODE.

Party top

Name	Data Type	Description
`city`	String	City.
`country`	String	Country.
`name`	String	Party name.
`owners_id`	String	The owner / party code.
`role`	String	The party role: shipper, consignee, consignor, carrier, receiving_freight_forwarder, global_customer or forwarder_customer.
`state`	String	State / province, translated through the configured state code mapping when one is set.

ReferenceNumber top

Name	Data Type	Description	Required
`code`	String	The configured reference qualifier.
`value`	String	The value read from the configured document and property, or the configured hardcoded value.

ConsolidationDetails top

Name	Data Type	Description	Required
`forwarder_reference`	String	The consolidation forwarder reference.
`shipper_reference`	String	The consolidation shipper reference.

Container top

Name	Data Type	Description
`arrival_delivery_actual`	DateTime	Actual arrival delivery (ISO 8601); null when not set.
`arrival_delivery_estimated`	DateTime	Estimated arrival delivery (ISO 8601); null when not set.
`container_number`	String	The full container number.
`delivery_mode`	String	Delivery mode. Optional unless listed in the additional required fields.
`equipment_initial`	String	Owner prefix (first 4 characters).
`equipment_number`	String	Serial number (after the first 4 characters).
`gross_weight_kgs`	String	Gross weight in kilograms.
`gross_weight_original_uom`	String	The source gross weight unit.
`po_number`	String	Associated PO number.
`seal_1`	String	Seal number.
`size_code`	String	Size code.
`size_code_mapped`	String	The size code after the configured size code mappings.
`tare_weight_kgs`	String	Tare weight in kilograms.
`type_code`	String	Type code.

ShipmentLeg top

Name	Data Type	Description
`arrival_actual`	DateTime	Actual arrival.
`arrival_estimated`	DateTime	Estimated arrival.
`arrival_unlocode`	String	Port of arrival (UN/LOCODE).
`arrival_unlocode_description`	String	Port of arrival description.
`carrier`	LegCarrier	The leg carrier.
`cto_cutoff_end`	DateTime	The container terminal cutoff window end.
`cto_cutoff_start`	DateTime	The container terminal cutoff window start.
`departure_actual`	DateTime	Actual departure.
`departure_estimated`	DateTime	Estimated departure.
`lading_unlocode`	String	Port of lading (UN/LOCODE).
`lading_unlocode_description`	String	Port of lading description.
`leg_sequence_number`	String	The leg order.
`leg_type`	String	The leg type (e.g. MAIN).
`mode`	String	Transport mode.
`vessel_name`	String	Vessel name.
`voyage_number`	String	Voyage number.

LegCarrier top

Name	Data Type	Description	Required
`name`	String	Carrier name.
`scac`	String	Carrier SCAC (the carrier party SCAC, or the leg carrier SCAC).

EDI Formats

Shipment Status EDI - JSON Specification

Summary

Objects

Root top

FreightStatus top

NamedPort top

EventPortLocation top

Port top

Vessel top

Carrier top

StatusShipment top

ShipmentDetails top

PurchaseOrder top

NativeReferenceNumber top

EntityName top

Party top

ReferenceNumber top

ConsolidationDetails top

Container top

ShipmentLeg top

LegCarrier top

Example

EDI Formats

Shipment Status EDI - JSON Specification

Summary

Objects

Example

View as Plain TextCopy