Carrier Shipment Statuses APIs

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

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.

Qualifier for security information in ISA04.

Valid values:

• 00 - No security information present

• 01 - Password

Typically this value = 00

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.

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.

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.

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.

Interchange level acknowledgment requested.

Valid values:

• 0- No acknowledgment requested

• 1 - Interchange level acknowledgment requested

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

Valid values:

• I - Information

• P - Production data

• T- Test data

GS group function code.

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

Responsible Agency Code.

Valid values:

• T - Transportation Data Coordinating Committee (TDCC)

• X - X12 Accredited Standards Committee

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

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

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.

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

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.

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.

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.

Numeric value of weight of shipment.

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

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

Value of volumetric measure.

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

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.

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

Required if AT701 is present.

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.

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

Required if AT703 is present.

Free-form text for city name.

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

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

If MS102 is present, MS101 is required.

Code identifying the country.

If MS103 is present, MS101 is required.

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

If MS104 is present, MS105 is required.

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

If MS105 is present, MS104 is required.

Standard Carrier Alpha Code for Shipper.

If MS201 is present, MS202 is required.

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.

Code identifying type of equipment used for shipment.

Valid values:

• CN - Container

• RR - Railcar

• TA - Trailer

• VT - Ship

• AP - Aircraft

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

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

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.

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

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

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.

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.

Numeric value of quantity.

If OID05 is present, OID04 is required.

Code defining the type of weight.

Valid values:

• G - Grams

• K - Kilograms

• L - Pounds

• O - Ounces

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.

Value of volumetric measure.

If OID09 is present, OID08 is required.

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.

Numeric value of quantity.

If OID13 is present, OID12 is required.