Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,

Ocean shipment status canonical guidelines

Ocean Shipment Status is an electronic message used by ocean carriers to provide shipment updates on the movement and handling of ocean freight shipments. It delivers visibility into key events from the moment a container is loaded at the port of origin through transshipment to its arrival at the destination port. These updates function much like package tracking for ocean freight, keeping stakeholders informed throughout the shipment’s journey. An Ocean Shipment Status message can provide updates on container loading and vessel departures, port arrivals and transshipment movements, the status of customs clearance, notifications of delays with their reasons, and confirmation of delivery or hand off at the final port.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
Canonical Element – JSon object type/root element. – – –
  controlFileHeader – Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages. – – –
  canonicalOceanShipmentStatusHeader – Header details for the canonical ocean shipment status message canonical. – B4 –
    processingFunctionTypeCode string

Processing function, transaction set purpose code.

Valid values include:

  • CREATE

  • CHANGE

  • CANCEL

  • ORIGINAL

  • REPLACE

  • STATUS

 – -

BGM030 =

  • 8 (STATUS) or

  • 9 (ORIGINAL)
    transactionStatusCode string

Code indicating the status of a shipment.

Valid values include:

  • LOADEDONVESSEL - Loaded on vessel

  • PICKEDUP - Carrier Departed Pickup Location with Shipment

  • INGATE - In-Gate

  • LOADING - Loading

  • ARRIVEDCUSTOMS - Arrived at Customs

  • CUSTOMSPAPERWORKPROVIDED - Complete Customs Paperwork has been Provided

  • OUTGATE - Out gate

  • ARRIVEDATLOCATION - Arrived at Delivery Location

  • UNLOADING - Unloading

  • VESSELARRIVAL - Vessel scheduled to arrival or has arrived

  • VESSELDEPARTURE - Vessel scheduled to depart or has departed

 –

B403

–
    dateReported string Cargo's last status reported in string date format YYYY-MM-DD or YYYY-MM-DDTHH:MM.nnnZ. – B404 (Date) B405 (Time) –
    epochDateReported number Date and time if available shipment status reported in epoch date format. – – –
    inquiryRequestIdentifier string Enquirer status request identifier. – B402 –
    equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • TRAILER

  • AIRCRAFT

  • BARGE

– –

EQD010 =

  • CN (CONTAINER) Or

  • AK (AIRCRAFT) Or

  • BR (BARGE) Or

  • TE (TRAILER)
    statusLocation string To report shipment origin airport code in case of Air shipment or carrier terminal code in case of ground transportation. – B406 –
    equipmentPrefix string Prefix or alphabetic part of an equipment unit's identifying number. – B407 –
    equipmentIdentifier string Sequencing or serial part of an equipment unit's identifying number. – B408 EQD020-010 (EDIFACT do not have separate field for Prefix and check digit, this element will include equipmentPrefix and checkDigitIdentifier.)
    equipmentStatusCode string

Equipment status code - Carrier condition code.

Valid values include:

  • LOAD - Load

  • EMPTY - Empty

  • POOLAVAILABLE - Empty and Available at Pool

  • OUTOFSERVICE - Out of Service

 –

B409

EQD050

    equipmentTypeISOCode string

Represents a 4-character ISO 6346 equipment type code.

Examples:

  • 22G1 - 20' general purpose container

  • 45R1 - 40' refrigerated container

  • 42P3 - 40' platform flat rack

 – B410 EQD030-010 when EQD030-030 = 5 (ISO)
    oceanShipmentLocationCode string

Code indicating type of location code:

Valid values include:

  • CITY - City code

  • DOMESTICPORTS - Domestic U.S. ports (Schedule D)

  • INTERNATIONALPORTS -Foreign ports (Schedule K), and international

  • UNLOCODE - United Nations Location Code

 –

B412 =

  • CI (CITY) Or

  • D (DOMESTICPORTS) Or

  • K (INTERNATIONALPORTS) Or

  • UN (UNLOCODE)

–
    oceanShipmentLocationIdentifier string Code which identifies a specific location. – B411 –
    checkDigitIdentifier number Equipment check digit number, (Container check digit number). – B413 –
    carrierCode string Shipping carrier alpha code (SCAC). – N902 when N901 = SCA RFF02 when RFF01 = AAZ
    transactionReferenceIdentifierList array List of documents and transactions at the header level of the message. – N9 –
      b2bTransactionIdentifierType string

Transaction reference type for X12 segments L11 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:

  • OCEANSHIPMENTSTATUS (Required) - Transaction unique indentifier

  • CONTRACT - Contract number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • SHIPMENT - Shipper's identifier for the shipment

  • INVOICE - Seller invoice number

  • MASTERBOL - Master BOL

  • SEALNUMBER - Seal number

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDER - Consignees order number

  • PRICEQUOTEIDENTIFIER - Price quote number

–

