After the Load Tender and the Accept Response, ODF carrier is giving status updates to ODF Shipper about the shipment.

We have 4 transaction examples that show different status updates:

  • X3 = ODF Carrier arrived at the pick-up location
  • AF = ODF Carrier departed from the pick-up location with the shipment loaded on the truck
  • X1 = ODF Carrier arrived at the delivery location with the shipment
  • D1 = ODF Carrier unloaded the shipment at the delivery location

🚧

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.

Transportation Carrier Shipment Status Message Example

{
    "type": {
        "name": "214_TRANSPORTATION_CARRIER_SHIPMENT_STATUS_MESSAGE"
    },
    "stream": "test",
        "sender": {
        "isaId": "string"
    },
    "receiver": {
        "isaId": "string"
    },
    "message": {
  "transactionSets": [
    {
      "transactionSetHeader": [
        {
          "transactionSetIdentifierCode": "214",
          "transactionSetControlNumber": "0001"
        }
      ],
      "beginningSegmentForTransportationCarrierShipmentStatusMessage": [
        {
          "referenceIdentification": "ODFS11112",
          "shipmentIdentificationNumber": "SH1234",
          "standardCarrierAlphaCode": "ODFC"
        }
      ],
      "LX_loop": [
        {
          "transactionSetLineNumber": [
            {
              "assignedNumber": "1"
            }
          ],
          "AT7_loop": [
            {
              "shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "X3",
                  "shipmentStatusOrAppointmentReasonCode": "NS",
                  "date": "20200901",
                  "time": "1500",
                  "timeCode": "LT"
                }
              ],
              "equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SEATTLE",
                  "stateOrProvinceCode": "WA",
                  "countryCode": "USA"
                }
              ]
            }
          ]
        }
      ],
      "transactionSetTrailer": [
        {
          "numberOfIncludedSegments": "6",
          "transactionSetControlNumber": "0001"
        }
      ]
    }
  ]
}
}
{
    "type": {
        "name": "214_TRANSPORTATION_CARRIER_SHIPMENT_STATUS_MESSAGE"
    },
    "stream": "test",
        "sender": {
        "isaId": "string"
    },
    "receiver": {
        "isaId": "string"
    },
    "message": {
  "transactionSets": [
    {
      "transactionSetHeader": [
        {
          "transactionSetIdentifierCode": "214",
          "transactionSetControlNumber": "0001"
        }
      ],
      "beginningSegmentForTransportationCarrierShipmentStatusMessage": [
        {
          "referenceIdentification": "ODFS11112",
          "shipmentIdentificationNumber": "SH1234",
          "standardCarrierAlphaCode": "ODFC"
        }
      ],
      "LX_loop": [
        {
          "transactionSetLineNumber": [
            {
              "assignedNumber": "1"
            }
          ],
          "AT7_loop": [
            {
              "shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "AF",
                  "date": "20200901",
                  "time": "1700",
                  "timeCode": "LT"
                }
              ],
              "equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SEATTLE",
                  "stateOrProvinceCode": "WA",
                  "countryCode": "USA"
                }
              ]
            }
          ]
        }
      ],
      "transactionSetTrailer": [
        {
          "numberOfIncludedSegments": "6",
          "transactionSetControlNumber": "0001"
        }
      ]
    }
  ]
}
}
{
    "type": {
        "name": "214_TRANSPORTATION_CARRIER_SHIPMENT_STATUS_MESSAGE"
    },
    "stream": "test",
        "sender": {
        "isaId": "string"
    },
    "receiver": {
        "isaId": "string"
    },
    "message": {
  "transactionSets": [
    {
      "transactionSetHeader": [
        {
          "transactionSetIdentifierCode": "214",
          "transactionSetControlNumber": "0001"
        }
      ],
      "beginningSegmentForTransportationCarrierShipmentStatusMessage": [
        {
          "referenceIdentification": "ODFS11112",
          "shipmentIdentificationNumber": "SH1234",
          "standardCarrierAlphaCode": "ODFC"
        }
      ],
      "LX_loop": [
        {
          "transactionSetLineNumber": [
            {
              "assignedNumber": "1"
            }
          ],
          "AT7_loop": [
            {
              "shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "X1",
                  "date": "20200902",
                  "time": "1200",
                  "timeCode": "LT"
                }
              ],
              "equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SAN JOSE",
                  "stateOrProvinceCode": "CA",
                  "countryCode": "USA"
                }
              ]
            }
          ]
        }
      ],
      "transactionSetTrailer": [
        {
          "numberOfIncludedSegments": "6",
          "transactionSetControlNumber": "0001"
        }
      ]
    }
  ]
}
}
{
    "type": {
        "name": "214_TRANSPORTATION_CARRIER_SHIPMENT_STATUS_MESSAGE"
    },
    "stream": "test",
        "sender": {
        "isaId": "string"
    },
    "receiver": {
        "isaId": "string"
    },
    "message": {
  "transactionSets": [
    {
      "transactionSetHeader": [
        {
          "transactionSetIdentifierCode": "214",
          "transactionSetControlNumber": "0001"
        }
      ],
      "beginningSegmentForTransportationCarrierShipmentStatusMessage": [
        {
          "referenceIdentification": "ODFS11112",
          "shipmentIdentificationNumber": "SH1234",
          "standardCarrierAlphaCode": "ODFC"
        }
      ],
      "LX_loop": [
        {
          "transactionSetLineNumber": [
            {
              "assignedNumber": "1"
            }
          ],
          "AT7_loop": [
            {
              "shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "D1",
                  "date": "20200902",
                  "time": "1400",
                  "timeCode": "LT"
                }
              ],
              "equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SAN JOSE",
                  "stateOrProvinceCode": "CA",
                  "countryCode": "USA"
                }
              ]
            }
          ]
        }
      ],
      "transactionSetTrailer": [
        {
          "numberOfIncludedSegments": "6",
          "transactionSetControlNumber": "0001"
        }
      ]
    }
  ]
}
}
ISA*00*          *00*          *ZZ*ODF_CARRIER    *ZZ*ODF_SHIPPER   *200901*1541*U*401*001234326*0*T*>~
GS*QM*ODF_CARRIER*ODF_SHIPPER*20200901*1541*1234326*X*004010~
ST*214*0001~
B10*ODFS11112*SH1234*ODFC~
LX*1~
AT7*X3*NS***20200901*1500*LT~
MS1*SEATTLE*WA*USA~
SE*6*0001~
GE*1*1234326~
IEA*1*001234326~
ISA*00*          *00*          *ZZ*ODF_CARRIER    *ZZ*ODF_SHIPPER   *200901*1701*U*401*001234327*0*T*>~
GS*QM*ODF_CARRIER*ODF_SHIPPER*20200901*1701*1234327*X*004010~
ST*214*0001~
B10*ODFS11112*SH1234*ODFC~
LX*1~
AT7*AF****20200901*1700*LT~
MS1*SEATTLE*WA*USA~
SE*6*0001~
GE*1*1234327~
IEA*1*001234327~
ISA*00*          *00*          *ZZ*ODF_CARRIER    *ZZ*ODF_SHIPPER   *200902*1207*U*401*001234328*0*T*>~
GS*QM*ODF_CARRIER*ODF_SHIPPER*20200902*1207*1234328*X*004010~
ST*214*0001~
B10*ODFS11112*SH1234*ODFC~
LX*1~
AT7*X1****20200902*1200*LT~
MS1*SAN JOSE*CA*USA~
SE*6*0001~
GE*1*1234328~
IEA*1*001234328~
ISA*00*          *00*          *ZZ*ODF_CARRIER    *ZZ*ODF_SHIPPER   *200902*1415*U*401*001234329*0*T*>~
GS*QM*ODF_CARRIER*ODF_SHIPPER*20200902*1415*1234329*X*004010~
ST*214*0001~
B10*ODFS11112*SH1234*ODFC~
LX*1~
AT7*D1****20200902*1400*LT~
MS1*SAN JOSE*CA*USA~
SE*6*0001~
GE*1*1234329~
IEA*1*001234329~

