Load Tender EDI - JSON Specification

Summary

The EDI-flavored JSON for an EDI 204 (Motor Carrier Load Tender), used as the Chain.io source file type "chainioEDIJSONLoadTender". This is an INPUT format: an EDI translator converts an inbound 204 into this JSON, which Chain.io then maps to its canonical documents. Reference qualifiers and stop structures follow X12 conventions (L11 reference qualifiers, S5 stops); segment references below are logical correspondence. Exactly one file is expected and the top-level "shipment" object is required.

Objects

Name	Description
Root	The top level document.
Shipment	A single load tender.
Note	A free-text note.
Party	A named party with an address.
Address	A postal address.
ReferenceNumber	A coded reference number (X12 L11).
TransportationStop	A single stop in the load tender (X12 S5 loop).
OrderDetails	Order-level detail carried on a stop.
OrderLine	A single order line within a stop's order details.
AppointmentWindow	An appointment window bound.
StopLocation	The address and role of a stop.

Root top

Name	Data Type	Description	Required
`shipment`	Shipment	The load-tender shipment object.	YES

Shipment top

Name	Data Type	Description
`action_type`	String	The tender action, e.g. "create".
`booking_reference`	String	The booking / tender reference.
`carrier_instructions`	String	Free-text carrier instructions.
`consignee`	Party	The consignee (destination) party.
`consignor`	Party	The consignor (origin) party.
`forwarder_controlling_branch_code`	String	The controlling forwarder branch.
`forwarders_shipper_id`	String	Accepted but ignored on input: the value used is the adapter configuration's customer number.
`freight_payment_terms`	String	Payment terms. PP = prepaid, CC = collect.
`fuel_surcharge_due`	Number	Fuel surcharge amount. Copied unchanged (no cents conversion) into the invoice surcharge amount.
`linehaul_due`	Number	Line-haul charge. Copied unchanged (no cents conversion) into the invoice subtotal.
`notes`	Array<Note>	Header-level notes.
`reference_numbers`	Array<ReferenceNumber>	Header reference numbers (X12 L11).
`shipper_reference`	String	The shipper reference.
`total_due`	Integer	Total charge in CENTS. Converted to dollars on the resulting invoice. A falsy value means no invoice is produced.
`transportation_stops`	Array<TransportationStop>	Ordered stops (X12 S5 loop).

Note top

Name	Data Type	Description	Required
`body`	String	The note text.
`qualifier`	String	A note qualifier. Accepted but not mapped.

Party top

Name	Data Type	Description	Required
`address`	Address	The party address.
`name`	String	The party name.

Address top

Name	Data Type	Description
`address_1`	String	Address line 1.
`address_2`	String	Address line 2.
`city`	String	City.
`country`	String	Country code.
`name`	String	The name at the address.
`postal_code`	String	Postal / ZIP code.
`state`	String	State / province.

ReferenceNumber top

Name	Data Type	Description	Required
`qualifier`	String	The X12 reference qualifier (L1103), e.g. BM, MB, DCO, TTL, SW.
`value`	String	The reference value (L1102).

TransportationStop top

Name	Data Type	Description
`appointment_window_end`	AppointmentWindow	The appointment window close.
`appointment_window_start`	AppointmentWindow	The appointment window open.
`bill_of_lading`	String	The bill of lading number.
`carrier_reference`	String	The carrier reference.
`contact_email`	String	Stop contact email.
`contact_name`	String	Stop contact name.
`contact_phone`	String	Stop contact phone.
`container_number`	String	The container number.
`container_type`	String	The container type.
`gross_weight`	Number	Weight in the UOM below. When the UOM is "L" (pounds) it is converted to kilograms.
`gross_weight_original_uom`	String	Weight UOM. "L" = pounds, otherwise treated as kilograms.
`notes`	Array<Note>	Stop-level notes.
`order_details`	OrderDetails	Order / commodity detail for the stop (X12 OID loop).
`quantity`	Number	Piece / handling-unit count.
`reference_numbers`	Array<ReferenceNumber>	Stop-level reference numbers (X12 L11).
`release_number`	String	The release number.
`reservation_number`	String	The reservation number.
`seal`	String	The seal number.
`sequence`	Integer	The stop order.
`shipper_shipment_id`	String	The shipper shipment id.
`stop_location`	StopLocation	The stop address / role.
`stop_reason`	String	The stop reason, e.g. "pickup".
`stop_reason_code`	String	The stop reason code, e.g. CL, DR.

OrderDetails top

Name	Data Type	Description	Required
`order_lines`	Array<OrderLine>	The order lines for the stop.

OrderLine top

Name	Data Type	Description	Required
`commodity_type_description`	String	A free-text description of the commodity.

AppointmentWindow top

Name	Data Type	Description	Required
`date`	String	Date in YYYYMMDD.
`time`	String	Time in HHMM (defaults to 0000 when absent or invalid).

StopLocation top

Name	Data Type	Description
`address_1`	String	Address line 1.
`address_2`	String	Address line 2.
`city`	String	City.
`country`	String	Country code.
`location_type`	String	The stop role. SF = Ship From / origin, CN = Consignee / destination.
`name`	String	Location name.
`owners_id`	String	The party / owner code.
`postal_code`	String	Postal / ZIP code.
`state`	String	State / province.

EDI Formats

Load Tender EDI - JSON Specification

Summary

Objects

Root top

Shipment top

Note top

Party top

Address top

ReferenceNumber top

TransportationStop top

OrderDetails top

OrderLine top

AppointmentWindow top

StopLocation top

Example

EDI Formats

Load Tender EDI - JSON Specification

Summary

Objects

Example

View as Plain TextCopy