Create an transactionIdentifier instance when OCEANSHIPMENTSTATUS N901 =

  • BM (BOL) Or

  • CT (CONTRACT) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • SI (SHIPMENT) Or

  • IV (INVOICE) Or

  • MB (MASTERBOL) Or

  • SN (SEALNUMBER) Or

  • AG (AGENTSHIPMENT) Or

  • CN (CARRIERREFERENCE) Or

RFF01 =

  • BM (BOL) Or

  • ON (PURCHASEORDER) Or

  • SN (SEALNUMBER) Or

  • CG (CONSIGNEEORDER)

      b2bTransactionIdentifierValue string Transaction reference identifier value. –

Inbound - if B402 present when b2bTransactionIdentifierType = OCEANSHIPMENTSTATUS else map current date time in YYYYMMDDTHHMMSSnnn format.

BGM020-010 when b2bTransactionIdentifierType = OCEANSHIPMENTSTATUS
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. –

B404 (Date) +B405 (Time) when b2bTransactionIdentifierType = OCEANSHIPMENTSTATUS

N904+N905 for remaining qualifiers in b2bTransactionIdentifierType

 DTM010-020 when DTM010-010 = 137 (Document Date)
      epochTransactionDate string Transaction reference date and time, if time available, in epoch date format. – – –
      lineItemNumber integer Transaction reference date and time in EPOCH date time format. – – –
    transactionReferenceInformation array

Reference information for identifiers that are not related to transaction documents.

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – N9 –
      transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • CUSTOM - Mutually defined reference number

  • OCEANCONTAINERIDENTIFIER -Ocean container number

  • TRANSACTIONTYPE - Transaction type

 –

N901 =

  • FN (FORWARDERREFERENCE) Or

  • ZZ (CUSTOM) Or

  • OC (OCEANCONTAINERIDENTIFIER) Or

  • 8X (TRANSACTIONTYPE)

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

  • SRN (CARRIERASSIGNEDSHIPPERIDENTIFIER) Or

  • SD (SALESDEPARTMENT)
      transactionReferenceIdentifier string Transaction reference identifier value. – N902 RFF010-020
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –
      transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – N904+N905 –
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
    mpcDates array Dates relevant for Ocean shipment status header. – – –
      dateType string

Date type at header level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

The valid value is:DOCUMENT.

 – –

DTM010-010 = 137 (DOCUMENT)

      dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. – – DTM010-020
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. – – –
      timeZone string Time zone for referenced dates. – – –
    vesselDetails   Vessel identifier information along with transportation details such as dates, quantity , weight and volume. – Q2 CNI-STS-TDT (max 1 iteration per transaction as per sample guidelines) hence can be mapped at header)
      carrierSequenceCode string

Code identifying sequence of carriers in shipment, beginning with the original carrier.

Valid values include:

  • ORIGINAL - Original carrier

  • PRECARRIAGE - Pre carriage transport

  • ONCARRIAGE - On carriage transport

 – –

TDT010 =

  • 20 (ORIGINAL) or

  • 10 (PRECARRIAGE) or

  • 30 (ONCARRIAGE)

      vesselIdentifier string Vessel Identifier – Q201 TDT030-020
      vesselCodeType string

Vessel code type

Valid values :

  • USBUREAU - U.S. Bureau of Census

  • SHIPSRADIO - Ship's Radio Call Signal

  • LLOYD - Lloyd's Register of Shipping

  • MUTUALLYDEFINED - Mutually defined number

 –

Q212 =

  • B (USBUREAU) Or

  • C (SHIPSRADIO) Or

  • L (LLOYD) Or

  • Z (MUTUALLYDEFINED)

 TDT080-030 = 11 (LLOYD)
      vesselName string Name of ship as documented in "Lloyd's Register of Ships". – Q213 TDT080-040
      countryCode string Ship/Vessel registered country code. – Q202 –
      peirDate string

Required Pier date.

Last acceptable date by which cargo must be delivered to the terminal to be loaded onto the scheduled vessel. Format YYYYMMDD.

 – Q203 –
      epochPeirDate integer Last acceptable date in epoch format. – – –
      departureDate string Vessel departure date from port in format YYYYMMDD – Q204 –
      epochDepartureDate integer Vessel departure date from port in epoch format. –   –
      unloadingDate string Shipment unloaded from vessel in format YYYYMMDD. – Q205 –
      epochUnloadingDate integer Shipment unloaded from vessel in epoch format. –   –
      voyageIdentifier string Voyage identifier on which the cargo travels. – Q209 TDT020
      ladingQuantity number Number of units (pieces) of the lading commodity – Q206 –
      weightType string

Type of weight recorded.

Valid values include:

  • FREIGHT - Freight weight

  • GROSSWEIGHT - Gross weight

  • MAXIMUMLADING - Maximum lading capacity

 –

Q208

–
      weightValue Number Weight Value. – Q207 –
      transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF

For general reference data that is not a transaction document identifier.

