Type = API Reference,; Topic = Multienterprise Information Network Tower (MINT),;Persona = TraceLink Administrator, User,; Orchestration = Manufacturing, Logistics, Commerce,; Function = Supply Chain, IT, Procurement,

Carrier shipment statuses APIs

The Carrier Shipment Statuses facilitates the exchange of shipment status updates between a carrier (e.g., a trucking company or 3PL) and key stakeholders such as shippers, buyers, and other supply chain partners. Carrier Shipment Statuses ensures real-time visibility into the progress of a shipment as it moves through the supply chain, enabling stakeholders to monitor delivery schedules, address potential delays, and maintain high service levels.

By automating these updates, the process reduces manual intervention, speeds up communication, and minimizes errors. Shippers benefit from improved visibility and can proactively manage inventory, coordinate resources, and adjust operations based on visibility into the progress of a shipment.

Carrier Shipment Statuses (X12)

The Carrier Shipment Statuses (X12) message provides precise updates about logistics, supporting end-to-end supply chain transparency, and enhancing operational efficiency across industries.

Contact your TraceLink Services representative for more information about integrating with this message.

  • Message Type: MPC_CARRIER_SHIPMENT_STATUS
  • X12 Format: 214
  • Transform Names:
    • B2B_EDI_X12_214_CarrierShipmentStatus_IB_V1

    • B2B_EDI_X12_214_CarrierShipmentStatus_OB_V1

Input Element Occurs Length Description Example
ISA [1…1]
 - ISA interchange envelope. -
  ISA01 [1…1]
 2/2

Authorization information qualifier identifying the type of identifier in ISA02.

Valid values:

  • 00 – No authorization information in ISA02.
  • 01 – UCS communications.
  • 02– EDX.
  • 03 – Additional identifier.
  • 04 – Rail communication identifier.
  • 05 – Dept of Defense (DOD) identifier.
  • 06 – US Federal Government identifier.
  • 07 – Truck communications identifier.
  • 08 – Ocean communications identifier.

Typically this value = 00

 00
  ISA02 [1…1]
 10/10

Authorization identifier value used for additional identification or authorization of the interchange sender or the data in the interchange.

  • If ISA01 = 00, this will be populated by ten spaces.
  • If ISA01 ≠ 00, ISA02 must be populated with an identifier padded to 10 characters, if less than 10 characters.
 -
  ISA03 [1…1]
 1/2

Qualifier for security information in ISA04.

Valid values:

  • 00 - No security information present

  • 01 - Password

Typically this value = 00

 00
  ISA04 [1…1]
 10/10

Security information identifying for the interchange sender or data.

  • If ISA03 = 00, this will be populated by ten spaces.
  • If ISA03 ≠ 00, ISA04 must be populated with a password that is padded to 10 characters, if less than 10 characters.
 -
  ISA05 [1…1]
 1/2

Interchange sender partner ID qualifier.

Valid values:

  • 01 - DUNS

  • 07 - GLN

  • 08 - UCC EDI communications ID (GLN?)

  • 11 - DEA

  • 16 - DUNS+4

  • 20 - HIN

  • ZZ - Mutually defined

All X12 sender identifier type qualifiers in ISA05 are supported.

 07
  ISA06 [1…1]
 1/15 ISA interchange sender identifier. 7777776067344
  ISA07 [1…1]
 1/2

Interchange receiver partner ID qualifier.

Valid values:

  • 01 - DUNS

  • 07 - GLN

  • 08 - UCC EDI communications ID (GLN?)

  • 11 - DEA

  • 16- DUNS+4

  • 20 - HIN

  • ZZ - Mutually defined

All X12 receiver identifier type qualifiers in ISA07 are supported.

 01
  ISA08 [1…1]
 1/15 ISA interchange receiver ID. 888888404358877
  ISA09 [1…1]
 6/6 Interchange date in 6 char date format YYMMDD. 241215
  ISA10 [1…1]
 4/4 Interchange time in 4 char time format HHMM. 1420
  ISA11 [1…1]
 1/1