B10 Beginning

This is the header segment that describes the transaction.

"beginningSegmentForTransportationCarrierShipmentStatusMessage": [
        {
          "referenceIdentification": "ODFS11112",
          "shipmentIdentificationNumber": "SH1234",
          "standardCarrierAlphaCode": "ODFC"
        }
      ]
B10*ODFS11112*SH1234*ODFC~
JSON ElementX12 ElementValueDescription
referenceIdentificationB1001ODFS11112This is the carrier PRO number that identifies the shipment.
shipmentIdentificationNumberB1002SH1234This is the Shipment ID. This should be the same ID in the 990 Acceptance response.
standardCarrierAlphaCodeB1003SCACThis is the SCAC code.

LX Loop

This loop is used to reference line information in the transaction. Each line is controlled by the child transactionSetLineNumber.

"LX_loop": [
        {
          "transactionSetLineNumber": [
            {
              "assignedNumber": "1"
            }
          ],
          "AT7_loop": [
            {
              "shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "X3",
                  "shipmentStatusOrAppointmentReasonCode": "NS",
                  "date": "20200901",
                  "time": "1500",
                  "timeCode": "LT"
                }
              ],
              "equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SEATTLE",
                  "stateOrProvinceCode": "WA",
                  "countryCode": "USA"
                }
              ]
            }
          ]
        }
      ]