The valid values include SCA - EQ

 – Q210 when transactionReferenceType != SCA if not SCA –
      transactionReferenceIdentifier string Transaction reference identifier value. – Q211 when transactionReferenceType != SCA –
      carrierCode string Carrier SCAC code. – Q211 when transactionReferenceType = SCA –
      volumeType string

Type of volume recorded.

Valid values include:

  • BARGE - Volume of barge

  • CONTAINER - Volume of container

  • CUBICCENTIMETERS - Cubic centimeters

  • CUBICDECIMETERS - Cubic decimeters

 – Q215 –
      volumeValue Number Vessel volume for type – Q214 –
      weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton

  • GRAMS- Grams

  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

 – Q216 –
    oceanShipmentStatusDetails array Provision to provide shipment wise status details like What happened to the shipment. – SG segment –
      transactionStatusCode string

Code indicating the status of a shipment.

Valid values include:

  • AWAITINGCLEARANCE - Awaiting clearance

  • LOADEDONVESSEL - Loaded on vessel

  • SHIPMENTDAMAGED - Shipment delivered with damage noted by carrier or consignee

  • DELIVEREDSHORT - Shipment was delivered with missing piece or pieces

  • BADORDER - Shipment was in operative, equipment failed.

  • CUSTOMSHOLD - Customs hold

  • CARRIERCUSTOMSRELEASED - Carrier and customs released

  • HAZARDOUSMATERIALDOCUMENT - Awaiting for hazardous material document.

  • SHIPMENTINFORMATION - Awaiting for shipment information

 – SG01 –
      transactionStatusReasonCode string

Reason indicating why a shipment status code was transmitted.

Valid values included:

  • CONTAINERDELAY - Import Container Delay

  • INCORRECTADDRESS - Incorrect Address

  • CONSIGNEEREFUSED - Refused by consignee

  • DAMAGEDDELIVERYNOTCOMPLETED - Damaged - Delivery Not Completed

  • ONSTRIKE - Business On Strike

  • DRIVERRELATED - Driver related

  • CARRIEROTHER - Other Carrier-Related

  • HOLIDAY - Holiday - Closed

  • CUSTOMSRELEASE - Customs Release

  • CUTOFFTIMEPASSED - Past Cutoff Time

  • MISSINGDOCUMENTS - Missing Documents

  • BORDERCLEARANCE - Border Clearance

  • CARRIERDISPATCHERROR - Carrier Dispatch Error

  • WEATHERRELATED - Weather Related

 –

SG02 =

  • 052 (CONTAINERDELAY) Or

  • A03 (INCORRECTADDRESS) Or

  • A07 (CONSIGNEEREFUSED) Or

  • A10 (DAMAGEDDELIVERYNOTCOMPLETED) Or

  • A15 (ONSTRIKE) Or

  • A27 (DRIVERRELATED) Or

  • A33 (CARRIEROTHER) Or

  • A42 (HOLIDAY) Or

  • A65 (CUSTOMSRELEASE) Or

  • A95 (CUTOFFTIMEPASSED) Or

  • B14 (MISSINGDOCUMENTS) Or

  • B15 (BORDERCLEARANCE) Or

  • D01 (CARRIERDISPATCHERROR) Or

  • A43 (WEATHERRELATED)

–
      description string Status description. – – –
      billOfLadingDispositionCode string Code indicating the effective action taken on bill of lading, X12 pass though. – SG03 –
      shipmentStatusDateString string Shipment status date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – SG04 & SG05 –
      epochShipmentStatusDate integer Datetime stamp for shipment status in epoch date format. – – –
      timeZone string Time zone. – SG06 –
    supplierBusinessInformation – Ship from party location identifiers and address information. If it is pickup from warehouse, warehouse information. – – –
      businessName string Business name for partner or location. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City. – – –
        district string District. – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address. – – –
    shipperBusinessInformation – shipper party company identifiers and address information. – – –
      businessName string Business name for partner or location. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City – – –
        district string District – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    shipToLocationInformation – Ship to party or warehouse location company identifiers and address information. – – –
      businessName string Business name for partner or location. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City – – –
        district string District – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    carrierInformation array Carrier party company identifiers and address information. – – NAD01= "CA"
      businessName string Business name for partner or location. – – NAD030-010
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – –

NAD020-030

        companyIdentifierValue string Company identifier value for business partner – – NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value – – –
      address – Party address information – – –
        address1 string Main street address – – NAD050-010
        address2 string Supplemental street address – – NAD050-020
        city string City – – NAD060
        district string District – – –
        state string State or region code – – NAD070-010
        postalCode string Postal code – – NAD080
        country string Country code – – NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    consigneeBusinessInformation – Consignee party company identifiers and address information. – – –
      businessName string Business name for partner or location – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean – – –
        companyIdentifierType string Company identifier type for business partner. – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City – – –
        district string District – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    consignorBusinessInformation – Consignor party company identifiers and address information. – – –
      businessName string Business name for partner or location. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City – – –
        district string District – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    freightForwarderInformation – Party representing the carrier for arranging transportation or handling. – – –
      businessName string Business name for partner or location. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City – – –
        district string District – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    notifyPartyBusinessInformation – Company or Branch of a company for which all the status information of this Message is provided. – – NAD01= "C1"
      businessName string Business name for partner or location. – – NAD030-010
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string Company identifier type for business partner. – – NAD020-030
        companyIdentifierValue string Company identifier value for business partner. – – NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – NAD050-010
        address2 string Supplemental street address. – – NAD050-020
        city string City – – NAD060
        district string District – – –
        state string State or region code – – NAD070-010
        postalCode string Postal code – – NAD080
        country string Country code – – NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation –   – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – – –
        contactEmail string Contact email address – – –
    freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –
      textReferenceCode string Text reference or subject code. – – –
      textFunctionCode string Text function code. – – –
      language string Language of free text. – – –
      textFormatCode string Format code for free text. – – –
      freeFormText string Free test string. – – –
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. – – –
      name string Name of mapped field. – – –
      value string Value in named field. – – –
  canonicalOceanShipmentStatusDetails array Details for the canonical ocean shipment status message canonical. – R4 Loop CNI-Loop
    lineItemNumber string transaction set line number – – CNI010
    portOrTerminalDetails – Port or location details. – R4 CNI-LOC
      portOrTerminalFunctionCode string

Port or Terminal function codes.

Valid values include:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of Loading

  • PORTOFDISCHARGE - Port of Discharge

  • TRANSSHIPMENT - Transshipment Port

  • CONSOLIDATIONPOINT - Re-consolidation Point

  • DECONSOLIDATIONPOINT - De-Consolidation Point

  • FINALDESTINATION - Final Destination

 –

R401 =

  • O (ORIGIN) Or

  • L (PORTOFLOADING) Or

  • D (PORTOFDISCHARGE) Or

  • T (TRANSSHIPMENT) Or

  • B (CONSOLIDATIONPOINT) Or

  • C (DECONSOLIDATIONPOINT) Or

  • N (FINALDESTINATION)

LOC010
      oceanShipmentLocationCode string

Code indicating type of location code:

Valid values include:

  • CITY - City code DOMESTICPORTS = Domestic U.S. ports (Schedule D)

  • INTERNATIONALPORTS - Foreign ports (Schedule K), and international

  • UNLOCODE - United Nations Location Code

 –

R402 =

  • CI (CITY) Or

  • D (DOMESTICPORTS) Or

  • K (INTERNATIONALPORTS) Or

  • UN (UNLOCODE)

–
      oceanShipmentLocationIdentifier string Identifies the cargo's specific location. – R403 LOC020-010
      portName string Name of the port. – R404 LOC020-040
      countryCode string Country code. – R405

LOC030-010 (LOC030-020 = 162 (Country))
      terminalName string Terminal Name. – R406 –
      pierIdentifier string Identifying number of the pier. – R407 –
      state string State code. – R408 LOC040-010 (LOC040-020 = 169 (Country- sub entity))
    transactionReferenceIdentifierList array List of documents and transactions at the header level of the message. – – CNI- RFF
      b2bTransactionIdentifierType string

Transaction reference type for X12 segments L11 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

  • SHIPMENT - Shipper's identifier for the shipment

  • DELIVERY - Delivery order number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • INVOICE - Seller invoice number

  • MASTERBOL - Master BOL

  • SEALNUMBER - Seal number

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDERIDENTIFIER - Conginees order number

  • PRICEQUOTEIDENTIFIER - Price quote number

 – –

RFF010-010
      b2bTransactionIdentifierValue string Transaction reference identifier value. – – RFF010-020
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionDate string Transaction reference date and time, if time available, in epoch date format – – –
      lineItemNumber integer Transaction reference date and time in EPOCH date time format. – – –
    mpcDates array Dates relevant to shipments events at port – DTM –
      dateType string

Date type related to shipment events at port] in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

Valid values include:

  • ESTIMATED - Estimated

  • ACTUAL - Actual

  • ESTIMATEDDEPARTURE - Estimated Departure Date

  • ACTUALDEPARTURE - Actual Departure date

  • ESTIMATEDARRIVAL - Estimated Arrival date

  • ACTUALARRIVAL - Actual arrival date

  • CUSTOMSCLEARANCE - Customs Clearance date

  • VESSELLOADED - Loaded on vessel date

  • CUSTOMSENTRY - Customs entry date

  • PACKED - Date packed

–

DTM01 =

  • 139 (ESTIMATED) Or

  • 140 (ACTUAL) Or

  • 369 (ESTIMATEDDEPARTURE) Or

  • 370 (ACTUALDEPARTURE) Or

  • 371 (ESTIMATEDARRIVAL) Or

  • 372 (ACTUALARRIVAL) Or

  • 058 (CUSTOMSCLEARANCE) Or

  • 161 (VESSELLOADED) Or

  • 813 (CUSTOMSENTRY) Or

  • 510 (PACKED)