The value of this element is dependent on X12 version.

  • Version 4012 and earlier – Interchange control standards identifier. The valid value is U.
  • Version 004020 and later – Repetition separator, a delimiter that separates repeated occurrences of a data element or composite data structure, which must be different from the data element separator, component separator, and segment terminator.
 ^
  ISA12 [1…1]
 5/5 Interchange control version number. This could be any X12 version beginning with 004012 and later. Version 004010 and earlier are not supported by this instance of the 214. 00501
  ISA13 [1…1]
 1/9 ISA interchange control number. 0000000000619827
  ISA14 [1…1]
 1/1

Interchange level acknowledgment requested.

Valid values:

  • 0- No acknowledgment requested

  • 1 - Interchange level acknowledgment requested

 0
  ISA15 [1…1]
 1/1

Indicates whether the interchange is for production, test, or information purposes.

Valid values:

  • I - Information

  • P - Production data

  • T- Test data

 P
  ISA16 [1…1]
 1/1 Component element separator. Delimiter that separates data elements within a composite data structure. Must be different than the data element separator and segment terminator >
GS [1…*]
 - GS group functional envelope. Child of ISA. Only one GS group expected per interchange. -
  GS01 [1…1]
 2/2

GS group function code.

Valid value is QM - Transportation carrier shipment status message X12 214.

 QM
  GS02 [1…1]
 2/15 Application sender's code in the group envelope. 2222224043588
  GS03 [1…1]
 2/15 Application receiver's code in the group envelope. TRACELINK
  GS04 [1…1]
 8/8 Group envelope date value in date format YYYYMMDD. 20241215
  GS05 [1…1]
 4/8 Group envelope time value in time format HHMM or HHMMSS. 142000
  GS06 [1…1]
 1/9 Group control identifier. 619827
  GS07 [1…1]
 1/2

Responsible Agency Code.

Valid values:

  • T - Transportation Data Coordinating Committee (TDCC)

  • X - X12 Accredited Standards Committee

 X
  GS08 [1…1]
 1/12 X12 message version code. This could be any X12 version beginning wiith 004012. Version 004010 and earlier are not supported by this instance of the 214. 005010
ST [1…*]
 - ST transaction set envelope. Child of GS group. Only one ST transaction expected. -
  ST01 [1…1]
 3/3 Transaction set identifier code. 214
  ST02 [1…1]
 4/9 Transaction set ID number. Counter for each ST segment beginning with 1. 0001
  B10 [1…1]
 - Carrier Shipment Status beginning segment.  
    B1001 [0…1]
 1/80 Transaction reference identifier. 8524700258
    B1002 [0…1]
 1/30 Identification number assigned to the shipment by the shipper that uniquely identifies the shipment from origin to ultimate destination and is not subject to modification. This could be either a shipment or delivery document identifier. Required value. 50192345
    B1003 [1…1]
 2/4 Standard Carrier Alpha Code (SCAC). Required value. XY13
    B1008 [0…1]
 8/8 Message date in date format YYYYMMDD. 20241215
    B1009 [0…1]
 '4/8 Message time value in time format HHMM or HHMMSS. 123456
  MS3 [0…12]
 - MS3 segment to identify the interline carrier and relevant data -
    MS301 [1…1]
 2/4 Standard Carrier Alpha Code (SCAC). Required value. XY13
    MS302 [1…1]
 1/2

Carrier sequence code identifies a sequence of carriers in a shipment, beginning with the original carrier.

Valid values:

  • O - Original carrier

  • 1 - First carrier after original

  • 2 - Second carrier after original

  • 3 - Third carrier after original

  • 4 - Fourth carrier after original

  • 5 - Fifth carrier after original

 1
    MS303 [0…1]
 2/30 Free-form text for city name. Required if MS305 is populated. Sacramento
    MS304 [0…1]
 1/2