LX*1~
AT7*X3*NS***20200901*1500*LT~
MS1*SEATTLE*WA*USA~

LX Transaction Set Line Number

This segment controls the LX loop.

"transactionSetLineNumber": [
            {
              "assignedNumber": "1"
            }
          ]
LX*1~
JSON ElementX12 ElementValueDescription
assignedNumberLX011This is the assigned number. It's used to differentiate lines within the transaction.

AT7 Loop

This loop is used to specify the status of a shipment.

"AT7_loop": [
            {
              "shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "X3",
                  "shipmentStatusOrAppointmentReasonCode": "NS",
                  "date": "20200901",
                  "time": "1500",
                  "timeCode": "LT"
                }
              ],
              "equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SEATTLE",
                  "stateOrProvinceCode": "WA",
                  "countryCode": "USA"
                }
              ]
            }
          ]
AT7*X3*NS***20200901*1500*LT~
MS1*SEATTLE*WA*USA~

AT7 Shipment Status Details

This segment specifies the status of the shipment.

"shipmentStatusDetails": [
                {
                  "shipmentStatusIndicatorCode": "X3",
                  "shipmentStatusOrAppointmentReasonCode": "NS",
                  "date": "20200901",
                  "time": "1500",
                  "timeCode": "LT"
                }
              ]
AT7*X3*NS***20200901*1500*LT~
JSON ElementX12 ElementValueDescription
shipmentStatusIndicatorCodeAT701X3The code indicating the status of the shipment.

X3 - ODF Carrier arrived at the pick-up location
AF - ODF Carrier departed from the pick-up Location with the shipment loaded on the truck
X1 - ODF Carrier arrived at the delivery location with the shipment
D1 - ODF Carrier unloaded the shipment at the delivery location
shipmentStatusOrAppointmentReasonCodeAT702NSThe code indicating the reason a shipment status was transmitted.

NS - Normal status
dateAT70520200901Date of the transaction.
timeAT7061500Time of the transaction.
timeCodeAT707LTThe timezone.

LT - local time

MS1 Equipment Shipment Or Real Property Location

This segment contains the location of the shipment.

"equipmentShipmentOrRealPropertyLocation": [
                {
                  "cityName": "SEATTLE",
                  "stateOrProvinceCode": "WA",
                  "countryCode": "USA"
                }
              ]
MS1*SEATTLE*WA*USA~
JSON ElementX12 ElementValueDescription
cityNameMS101SEATTLEThe city name.
stateOrProvinceCodeMS102WAThe state or province.
countryCodeMS103USAThe postal code.