–
      dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. – DTM02 & DTM03 –
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. – – –
      timeZone string Time zone for referenced dates – DTM04 –
    consignementStatusDetails array Consignment wise shipment details, such as status, reference, location, vessel details. – – CNI-STS
      transactionStatusCategoryType string

Type of transaction status is being reported.

The valid value is TRANSPORT - Transport status.

 – – STS010-010 = 1 (TRANSPORT)
      transactionStatusCode string

Code indicating the status of a shipment.

Valid values include:

  • AWAITINGCLEARANCE - Awaiting clearance

  • LOADEDONVESSEL - Loaded on vessel

  • SHIPMENTDAMAGED - Shipment delivered with damage noted by carrier or consignee

  • DELIVEREDSHORT - Shipment was delivered with missing piece or pieces

  • BADORDER - Shipment was in operative, equipment failed.

  • CUSTOMSHOLD - Customs hold

  • CARRIERCUSTOMSRELEASED - Carrier and customs released

  • HAZARDOUSMATERIALDOCUMENT - Awaiting for hazardous material document.

  • SHIPMENTINFORMATION - Awaiting for shipment information

 – – STS020-010
      transactionStatusReasonCode string

Reason indicating why a shipment status code was transmitted.

valid values included:

  • CONTAINERDELAY - Import Container Delay

  • INCORRECTADDRESS - Incorrect Address

  • CONSIGNEEREFUSED - Refused by consignee

  • DAMAGEDDELIVERYNOTCOMPLETED - Damaged - Delivery Not Completed

  • ONSTRIKE - Business On Strike

  • DRIVERRELATED - Driver related

  • CARRIEROTHER - Other Carrier-Related

  • HOLIDAY - Holiday - Closed

  • CUSTOMSRELEASE - Customs Release

  • CUTOFFTIMEPASSED - Past Cutoff Time

  • MISSINGDOCUMENTS - Missing Documents

  • BORDERCLEARANCE - Border Clearance

  • CARRIERDISPATCHERROR - Carrier Dispatch Error

  • WEATHERRELATED - Weather Related

 – – STS030-010
      description string Status description. – – STS020-040
      transactionReferenceIdentifierList array List of documents and transactions at the header level of the message. – – CNI-STS-RFF
        b2bTransactionIdentifierType string

Transaction reference type for X12 segments L11 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

  • SHIPMENT - Shipper's identifier for the shipment

  • DELIVERY - Delivery order number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • INVOICE - Seller invoice number

  • MASTERBOL - Master BOL

  • SEALNUMBER - Seal number

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDERIDENTIFIER - Conginees order number

  • PRICEQUOTEIDENTIFIER - Price quote number

 – – RFF010-010
        b2bTransactionIdentifierValue string Transaction reference identifier value. – – RFF010-020
        transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
        epochTransactionDate string Transaction reference date and time, if time available, in epoch date format. – – –
        lineItemNumber integer Transaction reference date and time in EPOCH date time format. – – –
      mpcDates array Dates relevant for Ocean shipment status header. – – CNI-STS- DTM
        dateType string

Date type at header level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

The valid value is STATUSCHANGE - Status change date and/or time.

 – –

DTM010-010 = 334 (STATUSCHANGE)

        dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. – – DTM010-020
        epochDateValue integer Date defined by referenced date type generated in epoch integer date format. – – –
        timeZone string Time zone for referenced dates. – – –
      statusReportedLocationDetails – – – – CNI-STS-LOC
        portOrTerminalFunctionCode string

Port or Terminal function codes.

Valid values include:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of Loading

  • PORTOFDISCHARGE - Port of Discharge

  • TRANSSHIPMENT - Transshipment Port

  • CONSOLIDATIONPOINT - Re-consolidation Point

  • DECONSOLIDATIONPOINT - De-Consolidation Point

  • FINALDESTINATION - Final Destination

 – – LOC010
        oceanShipmentLocationIdentifier string Identifies the cargo's specific location, UN Location code. – – LOC020-010
        locationCodeListIdentifier – Agency codes and its referenced code list to interpret the carrier code correctly. – –  
          codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – LOC020-020
          agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – LOC020-030
        portName string Name of the port or location – – LOC020-040
        countryCode string Country code – – LOC030-010 (LOC030-020 = 162 (Country))
        terminalName string Terminal Name – –  
        state string State code – – LOC040-010 (LOC040-020 = 169 (Country- sub entity))
      transportStageLocationDetails array Transport details such as mode of transport, means of transport, its conveyance reference number and the identification of the means of transport. The segment may be pointed to by the TPL segment. – – CNI-STS-TDT Group 6
        carrierSequenceCode string

Code identifying sequence of carriers in shipment, beginning with the original carrier.