Code specifying the method or type of transportation for the shipment. Valid list of values can be referred from mentioned enum list.

Valid values:

  • J - Shipped by truck

  • R - Shipped by train

  • S - Shipped by sea

  • A - Shipped by air

  • LT - Less than truckload

  • 7 - Shipped by mail

 J
    MS305 [0…1]
 2/2 Code (Standard State/Province) as defined by appropriate government agency. CA
  LX [1…*]
 - Line item loop start for carrier shipment status, for referring a line number in a transaction set. -
    LX01 [1…1]
 1/6 Assigned number. May be a line item number or any other number that differentiates blocks of data within a transaction set. 0010
    L11 [0…999]
 - L11 segment to specify a reference identifier or instructions for a business relationship. -
      L1101 [0…1]
 1/80 Reference identifier as defined for a particular transaction set or as specified by the qualifier in L1102. L1101 is required, if L1103 is not present. If L1101 is present, L1102 is required. 45892345
      L1102 [0…1]
 2/3

Code qualifying the Reference Identification.

Valid values:

  • SI - Shipment

  • DO - Delivery

  • PO = Purchase Order

  • BM = Bill of Landing

If L1102 is present, L1101 is required.

 PO
      L1103 [0…1]
 1/80 A free-form description to clarify the related data elements and their content. L1103 is required, if L1101 is not populated. -
      L1104 [0…1]
 8/8 Date of reference identifier in date format YYYYMMDD. 20241215
      L1105 [0…1]
 1/1 Code indicating a Yes or No condition or response. N
    MAN [0…9999]
 - Marks or numbers that typically identify packaging in a shipment.  
      MAN01 [1…1]
 1/2 Code specifying the application or source of marks and numbers. Required if MAN segment is present. CP
      MAN02 [1…1]
 1/48 Marks and numbers used to identify a shipment or parts of a shipment. Required if MAN segment is present. ABCD34567
    Q7 [0…10]
 - Describes lading exception status information for the shipment.  
      Q701 [1…1]
 1/1

Code indicating the condition of the shipment.

Valid values:

  • 0 - Partial Short

  • A - All Short

  • D - Damaged

  • E - Shipment Refused

  • O - Overage

  • P - Partial Shipment

  • W - Wrong Product

 D
      Q702 [0…1]
 3/3

Code for packaging form of the lading quantity. Use enum list for references. Valid values:

  • BDL - Bundle

  • CNT - Container

  • CTN - Carton

  • DRM - Drum

  • PCS - Pieces

  • PKG - Package

  • PLT - Pallet

If Q702 is present, Q703 is required.

 TRU
      Q703 [0…1]
 1/7 Number of units (pieces) of the lading commodity. 100
    K1 [0…10]
 - K1 segment to transmit information in a free-form format for comment or special instruction. Not currently mapped. -
      K101 [1…1]
 1/30 Free form information or instruction. -
      K102 [0…1]
 1/80 Free form information or instruction. -
    AT5 [0…10]
 - AT5 segment for Bill of Lading Handling Requirements. Not currently mapped. -
      AT501 [0…1]
 2/3 Code specifying special transportation handling instructions. -
      AT502 [0…1]
 2/10 Code identifying the special service. -
      AT503 [0…1]
 2/30 Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. -
      AT504 [0…1]
 2/2 Code specifying the units in which a value is being expressed, or manner in which a measurement has been taken. -
      AT505 [0…1]
 1/4 Temperature 1. -
      AT506 [0…1]
 1/4 Temperature 2. -
    AT8 [0…10]
 - AT8 segment to specify shipment details in terms of weight, and quantity of handling units/packaging items. -
      AT801 [0…1]
 1/2

Code defining the type of weight.

Valid values :

  • Grossweight

  • Netweight

  • Billed

  • Tare

  • Excess

If either AT801, or AT802, or AT803 is present, then all three are required.

 G
      AT802 [0…1]
 1/1

Weight unit of measure for the weight type recorded.

