Motor carrier load tender example: ODF Shipper wants ODF Carrier to load a full truck from one of the ODF Shipper's locations and unload it to an ODF Shipper customer's destination.
Update sender and receiver to test
If you want to use this example within your own test transaction, make sure you edit the sender (
ODF_SUPPLIER
) and receiver (ODF_BUYER
) ISA IDs.
Motor Carrier Load Tender Example Transaction
{
"type": {
"name": "204_MOTOR_CARRIER_LOAD_TENDER"
},
"stream": "test",
"sender": {
"isaId": "string"
},
"receiver": {
"isaId": "string"
},
"message": {
"transactionSets": [
{
"transactionSetHeader": [
{
"transactionSetIdentifierCode": "204",
"transactionSetControlNumber": "001"
}
],
"beginningSegmentForShipmentInformationTransaction": [
{
"standardCarrierAlphaCode": "ODFS",
"shipmentIdentificationNumber": "SH1234",
"shipmentMethodOfPaymentCode": "PP"
}
],
"setPurpose": [
{
"transactionSetPurposeCode": "00",
"applicationTypeCode": "LT"
}
],
"businessInstructionsAndReferenceNumber": [
{
"referenceIdentification": "ODFS11112",
"referenceIdentificationQualifier": "BM"
},
{
"referenceIdentification": "PO1234321",
"referenceIdentificationQualifier": "CO"
}
],
"S5_loop": [
{
"stopOffDetails": [
{
"stopSequenceNumber": "1",
"stopReasonCode": "LD"
}
],
"dateTime": [
{
"dateQualifier": "10",
"date": "20200901",
"timeQualifier": "4",
"time": "1800",
"timeCode": "ET"
}
],
"N1_loop": [
{
"partyIdentification": [
{
"entityIdentifierCode": "SF",
"name": "ODF PICK UP LOCATION"
}
],
"partyLocation": [
{
"addressInformation": "123 MAIN ROAD"
}
],
"geographicLocation": [
{
"cityName": "SEATTLE",
"stateOrProvinceCode": "WA",
"postalCode": "98101"
}
],
"contact": [
{
"contactFunctionCode": "IC",
"name": "JOHN",
"communicationNumberQualifier": "TE",
"communicationNumber": "415-123-4567"
}
]
}
]
},
{
"stopOffDetails": [
{
"stopSequenceNumber": "2",
"stopReasonCode": "UL"
}
],
"dateTime": [
{
"dateQualifier": "68",
"date": "20201902",
"timeQualifier": "5",
"time": "1100",
"timeCode": "ET"
}
],
"N1_loop": [
{
"partyIdentification": [
{
"entityIdentifierCode": "ST",
"name": "ODF SHIPPER FINAL CUSTOMER"
}
],
"partyLocation": [
{
"addressInformation": "120 MARKET STREET"
}
],
"geographicLocation": [
{
"cityName": "SAN JOSE",
"stateOrProvinceCode": "CA",
"postalCode": "94209",
"countryCode": "USA"
}
],
"contact": [
{
"communicationNumberQualifier": "TE",
"communicationNumber": "803-739-2009"
}
]
}
]
}
],
"totalWeightAndCharges": [
{
"weight": "2780.71",
"weightQualifier": "G",
"volume": "510.88",
"volumeUnitQualifier": "E",
"ladingQuantity": "19"
}
],
"transactionSetTrailer": [
{
"numberOfIncludedSegments": "19",
"transactionSetControlNumber": "001"
}
]
}
]
}
}
ISA*00* *00* *ZZ*ODF_SHIPPER *ZZ*ODF_CARRIER *202000831*1610*U*401*001234321*0*T*>~
GS*SM*ODF_SHIPPER*ODF_CARRIER*20200831*1610*1234321*X*004010~
ST*204*001~
B2**ODFS**SH1234**PP~
B2A*00*LT~
L11*ODFS11112*BM~
L11*PO1234321*CO~
S5*1*LD~
G62*10*20200901*4*1800*ET~
N1*SF*ODF PICK UP LOCATION~
N3*123 MAIN ROAD~
N4*SEATTLE*WA*98101~
G61*IC*JOHN*TE*415-123-4567~
S5*2*UL~
G62*68*20201902*5*1100*ET~
N1*ST*ODF SHIPPER FINAL CUSTOMER~
N3*120 MARKET STREET~
N4*SAN JOSE*CA*94209*USA~
G61***TE*803-739-2009~
L3*2780.71*G*******510.88*E*19~
SE*19*001~
B2 Beginning Segment for Shipment Information Transaction
This segment contains the header information.
"beginningSegmentForShipmentInformationTransaction": [
{
"standardCarrierAlphaCode": "ODFS",
"shipmentIdentificationNumber": "SH1234",
"shipmentMethodOfPaymentCode": "PP"
}
]
B2**ODFS**SH1234**PP~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
standardCarrierAlphaCode | B202 | ODFS | This element contains the transportation company identifier of the carrier. |
shipmentIdentificationNumber | B204 | SH1234 | This is the shipment ID. |
shipmentMethodOfPaymentCode | B206 | PP | This is the payment code of the shipment.PP here means "Prepaid". Other possible values include CC (Collect) and TP (Third Party) |
B2A Set Purpose
The B2A segment identifies the purpose of the transaction.
"setPurpose": [
{
"transactionSetPurposeCode": "00",
"applicationTypeCode": "LT"
}
]
B2A*00*LT~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
transactionSetPurposeCode | B2A01 | 00 | This identifies the purpose of the transaction. In this case 00 means "Original". Other possible values include 01 (Cancellation) and 04 (Update). |
applicationTypeCode | B2A02 | LT | The type of transaction. In this case it is LT meaning "Load Tender". |
L11 Business Instructions and Reference Number
This segment contains relevant reference numbers to the transaction. This is commonly used for custom key-value pairs.
"businessInstructionsAndReferenceNumber": [
{
"referenceIdentification": "ODFS11112",
"referenceIdentificationQualifier": "BM"
},
{
"referenceIdentification": "PO1234321",
"referenceIdentificationQualifier": "CO"
}
]
L11*ODFS11112*BM~
L11*PO1234321*CO~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
referenceIdentification | L1101 | ODFS11112 | The reference number |
referenceIdentificationQualifier | L1102 | BM | The qualifier of the reference number describing the referenceIdentification (L1101) element.In this example BM is "Bill of lading number". |
S5 Loop
This loop contains stop details of the transaction. Each stop is identified by a child element of stopOffDetails
.
"S5_loop": [
{
"stopOffDetails": [
{
"stopSequenceNumber": "1",
"stopReasonCode": "LD"
}
],
"dateTime": [
{
"dateQualifier": "010",
"date": "20200901",
"timeQualifier": "004",
"time": "1800",
"timeCode": "ET"
}
],
"N1_loop": [
{
"partyIdentification": [
{
"entityIdentifierCode": "SF",
"name": "ODF PICK UP LOCATION"
}
],
"partyLocation": [
{
"addressInformation": "123 MAIN ROAD"
}
],
"geographicLocation": [
{
"cityName": "SEATTLE",
"stateOrProvinceCode": "WA",
"postalCode": "98101"
}
],
"contact": [
{
"contactFunctionCode": "IC",
"name": "JOHN",
"communicationNumberQualifier": "TE",
"communicationNumber": "415-123-4567"
}
]
}
]
},
{
"stopOffDetails": [
{
"stopSequenceNumber": "2",
"stopReasonCode": "UL"
}
],
"dateTime": [
{
"dateQualifier": "68",
"date": "20201902",
"timeQualifier": "005",
"time": "1100",
"timeCode": "ET"
}
],
"N1_loop": [
{
"partyIdentification": [
{
"entityIdentifierCode": "ST",
"name": "ODF SHIPPER FINAL CUSTOMER"
}
],
"partyLocation": [
{
"addressInformation": "120 MARKET STREET"
}
],
"geographicLocation": [
{
"cityName": "SAN JOSE",
"stateOrProvinceCode": "CA",
"postalCode": "94209",
"countryCode": "USA"
}
],
"contact": [
{
"communicationNumberQualifier": "TE",
"communicationNumber": "803-739-2009"
}
]
}
]
}
]
S5*1*LD~
G62*010*20200901*004*1800*ET~
N1*SF*ODF PICK UP LOCATION~
N3*123 MAIN ROAD~
N4*SEATTLE*WA*98101~
G61*IC*JOHN*TE*415-123-4567~
S5*2*UL~
G62*68*20201902*5*1100*ET~
N1*ST*ODF SHIPPER FINAL CUSTOMER~
N3*120 MARKET STREET~
N4*SAN JOSE*CA*94209*USA~
G61***TE*803-739-2009~
S5 Stop-off Details
This segment identifies the stop.
"stopOffDetails": [
{
"stopSequenceNumber": "1",
"stopReasonCode": "LD"
}
]
S5*1*LD~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
stopSequenceNumber | S501 | 1 | The sequence of the stop. In this example, this is the first stop. |
stopReasonCode | S502 | LD | The reason code of the stop. In this example LD means "Load". |
G62 Date/Time
The G62 segment contains relevant date/time information for each stop.
"dateTime": [
{
"dateQualifier": "10",
"date": "20200901",
"timeQualifier": "004",
"time": "1800",
"timeCode": "ET"
}
]
G62*10*20200901*004*1800*ET~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
dateQualifier | G6201 | 10 | |
date | G6202 | 20200901 | |
timeQualifier | G6203 | 004 | |
time | G6204 | 1800 | |
timeCode | G6205 | ET |
N1 Loop
The N1 loop contains address information for each stop.
"N1_loop": [
{
"partyIdentification": [
{
"entityIdentifierCode": "SF",
"name": "ODF PICK UP LOCATION"
}
],
"partyLocation": [
{
"addressInformation": "123 MAIN ROAD"
}
],
"geographicLocation": [
{
"cityName": "SEATTLE",
"stateOrProvinceCode": "WA",
"postalCode": "98101"
}
],
"contact": [
{
"contactFunctionCode": "IC",
"name": "JOHN",
"communicationNumberQualifier": "TE",
"communicationNumber": "415-123-4567"
}
]
}
]
N1*SF*ODF PICK UP LOCATION~
N3*123 MAIN ROAD~
N4*SEATTLE*WA*98101~
G61*IC*JOHN*TE*415-123-4567~
N1 Party Identification
The partyIdentification
segment describes the address.
"partyIdentification": [
{
"entityIdentifierCode": "SF",
"name": "ODF PICK UP LOCATION"
}
]
N1*SF*ODF PICK UP LOCATION~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
entityIdentifierCode | N101 | SF | This is the code that describes the address. In this example SF means "Ship From" |
name | N102 | ODF PICK UP LOCATION | This is the name of the address. |
N3 Party Location
The partyLocation
element contains the first line of the address.
"partyLocation": [
{
"addressInformation": "123 MAIN ROAD"
}
]
N3*123 MAIN ROAD~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
addressInformation | N301 | 123 MAIN ROAD | Address line 1. |
N3 Geographic Location
The geographicLocation
segment identifies the details of the address.
"geographicLocation": [
{
"cityName": "SEATTLE",
"stateOrProvinceCode": "WA",
"postalCode": "98101"
}
]
N4*SEATTLE*WA*98101~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
cityName | N401 | SEATTLE | The city name. |
stateOrProvinceCode | N402 | WA | The state or province. |
postalCode | N403 | 98101 | The postal code. |
G61 Contact
The contact segment provides the contact name responsible at the address.
"contact": [
{
"contactFunctionCode": "IC",
"name": "JOHN",
"communicationNumberQualifier": "TE",
"communicationNumber": "415-123-4567"
}
]
}
]
G61*IC*JOHN*TE*415-123-4567~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
contactFunctionCode | G6101 | IC | The type of contact at the address. In this case, IC means "Information Contact". |
name | G6102 | JOHN | The contact's name. |
communicationNumberQualifier | G6103 | TE | Qualifier describing the communicationNumber fieldIn this case, TE indicates that it is a phone number. |
communicationNumber | G6104 | 415-123-4567 | The communication number. |
L3 Total Weight and Charges
This segment totals all the lines in the transaction to provide a summary of the load.
"totalWeightAndCharges": [
{
"weight": "2780.71",
"weightQualifier": "G",
"volume": "510.88",
"volumeUnitQualifier": "E",
"ladingQuantity": "19"
}
]
L3*2780.71*G*******510.88*E*19~
JSON Element | X12 Element | Value | Description |
---|---|---|---|
weight | L301 | 2780.71 | The total weight |
weightQualifier | L302 | G | The type of the weight. In this case, G means "Gross Weight". |
volume | L309 | 510.88 | The total volume |
volumeUnitQualifier | L310 | E | The unit of measure qualifier of the volume. In this example E means "Cubic feet". |
ladingQuantity | L311 | 19 | Total pieces |
Motor Carrier Load Tender Structure
"interchangeControlHeader", //Interchange Control Header
"functionalGroupHeader", //Functional Group Header
"transactionSets"
"transactionSetHeader", //Transaction Set Header
"beginningSegmentForShipmentInformationTransaction", //Beginning Segment for Shipment Information Transaction
"setPurpose", //Set Purpose
"businessInstructionsAndReferenceNumber", //Business Instructions and Reference Number
"S5_loop"
"stopOffDetails", //Stop-off Details
"dateTime", //Date/Time
"N1_loop",
"partyIdentification", //Name
"partyLocation", //Address Information
"geographicLocation", //Geographic Location
"contact", //Contact
"totalWeightAndCharges", //Total Weight and Charges
"transactionSetTrailer" //Transaction Set Trailer
ISA //Interchange Control Header
.GS //Functional Group Header
..ST //Transaction Set Header
...B2 //Beginning Segment for Shipment Information Transaction
...B2A //Set Purpose
...L11 //Business Instructions and Reference Number
...L11 //Business Instructions and Reference Number
...S5 //Stop-off Details
....G62 //Date/Time
....N1 //Name
.....N3 //Address Information
.....N4 //Geographic Location
.....G61 //Contact
...L3 //Total Weight and Charges
..SE //Transaction Set Trailer
.GS //Functional Group Trailer
ISA //Interchange Control Trailer