Valid values include:

  • ORIGINAL - Original carrier

  • FIRST - First carrier after original

  • SECOND - Second carrier after original

  • THIRD - Third carrier after original

  • FOURTH - Fourth carrier after original

  • FIFTH - Fifth carrier after original

 – –

TDT010 =

  • 3 (ATARRIVAL) or

  • 11 (ATBORDER) or

  • 12 (ATDEPARTURE) or

  • 13 (ATDESTINATION) or

  • 15 (FOURTH) or

  • 16 (FIFTH)

        voyageIdentifier string Unique reference given by the carrier to a certain journey or departure of a means of transport (generic term). (Some customers using this as Voyage identifier and some them as using this for unique reference number and voyage number sending in REF segment, hence both are accommodated) – – TDT020
        transportMeansType string Transport means type. – – TDT040-010
        description string Description for means of transport. – – TDT040-020
        transportMethod string

Transport method type.

Valid values include:

  • TRUCK - Truck

  • RAIL - Shipped by train

  • SEA - By sea

  • AIR - By air

  • LTL - Less than truckload

  • AIREXPRESS - Air express

  • CONTAINERSEA - Container by ship

 – – TDT030-010
        carrierCode string Shipping carrier alpha code (SCAC). – – TDT050-010
        carrierCodeIdentifier – Agency codes and its referenced code list to interpret the carrier code correctly. – – –
          codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – TDT050-020
          agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT050-030
        carrierName string Name of carrier. – – TDT050-040
        transportMeansIdentifier string Means of transport identifier given by code list agency, in this case Lloyd's number. – – TDT080-010
        transportMeansCodeIdentifier – Agency codes and its referenced code list to interpret the transport means code correctly. – – –
          codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – TDT080-020
          agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT080-030
        vesselName string Name of ship as documented in "Lloyd's Register of Ships". – – TDT080-040
        countryCode string Ship/Vessel registered country code - ISO 2 Alpha Country Codes. – – TDT080-050
        transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. – – TDT-RFF
          transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

The valid values include VOYAGEIDENTIFIER - voyage identifier, reference number assigned by the carrier or his agent to the voyage of the vessel.

 – – RFF010-010 = VON (VOYAGEIDENTIFIER)
          transactionReferenceIdentifier string Transaction reference identifier value. – – RFF010-020
          description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02) – – –
          transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
          epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
        cargoMovementPortDetails array Stage/ Sequence wise carrier assigned movement details. – – CNI-STS-TDT-LOC Loop - group7
          portOrTerminalDetails – – – – LOC
            portOrTerminalFunctionCode string

Port or Terminal function codes.

Valid values include:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of Loading

  • PORTOFDISCHARGE - Port of Discharge

  • TRANSSHIPMENT - Transshipment Port

  • CONSOLIDATIONPOINT - Re-consolidation Point

  • DECONSOLIDATIONPOINT - De-Consolidation Point

  • FINALDESTINATION - Final Destination

 – – LOC010
            oceanShipmentLocationIdentifier string Identifies the cargo's specific location, UN Location code. – – LOC020-010
            portName string Name of the port or location. – – LOC020-040
            countryCode string Country code. – – LOC030-010 (LOC030-020 = 162 (Country))
            terminalName string Terminal Name. – – –
            state string State code. – – LOC040-010 (LOC040-020 = 169 (Country- sub entity))
          mpcDates   array Dates relevant to location events, provision given to map to EDIFACT data. – – CNI-STS-TDT-LOC-DTM
            dateType string

Date type related to shipment events at port] in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

Valid values include:

  • ESTIMATEDDEPARTURE - Estimated Departure Date

  • ACTUALDEPARTURE - Actual Departure date

  • ESTIMATEDARRIVAL - Estimated Arrival date

  • ACTUALARRIVAL - Actual arrival date

 – – DTM010-010
            dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. – – DTM010-020
            epochDateValue integer Date defined by referenced date type generated in epoch integer date format – – –
            timeZone – – – – –
      equipmentDetails array Shipment equipment details – – CNI-STS-EQD loop
        equipmentPrefix string Prefix or alphabetic part of an equipment unit's identifying number. – –  
        equipmentIdentifier string Sequencing or serial part of an equipment unit's identifying number. – – EQD020-010
        carrierCode string Carrier code for shipper – –  
        equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

– –