Valid values:

  • K - Kilograms

  • L - Pounds

If either AT801, or AT802, or AT803 is present, then all three are required.

 L
      AT803 [0…1]
 1/10

Numeric value of weight of shipment.

If either AT801, or AT802, or AT803 is present, then all three are required.

 15
      AT804 [0…1]
 1/7 Number of units (pieces) of the lading commodity. 20
      AT805 [0…1]
 1/7 Number of units (pieces) of the lading commodity. 15
      AT806 [0…1]
 1/1

Code identifying the volume unit.

Valid values:

  • T - Container

  • C - Cubic centimeters

  • E - Cubic feet

  • N - Cubic inches

  • X - Cubic meters

  • G - Gallons

  • V - Liter

  • L- Total volume of load

If either AT806 or AT807 is present, both are required

 T
      AT807 [0…1]
 1/8

Value of volumetric measure.

If either AT806 or AT807 is present, both are required.

 123422
    AT7 [1…10]
 - AT7 segment to specify the status of a shipment, the reason for that status, the date & time of the status and the date & time of any appointments scheduled. -
      AT701 [0…1]
 2/2

Code indicating the status of a shipment.

Valid Values:

  • AH - Attempted Delivery

  • A9 - Shipment Damaged

  • AG - Estimated Delivery

  • B6 - Estimated to arrive for pickup

  • AF - Carrier Departed Pickup Location with Shipment

  • AI - Shipment has been Reconsigned

  • A7 - Refused by Consignee

  • A3 - Shipment Returned to Shipper

Only one of either AT701 or AT703 may be present, but not both.

 AH
      AT702 [0…1]
 2/2

Code indicating the reason a shipment status or appointment reason was transmitted.

Required if AT701 is present.

 A1
      AT703 [0…1]
 2/2

Code indicating the status of an appointment to pickup or deliver a shipment.

Only one of either AT701 or AT703 may be present, but not both.

 AA
      AT704 [0…1]
 2/2

Code indicating the reason a shipment status or appointment reason was transmitted.

Required if AT703 is present.

 AM
      AT705 [0…1]
 8/8 Date for shipment status detail in date format YYYYMMDD. 20241215
      AT706 [0…1]
 4/8 Time for shipment status detail in time format HHMM or HHMMSS or HHMMSSnn. 123456
      AT707 [0…1]
 2/2 ISO date type codes. Not mapped. -
  MS1 [0…1]
 - Specifies location of a piece of equipment, shipment, or real property in terms of city and state or longitude and latitude or postal code -
    MS101 [0…1]
 2/30

Free-form text for city name.

If MS101 is present, at least one of MS102 or MS103 is required.

 Sacramento
    MS102 [0…1]
 2/2

Code (Standard State/Province) as defined by appropriate government agency.

If MS102 is present, MS101 is required.

 CA
    MS103 [0…1]
 2/3

Code identifying the country.

If MS103 is present, MS101 is required.

 US
    MS104 [0…1]
 7/7

Code indicating the longitude in degrees (3 positions), minutes (2 positions), and seconds (2 positions).

If MS104 is present, MS105 is required.

 -
    MS105 [0…1]
 7/7

Code indicating the latitude in degrees (3 positions), minutes (2 positions), seconds (2 positions).

If MS105 is present, MS104 is required.

 -
    MS106 [0…1]
 1/1 Code identifying geographic direction. Not currently mapped. E
    MS107 [0…1]
 1/1 Code identifying geographic direction. Not currently mapped. -
    MS108 [0…1]
 3/15 Postal code excluding punctuation and blanks (zip code for the United States). Not currently mapped. -
  MS2 [0…2]
 - MS2 segment to specify the owner, the identification number assigned by that owner, and the type of equipment. -
    MS201 [0…1]
 2/4

Standard Carrier Alpha Code for Shipper.

If MS201 is present, MS202 is required.

 XY13
    MS202 [0…1]
 1/15