EQD010 =

  • AK (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TE (TRAILER)
        equipmentSizeTypeCode string Equipment type ISO code. – – EQD030-010
        equipmentSizeCodeIdentifier – Agency codes and its referenced code list to interpret the transport means code correctly. – – –
          codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – EQD030-020
          agencyCode string Specifies the organization or agency code that maintains or governs the referenced code list. – – EQD030-030
        equipmentSupplier string

Equipment supplied party.

Valid values :

  • SHIPPER - Shipper supplied

  • CARRIER - Carrier supplied

  • CONSOLIDATOR - Consolidator supplied

  • DECONSOLIDATOR - De-consolidator supplied

  • THIRDPARTY - Third party supplied

  • FORWARDER - Forwarder supplied from a leasing company

  • FORWARDERRAILWAYS - Forwarder supplied from railways pool

 – –

EQD040 =

  • 1 (SHIPPER) Or

  • 2 (CARRIER) Or

  • 3 (CONSOLIDATOR) Or

  • 4 (DECONSOLIDATOR) Or

  • 5 (THIRDPARTY) Or

  • 6 (FORWARDER) Or

  • 7 (FORWARDERRAILWAYS)
        equipmentLoadIndicator string

Indicate the extent of equipment utilized for this consignment.

Valid values:

  • EMPTY - Equipment is empty

  • FULL - Equipment is full

  • MORETHANONEQUARTER - More than one quarter volume available

  • MORETHANHALF - More than half volume available

  • MORETHANTHREEQUARTER - More than three quarters volume available

  • NOVOLUME - No volume available

  • FULLMIXED - Full, mixed consignment

  • FULLSINGLE - Full, single consignment

 – –

EQD060 =

  • 4 (EMPTY) Or

  • 5 (FULL) Or

  • 1 (MORETHANONEQUARTER) Or

  • 2 (MORETHANHALF) Or

  • 3 (MORETHANTHREEQUARTER) Or

  • 6 (NOVOLUME) Or

  • 7 (FULLMIXED) Or

  • 8 (FULLSINGLE)
        checkDigitIdentifier number Equipment check digit number, (Container check digit number). – – –
        weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton

  • GRAMS - Grams

  • KILOGRAMS - Kilograms

  • POUNDSD - Pounds

  • OUNCESD - Ounces

 – – –
        weightType string

Type of weight recorded in shipment.

Valid values include:

  • GROSSWEIGHT - Gross weight

  • NETWEIGHT - Net Weight

  • SHIPPER - Shipper's weight

  • TARE - Tare weight

 – – –
        weightValue string Weight of product at delivery header level. – – –
        tareType string

Tare Qualifier Code

  • ACTUAL - Actual tare

  • MARKED - Marked tare

 – – –
        tareWeight number Tare weight of equipment – – –
        volumeType string

Type of volume recorded.

Valid values include:

  • BARGE - Volume of barge

  • CONTAINER - Volume of container

  • CUBICCENTIMETERS - Cubic centimeters

  • CUBICDECIMETERS - Cubic decimeters

 – – –
        volumeValue Number Vessel volume for type. – – –
        shipmentMeasurements array Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. – – segment MEA in EQD loop
          measurementType string

Code identifying a measurement type for a measurement value.

The valid values includes: MEASUREMENT - Measurement.

 – –

MEA010 = AAE (MEASUREMENT)

          measurementValue string The value of the measurement. – – MEA030-020
          unitOfMeasure string

Unit of measure for the measurement type and value recorded.

Valid values includes:

  • CUBICFEET - Cubic feet

  • KILOGRAM - Kilogram

  • POUND - Pounds

  • CUBICMETER - Cubic meters

  • PACKS - No of packs

 – –

MEA030-010 =

  • FTQ (CUBICFEET)

  • KGM (KILOGRAM) Or

  • LBR (POUND) Or

  • MTQ (CUBICMETER) Or

  • NMP (PACKS)
          measuredType string

Code identifying a measured type for a measured value.

Valid values include:

  • SHIPPEDQUANTITY - Shipped quantity

  • GROSSVOLUME - Gross volume

  • EQUIPMENTGROSSWEIGHT - Transport equipment gross weight

 – –

MEA020-010 =

  • SQ (SHIPPEDQUANTITY) Or

  • AAW (GROSSVOLUME) Or

  • AET (EQUIPMENTGROSSWEIGHT)
        transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. – – TDT-RFF
          transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

The valid values include VOYAGEIDENTIFIER - voyage identifier.

 – – RFF010-010 = VON (VOYAGEIDENTIFIER)
          transactionReferenceIdentifier string Transaction reference identifier value. – – RFF010-020
          description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –
          transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
          epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
    freeTextNote array Ship to party company identifiers and address information. – – FTX
      textReferenceCode string Text reference or subject code. – – FTX030-010
      textFunctionCode string Text function code. – – FTX020
      language string Language of free text – – FTX050
      textFormatCode string Format code for free text – – FTX060
      freeText string Free test string – – FTX040-010
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. – – –
      name string Name of mapped field. – – –
      value string Value in named field. – – –
  canonicalOceanShipmentEventDetails array To report events occurred during ocean, rail, air shipments. – V9 –
    shipmentEventType string

Code to specify type of the ocean shipment event.

Valid values include:

  • ANTICIPATEDPICKUP - Anticipated Pickup

  • VESSELARRIVAL - Vessel Arrival

  • VESSELDEPARTURE - Vessel Departure

  • UNLOADEDFROMVESSEL - Unloaded From Vessel

  • LOADEDONVESSEL- Actually Loaded on Vessel

  • FINALDESTINATIONACTUALARRIVALDATE - Actual Arrival Date at Final Destination

 –

V901 =

  • APU (Anticipated Pickup) Or

  • VAR (Vessel Arrival) Or

  • VDP (Vessel Departure) Or

  • UFV (Unloaded From Vessel) Or

  • ALV (Actually Loaded on Vessel) Or

  • ARD (Actual Arrival Date at Final Destination)

–
    eventName string Event descriptive information. – V902 –
    transportEventTimeStamp string Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – V903 & V904 –
    epochTransportEventTimeStamp integer Event date and time in epoch format. –   –
    timeZone string Time zone code. – V913 –
    city string Event city. – V905 –
    state string State code. – V906 –
    countryCode string Event Country code. – V907 –
    transactionStatusReasonCode string

Reason indicating why a shipment status code was transmitted,

Valid values included:

  • CONTAINERDELAYS - Import Container Delay

  • INCORRECTADDRESS - Incorrect Address

  • CONSIGNEEREFUSED - Refused by consignee

  • DAMAGEDDELIVERYNOTCOMPLETED - Damaged - Delivery Not Completed

  • ONSTRIKE - Business On Strike

  • DRIVERRELATED - Driver related

  • CARRIEROTHER - Other Carrier-Related

  • HOLIDAY - Holiday - Closed

  • CUSTOMSRELEASE - Customs Release

  • CUTOFFTIMEPASSED - Past Cutoff Time

  • MISSINGDOCUMENTS - Missing Documents

  • BORDERCLEARANCE - Border Clearance

  • CARRIERDISPATCHERROR - Carrier Dispatch Error

  • WEATHERRELATED = Weather Related

 –

V908 =

  • 052 (CONTAINERDELAY) Or

  • A03 (INCORRECTADDRESS) Or

  • A07 (CONSIGNEEREFUSED) Or

  • A10 (DAMAGEDDELIVERYNOTCOMPLETED) Or

  • A15 (ONSTRIKE) Or

  • A27 (DRIVERRELATED) Or

  • A33 (CARRIEROTHER) Or

  • A42 (HOLIDAY) Or

  • A65 (CUSTOMSRELEASE) Or

  • A95 (CUTOFFTIMEPASSED) Or

  • B14 (MISSINGDOCUMENTS) Or

  • B15 (BORDERCLEARANCE) Or

  • D01 (CARRIERDISPATCHERROR) Or

  • A43 (WEATHERRELATED)

–
    longitudeCoordinate string Longitude coordination. – – –
    latitudeCoordinate string Latitude coordination. – – –
    directionIndicator string Coordination direction. – – –
    equipmentTypeTemperatures   Equipment type and its required temperatures – – –
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

– – –
      temperatureType string

Type of temperature follow while shipment

Valid values:

  • STORAGE - Storage temperature

  • TRANSPORT - Transport temperature

  • CARGO - Cargo operation temperature

  • EMERGENCY - Transport emergency temperature

  • TRANSPORTCONTROL - Transport control temperature

  • TEMPERATURECORDED - Recorded temperature

 – – –
      transportEventTimeStamp string Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      temperatureSetpoint number Temperature value setting expressed in degrees. – – –
      temperatureScale string

Temperature unit of measure.

Valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 – – –
      rangeType string

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 – – –
      minTemperature number Equipment minimum allowable temperature. – – –
      maxTemperature number Equipment maximum allowable temperature. – – –
      ventSetting string

To specifying equipment vent adjustment code.

Valid values:

  • OPEN25PERCENT - Vent 25% Open

  • OPEN50PERCENT - Vent 50% Open

  • OPEN75PERCENT - Vent 75% Open

  • OPEN100PERCENT - Vent 100% Open

  • OPEN10PERCENT - Vent 10% Open

  • CLOSED - Vent should be in closed position.

  • CARRIERSET - Carrier to set based on commodity type.

 – – –
      description string Descriptive information about environment required in refrigerated container when other then normal air required. – – –
      humidityPercent number Percent in integer format , example: 50% required, in 50. – – –
      supplyTemperature number The temperature of the air coming into the container. – – –
      returnTemperature number The temperature of the air leaving the container. – – –
      co2Setpoint number The designated CO2 atmosphere level for transporting your cargo. – – –
      co2Reading number The CO2 atmosphere level. – – –
      o2Setpoint number The designated O2 atmosphere level for transporting your cargo. – – –
      o2Reading number The O2 atmosphere level. – – –
      relativeHumidity number The relative humidity. – – –
      humiditySetpoint number The designated humidity level for transporting your cargo. – – –
      pulpLocation1Temperature number One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. – – –
      pulpLocation2Temperature number One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. – – –
      pulpLocation3Temperature number One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. – – –
  customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. – – –
    name string Name of mapped field. – – –
    value string Value in named field. – – –

Tag end