Sequencing or serial part of an equipment unit's identifying number (pure numeric form for equipment number is preferred).

If MS202 is present, MS201 is required.

 45874592
    MS203 [0…1]
 2/2

Code identifying type of equipment used for shipment.

Valid values:

  • CN - Container

  • RR - Railcar

  • TA - Trailer

  • VT - Ship

  • AP - Aircraft

 CN
    MS204 [0…1]
 1/1 Equipment number check digit for a piece of equipment. Not currently mapped. -
  K1 [0…10]
 - K1 segment to transmit information in a free-form format for comment or special instruction. Segment is not currently mapped. -
    K101 [1…1]
 1/30 Free form information or instruction. Not currently mapped. -
    K102 [0…1]
 1/30 Free form information or instruction. Not currently mapped. -
  M7 [0…1]
 - M7 segment to record seal numbers used and the organization that applied the seals. Segment is not currently mapped. -
    M701 [1…1]
 2/15 Unique number on seal used to close a shipment. Not currently mapped. -
    M702 [0…1]
 2/15 Unique number on seal used to close a shipment. Not currently mapped. -
    M703 [0…1]
 2/15 Unique number on seal used to close a shipment. Not currently mapped. -
    M704 [0…1]
 2/15 Unique number on seal used to close a shipment. Not currently mapped. -
    M705 [0…1]
 2/3 Code identifying an organizational entity, a physical location, property or an individual. Not currently mapped. -
    N1 [0…1]
 - Name segment loop for the ship from party information. If it is a pickup from warehouse, warehouse information to be mentioned. -
      N101 [1…1]
 2/3

Entity qualifier for the Customer or Buyer party identifier and address information. Currently support the following partner types:

  • SF – Ship from

  • SU – Supplier/Manufacturer

  • SH – Shipper Party

  • ST – Ship to party

  • CA – Carrier Party

  • CN – Consignee

  • CI – Consignor Party

  • FW – Freight Forwarder

  • BT – Bill to Party

 SF
      N102 [0…1]
 1/60 Name. Pharma customer
      N103 [0…1]
 1/2

Identifier code qualifier.

Valid values:

  • 1- DUNS

  • 2 - SCAC

  • 9 - DUNS+4

  • 11 - Drug Enforcement Agency registration number

  • 21 - Health Industry Number

  • 91 - Company identifier

  • 92 - Company location identifier

  • UL - Global Location Number

UL
      N104 [0…1]
 2/80 Buyer party identifier as qualified by N103 mapping to companyIdentifierValue. 3333331013655
  N3 [0…1]
 - N3: Address: Child of customer party N1 name segment. -
    N301 [1…1]
 1/55 Street address 1. 555 Neelan Road
    N302 [0…1]
 1/55 Street address 2. Suite 123
  N4 [0…1]
 - N4: Geographic Location. Child of customer party N1 name segment.  
    N401 [0…1]
 2/30 City name. Sacramento
    N402 [0…1]
 2/2 State or province code. Code (Standard state/province) as defined by appropriate government agency. CA
    N403 [0…1]
 3/15 Postal code. Code defining international postal zone code excluding punctuation and blanks. 95833
    N404 [0…1]
 2/3 Country code. US
    OID [0…999999]
 - OID segment is used to specify order information detail. -
      OID01 [0…1]
 1/80

Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier.

At least one of OID01 or OID02 is required. Both may be present.

 123456
      OID02 [0…1]
 1/22

Identifying number for Purchase Order assigned by the orderer or purchaser.

At least 1 of OID02 or OID01 is required. Both may be present.

 6789345
      OID03 [0…1]
 1/80

Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier. It is a number assigned by the consignee to further define the purchase order number.

If OID03 is present, OID02 is required.

 -
      OID04 [0…1]
 3/3

Code for packaging form of the lading quantity. Use enum list for references. Valid values:

  • BDL - Bundle

  • CNT - Container

  • CTN - Carton

  • DRM - Drum

  • PCS - Pieces

  • PKG - Package

  • PLT - Pallet

If OID04 is present, OID05 is required.

 PLT
      OID05 [0…1]
 1/15

Numeric value of quantity.

If OID05 is present, OID04 is required.

 50
      OID06 [0…1]
 1/1

Code defining the type of weight.

Valid values:

  • G - Grams

  • K - Kilograms

  • L - Pounds

  • O - Ounces

 E
      OID07 [0…1]
 1/10 Numeric value of weight. -
      OID08 [0…1]
 1/1

Code identifying the volume unit.

Valid values are:

  • T - Container

  • C - Cubic centimeters

  • E - Cubic feet

  • N - Cubic inches

  • X - Cubic meters

  • G - Gallons

  • V - Liter

  • L - Total volume of load

If OID08 is present, OID09 is required.

 T
      OID09 [0…1]
 1/8

Value of volumetric measure.

If OID09 is present, OID08 is required.

 -
      OID10 [0…1]
 1/3 Code indicating application error condition. 815
      OID11 [0…1]
 1/80 Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier. Not currently mapped. -
      OID12 [0…1]
 3/3

Code for packaging form of the lading quantity. Use enum list for references. Valid values:

  • BDL - Bundle

  • CNT - Container

  • CTN - Carton

  • DRM - Drum

  • PCS - Pieces

  • PKG - Package

  • PLT - Pallet

If OID12 is present, OID13 is required.

 RCK
      OID13 [0…1]
 1/15

Numeric value of quantity.

If OID13 is present, OID12 is required.

 50
SE [1…1]
 - ST … SE transaction set trailer envelope. Child of GS group. Only one ST transaction expected. -
  SE01 [1…1]
 1/10 Total count of segments in ST … SE transaction set including ST and SE segments. 10
  SE02 [1…1]
 4/9 Transaction set control number. 0001
GE [1…1]
 - GS … GE functional group trailer envelope. Child of ISA interchange. Only one GS group expected. -
  GE01 [1…1]
 1/6 Number of transaction sets in functional group. 5
  GE02 [1…1]
 1/9 Functional group control number. 619827
IEA [1…1]
 - ISA … IEA interchange control trailer envelope. Only one interchange expected per transmission. -
  IEA01 [1…1]
 1/5 Number of functional groups in interchange. 1
  IEA02 [1…1]
 9/9 Interchange control number. 0000000000619827
Copy 
ISA*00* *00* *16*SENDER1 *14*RECEIVER1
*071216*1406*U*00204*000000263*1*T*>
GS*IN*SENDER1*RECEIVER1*20071216*14062233*000000001*X*004010
ST*214*0006
B10*123456*23255*BAWC**RU*ROUTE1**20241011*10153344
MS3*BAWC*O*CITY*7*MA
LX*1
L11*55555555*DO**20240811*
MAN*GM*1546465
Q7*0*WRP*444
AT8*A*K*10***B*12
AT7***AA*A1*19970925*0830
MS1*Sacramento*CA*US*0914726*0431836*W*N
MS2*XY13*4455*CN
N1*SF*SF_BusinessName*1*3333331013655
N3*SF_Address1*SF_Address2
N4*SF_City*CA*SF_Postal*US
N1*SU*SU_BusinessName*2*3333331013655
N3*SU_Address1*SU_Address2
N4*SU_City*CA*SU_Postal*US
N1*SH*SH_BusinessName*9*3333331013655
N3*SH_Address1*SH_Address2
N4*SH_City*CA*SH_Postal*US
N1*ST*ST_BusinessName*11*3333331013655
N3*ST_Address1*ST_Address2
N4*ST_City*CA*ST_Postal*US
N1*CA*CA_BusinessName*21*3333331013655
N3*CA_Address1*CA_Address2
N4*CA_City*CA*CA_Postal*US
OID*01*6789345**BAG*125*E*10*B*111*B**BOX*55
SE*28*0006
GE*2*000000001
IEA*1*000000263

Tag end