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,

Shipping instruction canonical guidelines

The Shipping Instruction transaction is a structured electronic message used within the logistics and transportation industry to ensure that freight is shipped accurately, efficiently, and according to plan. It plays a vital role in enabling smooth coordination and communication across all supply chain partners. The Shipping Instruction is created and transmitted by shippers such as manufacturers, distributors, or third-party logistics providers (3PLs) and is received by carriers, freight forwarders, or other transportation partners responsible for physically moving goods to their destination.

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. - - -
  canonicalShippingInstructionHeader - Header details for the canonical shipping instruction message. - B2 -
    processingFunctionTypeCode string

Processing function, transaction set purpose code.

Valid values include:

  • CREATE

  • CHANGE

  • CANCEL

  • ORIGINAL

  • REPLACE

  • STATUS

  • CONFIRM

- B2A01 -
    servicesTariffCode string

Types of services rendered for this shipment and respective charges billed by the carrier.

Valid values include:

  • BARGETOBARGE - Rate for shipments for barge-to-barge carrier terminal service

  • BARGETODOOR - Rate for shipments for barge-to-door service

  • BARGETOMOTOR - Rate for shipments for barge-to-motorservice

  • BARGETORAIL - Rate for shipments for barge-to-rail service

 -

B201 =

  • BB (BARGETOBARGE) or

  • BD (BARGETODOOR) or

  • BM (BARGETOMOTOR) or

  • BR (BARGETORAIL)

 -
    carrierCode string Shipping carrier standard alpha code (SCAC). - B202 -
    locationIdentifier string Standard point location code (SPLC) used for rate making. - B203 -
    weightUnitType string

Type of weight recorded.

Valid values include:

  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

  • GRAMS - Grams

 -

B205 =

  • K (KILOGRAMS) or

  • G (GRAMS) or

  • E (METRICTON)

 -
    shipmentChargePaymentMethodType string

Method of payment for delivery.

Valid values include: -

  • ADVANCECOLLECT

  • ADVANCEPREPAID

  • BUYER

  • BUYERSELLERDEFINED

  • COLLECT

  • COLLECTDELIVERY

-

B206 =

  • CC (COLLECT) or

  • PA (ADVANCEPREPAID) or

  • PO (PREPAIDONLY) or

  • PP (PREPAIDSELLER) or

  • PS (SELLER) or

  • TP (THIRDPARTYPAY) or

  • CA (ADVANCECOLLECT) or

  • BP (BUYER) or

  • DF(BUYERSELLERDEFINED)

 -
    freightInvoiceShipmentType string

Code specifying relationship of this shipment with other shipments handed over to carrier at the same time, like split shipment.

Valid values include:

  • SEAWAYBILL - Sea Waybill

  • INTERMODALCOMBINEDBOL - Intermodal/Combined Transport Bill of Lading

  • FIRSTSPLITSHIPMENT - First Bill for Split Shipmen

  • SUBORDINATESPLITSHIPMENT - Subordinate Bill for a Split Shipment

  • SINGLESHIPMENT - Bill of Lading for Individual Shipment

  • CONSOLIDATEDSHIPMENT - Consolidated Shipment

  • MASTERBILLOFLADING - Master Bill of Lading with Multiple Delivery Locations

  • SUPPLEMENTALBILLING - Supplimental billing

  • ROUNDTRIPMOVEMENT - Round-trip Movement

  • VOIDBILL - Void bill

 - B207 -
    equipmentQuantity number Total number of equipments used in this transaction. - B208 -
    transportTradeTerms string

Describes the trade terms which apply to the shipment transportation responsibility. It also helps to describe the party responsible for making payment.

Valid values are:

  • COSTANDFREIGHT - Cost and Freight

  • COSTINSURANCEFREIGHT - Cost, Insurance, and Freight

  • DELIVEREDPLACE - Delivered At Place

  • DELIVEREDTERMINAL - Delivered At Terminal

 -

B211 =

  • CFR (COSTANDFREIGHT) or

  • CIF (COSTINSURANCEFREIGHT) or

  • DAP (DELIVEREDPLACE) or

  • DAT (DELIVEREDTERMINAL)

 -
    paymentMethod string

Method of payment.

Valid values include:

  • ACH

  • CASH

  • CREDIT

  • BANKCHECK

  • CHECK

  • DIRECTDEPOSIT

  • DRAFT

  • CUSTOM

-

B212 =

  • ACH (ACH) or

  • CAS (CASH) or

  • CCC (CREDIT) or

  • CCH (BANKCHECK) or

  • CHK (CHECK) or

  • DDP (DIRECTDEPOSIT) or

  • PBD (DRAFT) or

  • ZZZ (CUSTOM)

 -
    transactionReferenceIdentifierList array List of documents and transactions at the header level of the message. - N9 & B2 -
      b2bTransactionIdentifierType -

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

  • Valid values include:

  • SHIPPINGINSTRUCTION (Required) - Transaction unique identifier

  • SHIPMENT - Shipper's identifier for the shipment

  • CONTRACT - Contract number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • MASTERBOL - Master BOL

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDER - Consignees order number

 -

N901 =

  • BM (BOL) Or

  • CT (CONTRACT) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • SI (SHIPMENT) Or

  • MB (MASTERBOL) Or

  • AG (AGENTSHIPMENT) Or

  • CN (CARRIERREFERENCE) Or

 -
      b2bTransactionIdentifierValue string Transaction reference identifier value. - B204 when b2bTransactionIdentifierType =SHIPMENT & SHIPPINGINSTRUCTION N902 for remaining qualifiers in b2bTransactionIdentifierType -
      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. - ISA09&10 if empty N904+N905 for remaining qualifiers in b2bTransactionIdentifierType -
      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, L11 and N9 and EDIFACT RFF for information other than transaction documents. - N9 & M001 -
      transactionReferenceType string

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

Valid values include:

  • BOOKINGIDENTIFIER - Booking confirmation number

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

  • CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assigned shipment identifier.

  • PICKUPIDENTIFIER - Pickup reference number

  • LETTEROFCREDIT - Letter of credit number

 -

N901 =

  • BN (BOOKINGIDENTIFIER)

  • FN (FORWARDERREFERENCE) Or

  • OC (OCEANCONTAINERIDENTIFIER) Or

  • 8X (TRANSACTIONTYPE)

 -
      transactionReferenceIdentifier string Transaction reference identifier value. - N902 (for all other cases) M001 (transactionReferenceType = LETTEROFCREDIT) -
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - N903 -
      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 Shipping Instructions at header. - - -
      dateType string

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

Valid values:

  • ISSUE - Letter of credit issue date

  • EXPIRATION - Letter of credit expiration date

  • VESSELLOADED - Actual cargo loaded on vessel

  • DOCUMENT - Document date

 - DTM01 -
      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 for all other dateType.

M002 when dateType = ISSUE

M003 when dateType = EXPIRATION

M004 when dateType =VESSELLOADED

 -
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
      dateTimePeriodFormat string

Code specifying representation of date or time or format presented in date value,

Valid values include:

  • CCYYMMDD - Date format century year month day, 2 characters each.

  • CCYYMMDDHHMM - Date format century year month day hour minutes, 2 characters each.

 - - -
      timeZone string Time zone for referenced dates. - - -
    vesselDetails array Vessel identifier information. - V1 -
      vesselIdentifier string Vessel Identifier. - V101 -
      vesselCodeType string

Vessel code providing agency code.

Valid values :

  • USBUREAU - U.S. Bureau of Census

  • SHIPSRADIO - Ship's Radio Call Signal

  • LLOYD - Lloyd's Register of Shipping

  • MUTUALLYDEFINED - Mutually defined number

 -

V108 =

  • B (USBUREAU) Or

  • C (SHIPSRADIO) Or

  • L (LLOYD) Or

  • Z (MUTUALLYDEFINED)

 -
      vesselName string Name of ship as documented in "Lloyd's Register of Ships. - V102 -
      countryCode string Ship/Vessel registered country code. - V103 -
      voyageIdentifier string Voyage identifier on which the cargo travels. - V104 -
      carrierCode string Identifies Ocean Carrier SCAC code. - V105 -
      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

 - V109 -
    mpcCurrency array Currency for bill of landing. - segment CUR -
      currencyCode string Currency Code. - CUR02 -
      exchangeRateCurrencyCode string Exchange Rate Currency Code. - - -
      exchangeRate string Exchange Rate. - - -
      validityRate string Validity Date. - - -
      currencyEntityCode string Currency Entity Code. - CUR01 -
    partnerBusinessInformation array Business Parties identifiers and address information. - N1 -
      partnerEntityType string

Denotes type of the entity involved in this business transaction.

valid values include:

  • SUPPLIER - Supplier

  • BUYER - Buyer

  • MANUFACTURER - Manufacturer

  • CARRIER - Carrier

  • FREIGHTFORWARDER - Freight forwarder

 - N101 -
      businessName string Business name for partner or location. - N102 -
      additionalBusinessName string Additional Business name for partner or location. - N201 -
      companyLocationPartnerName string Additional Location of same Business partner. - - -
      mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
        companyIdentifierType string Company identifier type for business partner. - N103 -
        companyIdentifierValue string Company identifier value for business partner. - N104 -
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
      address - Party address information. - N3, N4, -
        address1 string Main street address. - N301 -
        address2 string Supplemental street address. - N302 -
        city string City - N401 -
        district string District - - -
        state string State or region code. - N402 -
        postalCode string Postal code. - N403 -
        country string Country code. - N404 -
        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 - - - N1-G61 -
        contactType string

Contact type.

Valid values include:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

  • CONFIRMEDWITH - Person whom the content of the PO has been discussed and agreed prior to sending this message.

  • EMERGENCYDANGEROUS - Emergency dangerous goods contact

  • SENDER - Message sender contact

  • RESPONSIBLE - Responsible person contact

 -

G6101 =

  • IC (INFORMATION) or

  • FW (FORWARDER) Or

  • RP (RESPONSIBLE)

 -
        contactName string Contact name. - G6102 -
        contactTitle string Title of contact. - - -
        contactPhone string Contact phone number. - G6104 where G6103 = "TE" -
        contactEmail string Contact email address. - G6104 where G6103 = "EM" -
      mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
        externalERPUserName string External ERP system user name for user who generated message. - - -
        organizationCode string Code for organization responsible for generating the message. - - -
        organizationDescription string Description of the organization responsible for generating the message. - - -
        groupCode string Code identifying group responsible for generating the message. - - -
        language string Language key for message. - - -
        languageCode string ISO language code for message - - -
        referenceIdentifier string Partner reference identifier. - - -
        orderType string Order Type. - - -
        address3 string Additional address information that is not included in addressTypeDefinition. - N202 -
        address4 string Additional address information that is not included in addressTypeDefinition. - - -
        postalArea string Postal Area. - - -
        timeZone string Time zone for referenced dates. - - -
        telephone string Telephone Number. - - -
        emailAddress string Email Address. - - -
        vatRegistrationNumber string Vat Registration Number. - - -
        taxExemptCode string Tax exempt Code. - - -
        locationType string Business Partner Location Type. - N405 -
        locationIdentifier string Business Partner location Identifier. - N406 -
        countrySubDivisionCode string Describes the country subdivision. - N407 -
    transportStageLocationDetails array Transport details such as mode of transport, means of transport, its conveyance reference number and the identification of the means of transport. - - -
      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

 - - -
      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) - - -
      transportMeansType string Transport means type. - - -
      description string Description for means of transport. - - -
      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

 - - -
      carrierCode string Shipping carrier alpha code (SCAC). - - -
      carrierName string Name of carrier. - - -
      transportMeansIdentifier string Means of transport identifier given by code list agency, in this case Lloyd's number. - - -
      vesselName string Name of ship as documented in "Lloyd's Register of Ships". - - -
      countryCode string Ship/Vessel registered country code - ISO 2 Alpha Country Codes. - - -
      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. - - -
        agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. - - -
      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. - - -
        agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. - - -
      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. - - -
        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

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

 - - -
        transactionReferenceIdentifier string Transaction reference identifier value. - - -
        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. - R4 Loop -
        portOrTerminalDetails - - - R4 -
          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)

 -
          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 -
          portName string Name of the port. - R404 -
          countryCode string Country code. - R405 -
          terminalName string Terminal Name. - R406 -
          pierIdentifier string Identifying number of the pier. - R407 -
          state string State code. - R408 -
          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. - - -
            agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. - - -
        mpcDates array Dates relevant to location events, provision given to map to EDIFACT data. - DTM -
          dateType string

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

Valid values include:

  • 369 - Estimated departure date

  • 371 - Estimated arrival date

 -

DTM01 =

  • 139 (ESTIMATED) Or

  • 140 (ACTUAL)

 -
          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. - - -
          dateTimePeriodFormat string

Code specifying representation of date or time or format presented in date value.

Valid values include:

  • CCYYMMDD - Date format century year month day, 2 characters each.

  • CCYYMMDDHHMM - Date format century year month day hour minutes, 2 characters each.

 - DTM04 -
          timeZone - - - - -
      carrierSequenceInformation array Carrier and routing sequence information for shipment. Records type of transport service provided during this shipment, city and state or province location for each carrier used for shipment. - R2 -
        carrierCode string Shipping carrier alpha code (SCAC) - R201 -
        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

 - R202 -
        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

 - R206 -
        city string Station or city name at which carriers interchange shipments - R203 -
        state string Name of state or province for the shipment's current carrier sequence. - - -
        transportServiceType string

Types of transport service requested and respective charges billed by the carrier.

Valid values include:

  • HOUSETOHOUSE = Rate for requested transport services from house to house

  • MIXEDDELIVERY = Rate for requested transport services for mixed delivery

  • DOORTODOOR = Rate for requested transport services from door to door

  • DOORTOAIRPORT = Rate for requested transport services from door to airport

 -

R212 =

  • HH (HOUSETOHOUSE) or

  • MD (MIXEDDELIVERY) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

 -
        description string Point to point routing description. - R213 -
    businessInstructionReferenceInformation array To specify instructions in this business relationship or a reference number. - L11 -
      transactionReferenceType string

Transaction reference type for X12 segments L11,

Valid values include CONTRACT - Service contract number.

 - L1102 = CT (CONTRACT) -
      transactionReferenceIdentifier string Transaction reference identifier value. - L1101 -
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier. - L1103 -
      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. - L1104 -
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    specialHandlingInformation array Special handling instructions for shipment. All parameters to be understood in the form of different codes used by industry, (typeDef created as part of X12 210). - Segment H3 -
      handlingCode string

Code specifying special transportation handling instructions.

Valid Values included:

  • CARRIER

  • DANGEROUS

  • DOMESTIC

  • EXPEDITE

  • CONTROLLEDATMOSPHERE - Transport under controlled atmosphere for perishable cargo

  • MODIFIEDATMOSPHERE - Modified atmosphere packaging/container for food cargo

 -

H301 =

  • EP (EXPEDITE) or

  • DM (DOMESTIC) or

  • DA (DANGEROUS) or

  • CH (CARRIER) Or

  • CTL (CONTROLLEDATMOSPHERE) Or

  • MAT (MODIFIEDATMOSPHERE)

 -
      description string Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. - H302 -
      protectiveServiceCode string To specify perishable protective service - rail carriers only. - H303 -
      ventInstructionCode string To specifying extra and careful instructions. - H304 -
      applicationTariffCode string

Code indicating to which traffic a tariff applies.

Valid values are:

  • INTERSTATE

  • INTRASTATE

  • REGIONAL

  • RECIPROCAL

  • INTERNATIONAL

-

H305 =

  • N (INTERSTATE) or

  • S (INTRASTATE) or

  • R (REGIONAL) or

  • I (INTERNATIONAL) or

  • D (RECIPROCAL)

 -
    termsOfPayment   Defines the commercial and delivery conditions of a shipment, specifying sales terms, Incoterms, and the named location to clarify cost, risk, and responsibility between buyer and seller. - M2 -
      salesTermsCode string

Specifies the commercial sales condition or payment basis (e.g., Letter of Credit, Open Account, Cash, Mutually Defined) under which the shipment is executed.

Valid values include:

  • CASH - Cash sale terms; settlement due in cash.

  • LETTEROFCREDIT - Sale under a Letter of Credit.

  • NOCHARGE - No charge terms (free of charge).

  • MUTUALLYDEFINED - Mutually defined by trading partners.

  • STOCKTRANSFER - Stock Transfer (non‑sale movement of stock between entities).

 -

M201 =

  • CH (CASH) Or

  • LC (LETTEROFCREDIT) Or

  • NC (NOCHARGE) Or

  • ZZ (MUTUALLYDEFINED) Or

  • ST (STOCKTRANSFER)

 -
      transportTradeTerms string

Describes the trade terms which apply to the shipment transportation responsibility. It also helps to describe the party responsible for making payment.

Valid values are:

  • COSTANDFREIGHT - Cost and Freight

  • COSTINSURANCEFREIGHT - Cost, Insurance, and Freight

  • DELIVEREDPLACE - Delivered At Place

  • DELIVEREDTERMINAL - Delivered At Terminal

 -

M204 =

  • CFR (COSTANDFREIGHT) or

  • CIF (COSTINSURANCEFREIGHT) or

  • DAP (DELIVEREDPLACE) or

  • DAT (DELIVEREDTERMINAL)

 -
      oceanShipmentLocationCode string

Type of Location code where the transportation. terms are ended:

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

 -

M207 =

  • CI (CITY) Or

  • D (DOMESTICPORTS) Or

  • K (INTERNATIONALPORTS) Or

  • UN (UNLOCODE)

 -
      oceanShipmentLocationIdentifier string Location code identifier where the transportation terms are ended. - M208 -
    termsOfPayment array Terms of payment looping group. - ITD -
      termsOfPaymentKey string Terms of payment. - - -
      termsOfPaymentTypeCode string

Code identifying type of payment terms.

Valid values:

  • BASIC

  • DEFERRED

  • DISCOUNTNOTAPPLICABLE

  • ENDOFMONTH

  • EXTENDED

  • FIXEDDATE

  • MIXED

  • PREVIOUSLYAGREED

  • PROXIMO

  • SELLER

-

ITD01 =

  • 01 (BASIC) or 04 (DEFERRED) or

  • 05 (DISCOUNTNOTAPPLICABLE) or

  • 02 (ENDOFMONTH) or

  • 07 (EXTENDED) or

  • 03 (FIXEDDATE) or

  • 06 (MIXED) or

  • 14 (PREVIOUSLYAGREED) or

  • 15 (PROXIMO) or

  • 13 (SELLER) or

 -
      termsOfPaymentDateBasis string

Code identifying the beginning of the terms period.

Valid values:

  • DELIVERYDATE - Delivery date

  • EFFECTIVEDATE - Effective date

  • INVOICEDATE - Invoice date

  • INVOICERECEIPTDATE - Invoice receipt date

  • PURCHASEORDERDATE - Purchase order date.

  • SHIPDATE - Shipping date

 -

ITD02 =

  • 1 (SHIPDATE) or

  • 2 (DELIVERYDATE) or

  • 3 (INVOICEDATE) or

  • 5 (INVOICERECEIPTDATE) or

  • 7 (EFFECTIVEDATE) or

  • 09 (PURCHASEORDERDATE) or

 -
      numberOfDays string Terms of payment: number of days. - ITD07 -
      discountDueNumberOfDays number Terms Discount Days Due. Number of days in the terms discount period by which payment is due if terms discount is earned. - ITD05 -
      termsOfPaymentPercent string Terms of payment: percentage. - ITD03 -
      invoicePayablePercent string Percentage of invoice payable. - ITD11 -
      discountDueDate string Discount due date in string date format YYYY-MM-DD. - ITD04 -
      epochDiscountDueDate integer Discount due date in epoch integer date format. - N/A -
      paymentDueDate string Due date for payment. - ITD06 -
      paymentDeferredToDate string Date deferred payment or percent of invoice payable is due. - ITD09 -
      epochPaymentDueDate integer Due date for payment generated in epoch integer date format. - - -
      epochPaymentDeferredToDate integer Date deferred payment or percent of invoice payable is due generated in epoch integer date format. - - -
      paymentDeferredDueAmount string Deferred amount due for payment. - ITD10 -
      description string Terms of payment description. - ITD12 -
      totalTermDiscountAmount integer Terms of payment discount amount. Total amount of terms discount. - - -
      dayOfMonth integer The numeric value of the day of the month between 1 and the maximum day of the month being referenced. - ITD13 -
    certificationsClause array Defines standardized certifications or contractual clauses associated with a shipment, capturing both the coded clause and its descriptive text for inclusion in transport documents like the Bill of Lading. - C8 -
      lineItemNumber string Transaction set line number. - C801 -
      certificationOrClauseCode string

Coded certification or condition applied.

Valid values include:

  • SHORTSHIPPED - Cargo Short‑Shipped

  • EMERGENCYSTATEMENT - Instructions for accident handling (spill, fire, DG).

  • IMOCERTIFICATION - Confirms cargo meets maritime safety rules.

  • CERTIFICATIONSTATEMENT - General compliance confirmation.

  • NOEXPORTDECLARATION - No Shipper’s Export Declaration Required

  • CUSTOM - Custom / Mutually Defined Clause

 -

C802 =

  • 08 (SHORTSHIPPED) Or

  • 29 (EMERGENCYSTATEMENT) Or

  • 30 (IMOCERTIFICATION) Or

  • 38 (CERTIFICATIONSTATEMENT) Or

  • 20 (NOEXPORTDECLARATION) Or

  • CC (CUSTOM)

 -
      description string Free‑form clause or descriptive text supporting the code. - C803 -
      certificationsClauseDescription array Stores additional free‑form continuation texts associated with a certification or contractual clause. - C8C -
        description string Clause free form text description. - C8C01 + C802 + C803 (Concatanate with +) -
      supplementaryInformation array Captures structured supplementary information qualifiers and text, such as printing instructions, export notes, or onward routing instructions. - SUP -
        supplementaryInformationType string

Identifies the type of supplementary information, such as supporting documents (invoice, certificate, packing list) or special instructions (routing, printing, validation).

Valid values include:

  • INCLUDE - Include Printing Instructions

  • EXPORTINSTRUCTIONS - Export Instructions

  • MATERIALSAFETYDATASHEET - Material Safety Data Sheet

  • SANITARYCERTIFICATE - Sanitary Certificate

 -

SUP01 =

  • IPI (INCLUDE) Or

  • EXP (EXPORTINSTRUCTIONS) Or

  • MSD (MATERIALSAFETYDATASHEET) Or

  • SAN (SANITARYCERTIFICATE)

 -
        description string Free‑form descriptive message of supplementary information. - SUP03 -
    exportLicense array Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates. - X1 -
      licenseNumber string License number assigned by authority. - X102 -
      licenseIssuingAgency string License number given authority or agency code. - X101 -
      licenseTypeCode string License control/type, code. - X106 -
      licenseCountry string Issuing country code. - X107 -
      IssueDate string License issued date. - - -
      epochIssueDate integer License issued date in epoch format. - - -
      expirationDate string License expiry date. - X104 -
      epochExpirationDate integer License expiry date in epoch format. - - -
      exportClassificationCode string Export classification code ECCN code. - X116 -
    importLicense array Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates. - X2 -
      licenseNumber string License number assigned by authority. - X201 -
      licenseIssuingAgency string License number given authority or agency code. - - -
      licenseTypeCode string License control/type, code. - - -
      licenseCountry string Issuing country code. - - -
      IssueDate string License issued date. - X202 -
      epochIssueDate integer License issued date in epoch format. -   -
      expirationDate string License expiry date. - X203 -
      epochExpirationDate integer License expiry date in epoch format. - - -
      exportClassificationCode string Export classification code ECCN code. - - -
    freeTextNote array Free form instructions. - K1 -
      textReferenceCode string Text reference or subject code. - K102 -
      textFunctionCode string Text function code. - - -
      language string Language of free text. - - -
      textFormatCode string Format code for free text. - - -
      freeFormText string Free test string. - K101 -
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalShippingInstructionItemDetails array Line item details for canonical shipping instructions message. - LX Loop (Mandatory) -
    lineItemNumber string Transaction set line number. - LX01 (Mandatory) -
    shippingInstructionContainerInformation array Container booking details consisting of container type, services, equipment specifications and its temperature details. - Segment Y2 -
      numberOfContainers number Number of shipping containers. - Y201 -
      containerType string Code indicating type of container equipment requested. - Y202 -
      transportServiceType string

Code specifying extent of transportation service requested.

Valid values include:

  • AIRPORTTOAIRPORT = Rate for requested transport services from airport to airport

  • BULKBREAK = Rate for requested transport services for bulk break

  • DOORTODOOR = Rate for requested transport services from door to door

  • DOORTOAIRPORT = Rate for requested transport services from door to airport

 -

Y203 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

 -
      equipmentTypeISOCode string Type of equipment used in delivery. Standard ISO code, pass through. - Y204 -
      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

 - Y205 -
      interModalServices string Identifying the Intermodal Service Plan. - Y206 -
      carrierCode string Carrier code for whom containers will be released. - Y207 -
      containerTermsIdentifier string Code indicating origin and destination of transportation and type of container. - Y208 -
      containerTermsType string Code indicating container terms reference. - Y209 -
      numberOfStopOffPoints number Total number of stop-offs specified for a shipment. - Y210 -
    equipmentSpecification array Instructions for shipping through ocean containers or any other equipment handling. N7 loop explains about. - N7 loop from LX loop -
      equipmentPrefix string Prefix or alphabetic part of an equipment unit's identifying number. - N701 -
      equipmentIdentifier string Sequencing or serial part of an equipment unit's identifying number. - N702 -
      weightValue string Weight of product at delivery header level. - N703 in all other cases. N705 where weightType = TARE -
      weightType string

Type of weight recorded in shipment.

Valid values include:

  • GROSSWEIGHT - Gross weight

  • NETWEIGHT - Net Weight

  • SHIPPER - Shipper's weight

  • TARE - Tare weight

 - N704 -
      tareWeight number Tare weight of equipment. - N705 -
      volumeValue number Vessel volume for type. - N708 -
      volumeType string

Type of volume recorded.

Valid values include:

  • BARGE - Volume of barge

  • CONTAINER - Volume of container

  • CUBICCENTIMETERS - Cubic centimeters

  • CUBICDECIMETERS - Cubic decimeters

 - N709 -
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

-

N711 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK)

 -
      carrierCode string Carrier code for shipper. - N712 -
      description string Equipment type free form text description. - - -
      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

 - - -
      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

 - - -
      tareType string

Tare Qualifier Code.

Valid values:

  • ACTUAL - Actual tare

  • MARKED - Marked tare

 -

N716 =

  • A (ACTUAL) Or

  • M (MARKED)

 -
      weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton
  • GRAMS - Grams
  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

-

N717 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

 -
      checkDigitIdentifier number Equipment check digit number, (Container check digit number) - N718 -
      transportServiceType string

Types of transport service requested which may differ from contract conditions.

Valid values include:

  • AIRPORTTOAIRPORT = Rate for requested transport services from airport to airport

  • BULKBREAK = Rate for requested transport services for bulk break

  • DOORTODOOR = Rate for requested transport services from door to door

  • DOORTOAIRPORT = Rate for requested transport services from door to airport

 -

N719 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

 -
      equimentTypeISOCode string Equipment type ISO code. - N722 -
      serviceTypeDescription string Free form description of movement or extended service carrying. - - -
      serviceProvidedParty string

Equipment haulage arrangements done by.

Valid values include:

  • CARRIER - Carrier

  • MERCHANT - Haulage arranged by merchant (shipper, consignee, or their agent).

 - - -
      equipmentDimensions array Dimensions of equipment / transportable unit - Segment N7 -
        dimensionType string

Type of dimensions recorded for cargo / transportable unit.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

  • OFFSTANDARDLEFT - The dimension in the width that the cargo exceeds the standard width at the left side of an equipment

  • OFFSTANDARDRIGHT - The dimension in the width that the cargo exceeds the standard width at the right side of an equipment

  • OFFSTANDARDBACK - The dimension in the length that the cargo exceeds the standard length at the back of an equipment

  • OFFSTANDARDFRONT - The dimension in the length that the cargo exceeds the standard length at the front of an equipment.

 - - -
        dimensionsValue number Volume for item in inches or centimeters. -

  • N715where dimensionsType = LENGTH

  • N720 where dimensionsType = HEIGHT

  • N721 where dimensionsType = WIDHT

 -
        unitOfMeasure string Dimension unit of measure for parent packaging. - - -
      itemQuantity array Equipment quantity. - Segment QTY under LX - N7 loop -
        quantityType string Type of quantity recorded. No sample data available. - QTY01 -
        quantityValue number Quantity of product in shipment. - QTY02 -
        unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit.

 - QTY03 -
      shipmentDimensions array Physical dimensions of shipments. - Segment L4 under LX - N7 loop -
        dimensionType string

Type of dimensions recorded for cargo / transportable unit.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

- - -
        dimensionsValue number Volume for item in inches or centimeters. -

  • L401 where dimensionsType = LENGTH

  • L403 where dimensionsType = HEIGHT

  • L402 where dimensionsType = WIDTH

 -
        unitOfMeasure string Dimension unit of measure for parent packaging. -

L404 =

  • E (FT) Or

  • X (MR) Or

  • C (CM) Or

  • N (IN)

 -
      equipmentSealNumbers array Shipment carrying equipments seal numbers. - Segment M7 under LX - N7 loop -
        sealNumber string Applied seal number for shipment carrying equipment. - M701 -
        sealAppliedEntityType string

Seal applied entity type code, it could be an organization or location or an individual.

valid values include:

  • CARRIER - Carrier applied seal number

  • SHIPPER - Shipper applied seal number

  • CUSTOMS - Customs department applied seal number

  • TERMINALOPERATOR - Terminal operator applied seal number

 -

M705 =

  • CA (CARRIER) Or

  • SH (SHIPPER) Or

  • CM (CUSTOMS) Or

  • T6 (TERMINALOPERATOR)

 -
      shipmentMeasurements array Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. - - -
        measurementType string

Code identifying a measurement type for a measurement value.

Valid values includes MEASUREMENT - Measurement.

 - - -
        measurementValue string The value of the measurement. - - -
        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

 - - -
        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

 - - -
      equipmentTypeTemperatures - Equipment type and its required temperatures - W09 under LX - N7 loop -
        equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

  • REEFERCONTAINER

-

W0901 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK) or

  • CZ (REEFERCONTAINER)

 -
        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

 - - -
        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

 -

W0903 =

  • CE (CELSIUS) Or

  • FA (FAHRENHEIT)

  • KV(KELVIN)

 -
        rangeType string

Type of range.

valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 - - -
        minTemperature number Equipment minimum allowable temperature. - W0902 -
        maxTemperature number Equipment maximum allowable temperature. - W0904 -
        unitOfMeasure string

Temperature unit of measure,

valid values includes:

  • CE - Degree Celsius

  • FA - Fahrenheit

 - - -
        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.

 -

W0907 =

  • A (OPEN25PERCENT) Or

  • B (OPEN50PERCENT) Or

  • C (OPEN75PERCENT) Or

  • D (OPEN100PERCENT) Or

  • F (OPEN10PERCENT) Or

  • E (CLOSED) Or

  • Z (CARRIERSET)

 -
        description string Descriptive information about environment required in refrigerated container when other then normal air required. - W906 -
        humidityPercent integer Percent in integer format , example: 50% required, in 50. - W908 -
      shippingEquipmentRateCharges array Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements. - Segment L1 under LX - N7 loop -
        lineItemNumber string Sequential line number for freight invoice item. - L101 -
        freightRatesChargesIdentifier string Identification of a charge by code and/or by name. Describes about freight and other charges, it can be combination of freight costs, type and charges description. -   -
        freightRate number Rate that applies to the specific commodity. - L102 -
        freightRateType string

Qualifiers to extend charges or interpret or calculate value.

Valid values are:

  • UNIT - Per Unit

  • CAR - Per Car

  • POUND - Per Pound

  • PERCENTAGE - Percentage

  • MILES - Per Miles

  • MINIMUM - Minimum Charge

  • FLAT - Flat rate

  • PERHUNDRED - Per Hundred (of Basic Unit )

 -

L103 =

  • PU (UNIT) or

  • PC (CAR) or

  • PW (PERCENTAGE) or

  • PM (MILES) or

  • MN (MINIMUM) or

  • PH (PERHUNDRED) or

  • FR (FLAT) or

  • LB (POUND)

 -
        totalCharges number Describes about freight or special charge or total charges -- expressed in the standard monetary denomination for specified currency. - L104 (implied 2 decimal points) -
        advancePayment number Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. - L105 (implied 2 decimal points) -
        prepaidAmount number Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency. - L106 (implied 2 decimal points) -
        rateCombinationPointCode string

The code denoting the connecting station for a joint rate obtained by combining two or more published rates which are used for the calculation of transportation charges.

Valid values are:

  • RAIL - Rail

  • AIR - Air

  • MOTOR - Motor

  • R260 - Association of American Railroads Accounting Rule 260

 - - -
        specialChargeCode string

Type of special charge or allowance allowed.

Valid values include:

  • DISCOUNT - Discount

  • SPECIALDISCOUNT - Special Discount

  • CUSTOMSENTRY - Customs Entry

  • CUSTOMSCHARGE - Customs Charge

 -

L108 =

  • DSC (DISCOUNT) or

  • 295 (SPECIALDISCOUNT) or

  • CSE (CUSTOMSENTRY) or

  • CUS (CUSTOMSCHARGE)

 -
        rateClassCode string

Identifies specific & designated class of goods; Note: For international air shipments, see IATA Resolution 600k.

Valid values are:

  • CONTRACT - Contract rate

  • EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate

  • MINIMUM - Minimum

  • QUOTED - Quoted rate

  • SENDER - Sender rate

  • CONTAINER - IATA Container or Unit Load Device (ULD)

  • EXCEPTION - Exception rating

-

L109 =

  • CTR (CONTRACT) or

  • E (EXCESSWEIGHT) or

  • M (MINIMUM) or

  • QUO (QUOTED) or

  • T (SENDER) or

  • X (CONTAINER) or

  • Y (EXCEPTION)

 -
        chargeEntitlementParty string

To describe the types of party involved.

Valid values:

  • SHIPPER

  • CONSIGNEE

  • ISSUINGCARRIER

  • DESTINATIONCARRIER

-

L110 =

  • S (SHIPPER) or

  • C (CONSIGNEE) or

  • I (ISSUINGCARRIER) or

  • D (DESTINATIONCARRIER)

 -
        chargePaymentMethod string

Payment method for freight invoice charges.

Valid values:

  • PREPAIDCASH

  • PREPAIDCREDIT

  • COLLECT

  • COLLECTCASH

  • COLLECTCREDIT

  • PREPAID

  • THIRDPARTYPAY

-

L111 =

  • A (PREPAIDCASH) or

  • B (PREPAIDCREDIT) or

  • C (COLLECTCASH) or

  • D (COLLECTCREDIT) or

  • E (COLLECT) or

  • P (PREPAID)

 -
        description string Identification of special charge; this data element is used whenever an applicable code cannot be found under rate handling code. - L112 -
        billedQuantityType string

Type of billed quantity recorded.

Valid values include:

  • KILOMETERS - Kilometers

  • MILES - Miles

  • DRIVERS - Identifies a billable unit expressed as persons operating equipment

  • EACH - Each

  • POUND - Pound

  • MILEAGE - Mileage

  • LOAD - Load

  • TRAINPREPAID - Train

  • CONTAINER - Container

  • UNIT - Unit

 -

L118 =

  • DK (KILOMETERS) or

  • DM (MILES) or

  • EA (EACH) or

  • DR (DRIVERS) or

  • LB (POUND) or

  • MR (MILEAGE) or

  • NL (LOAD) or

  • NN (TRAIN) or

  • NR (CONTAINER) or

  • NU (UNIT)

 -
        billedQuantityValue number Quantity of product in delivery. - L117 -
        freightRatePercent number Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%). - L119 -
        currencyCode string Billed Currency Code. - L120 -
        rateOrTariffClassDescription string Free form description of an applicable rate or tariff class. - N/A -
        freightInvoiceCurrency array Currency for bill of landing. - segment CUR -
          currencyCode string Currency Code. - CUR02 -
          exchangeRateCurrencyCode string Exchange Rate Currency Code. -   -
          exchangeRate string Exchange Rate. -   -
          validityRate string Validity Date. -   -
          currencyEntityCode string Currency Entity Code. - CUR01 -
      tariffReferenceInformation array Freight tariff reference details of the tariff used to arrive at applicable rates or charge - Segment L7 under LX - N7 loop -
        lineItemNumber string Sequential line number for freight invoice item. - L701 -
        tariffAgencyCode string It specified the tariff bureau or tariff publishing agent that governs the rates applied to this shipment. - L702 -
        tariffIdentifier string Standard tariff number for the tariff which governs the rates applied to the commodity item(s). - L703 -
        tariffSectionIdentifier string Number used as an extension of the basic tariff number to identify the rates published within specific sections of the tariff. - L704 -
        tariffItemIdentifier string Number assigned in the tariff to specific rate or group of rates that applies to one or more items in the shipment. - L705 -
        freightClassCode number Code indicating generalized classification that applies to one or more items in the shipment. - L707 -
      exportLicense array Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates. - Segment X1 under LX - N7 loop -
        licenseNumber string License number assigned by authority. - X102 -
        licenseIssuingAgency string License number given authority or agency code. - X101 -
        licenseTypeCode string License control/type, code. - X106 -
        licenseCountry string Issuing country code. - X107 -
        IssueDate string License issued date. -   -
        epochIssueDate integer License issued date in epoch format. -   -
        expirationDate string License expiry date. - X104 -
        epochExpirationDate integer License expiry date in epoch format. -   -
        exportClassificationCode string Export classification code ECCN code. - X116 -
      importLicense array Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates. - Segment X2 under LX - N7 loop -
        licenseNumber string License number assigned by authority. - X201 -
        licenseIssuingAgency string License number given authority or agency code. -   -
        licenseTypeCode string License control/type, code. -   -
        licenseCountry string Issuing country code. -   -
        IssueDate string License issued date. - X202 -
        epochIssueDate integer License issued date in epoch format. -   -
        expirationDate string License expiry date. - X203 -
        epochExpirationDate integer License expiry date in epoch format. -   -
        exportClassificationCode string Export classification code ECCN code. -   -
      transactionReferenceIdentifierList array List of documents and transactions for equipment specification at line item level of the message. - Segment N9 under LX - N7 loop -
        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:

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • MASTERBOL - Master BOL

 -

N901 =

  • BM (BOL) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • MB (MASTERBOL)

-
        b2bTransactionIdentifierValue string Transaction reference identifier value. - N902 for remaining qualifiers and respective enumerations in b2bTransactionIdentifierType -
        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. - N904+N905 for remaining qualifiers in b2bTransactionIdentifierType -
        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. - Segment N9 under LX - N7 loop -
        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:

  • BOOKINGIDENTIFIER - Booking confirmation number

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

  • CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assigned shipment identifier.

  • PICKUPIDENTIFIER - Pickup reference number

  • LETTEROFCREDIT - Letter of credit number

 -

N901 =

  • BN (BOOKINGIDENTIFIER)

  • FN (FORWARDERREFERENCE) Or

  • OC (OCEANCONTAINERIDENTIFIER) Or

  • 8X (TRANSACTIONTYPE)

 -
        transactionReferenceIdentifier string Transaction reference identifier value. - N902 (for all other cases) -
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - N903 -
        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. -   -
      dangerousGoodsInformation array Describes the details of the dangerous goods for shipment instructions. - Segment H1 & H2 under LX - N7 loop -
        shipmentDerivedRisk string It describes the risks involved while shipping dangerous goods. It can be more specific based on UN code. -   -
        shipmentDerivedSubRisk string It describes the sub-risks involved while shipping dangerous goods. It can be more specific based on UN code. -   -
        shipmentFlashPoint string Temperature value indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - H107 -
        isLimitedQuantity boolean

Check point, if the dangerous goods quantity is limited in the shipment.

Valid values:

  • True - 1 - Yes Limited

  • False - 0 - No

 -   -
        isMarinePollutant boolean

Check point, if the dangerous goods are pollutant into water.

Valid values:

  • True - 1 - Yes Pollutant

  • False - 0 - No

 -   -
        packagingGroup string Dangerous goods packaging group - H109 -
        designatedDangerousGoodsName string The UN proper shipping name derived from the mandatory UN code. If supplied, this value shall correspond to the proper shipping name stored for the provided UN code. - H104 -
        designatedTechnicalName string Designated technical name for carrier identity. -   -
        designatedTechnicalNationalName string Designated technical name for carrier and international identity. -   -
        minTemperatureValue number It describes from temperature. -   -
        maxTemperatureValue number It describes to temperature. -   -
        dangerousGoodsType string

There are different types of goods which are shipped globally. Multiple organizations has their own usage.

Widely used codes are:

  • ADR - European agreement on the international carriage of dangerous goods on road.

  • IMDG - According to "International Maritime Dangerous Goods Code".

  • IATADG - According to "International Air Transport Association (IATA) Dangerous Goods Regulations (DGR)"

  • ICAO - International civil aviation organization

  • UN - United nations code

 -

H103 =

  • I (IMDG) or

  • A (ADR) or

  • T (IATA)

 -
        dangerousGoodsIdentifier string Dangerous goods identifier. - H101 -
        additionalDangerousGoodsIdentifier string Additional Dangerous goods identifier. -   -
        dangerousGoodsClassCode string It specifies the kind of hazard can be generated by a material. - H102 -
        emergencyContactDetails string Phone number and name of person or department to contact in case of emergency. - H105 -
        dangerousGoodsPackagedQuantity number Packaged quantity of dangerous goods. - - -
        hazardousGoodsPackageType string

Package type containing these dangerous goods.

Possible values are:

  • BAG - Bag

  • BOX - Carton / Box

  • CONTAINER - Intermediate Bulk Container

  • COMPOSITE - Composite Packaging

  • GAUGE - Light Gauge Metal Packaging

  • BOTTLES - Bundle of Bottles

  • PRESSUREDRUM - Pressure Drum

  • STEELBOTTLE - Steel Bottle

  • DRUM - Drum

  • CAN - Jerry Can

 - - -
        netQuantityUnit string Net quantity unit of the dangerous goods - - -
        grossQuantityUnit string Gross quantity unit of the dangerous goods - - -
        isEmpty boolean

To check if package is empty.

Valid values:

  • True - 1 - Yes

  • False - 0 - No

 - - -
        hazardousMaterialIndex string The United Nations page number as required for the international transport of hazardous materials. - H106 -
        unitOfMeasure string Dimension unit of measure for parent packaging. - H108 -
        additionalDangerousGoodsDescription string Material name, special instructions, and phone number if any. - - -
        additionalDangerousGoodsClassification string Free-form description of hazardous material classification or division or label requirements. - - -
        temperatureScale string

Temperature unit of measure.

valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

 - - -
        additionalDangerousGoodsInformation array Additional Dangerous Goods information to be considered while specifying shipment instructions. - Segment H2 under LX - N7 - H1 loop -
          additionalDangerousGoodsDescription string Material name, special instructions, and phone number if any. - H201 -
          additionalDangerousGoodsClassification string Free-form description of hazardous material classification or division or label requirements. - H202 -
        dangerousGoodsItemQuantity array Dangerous Goods item quantity related information to identify quantity, UOM and value. - - -
          dangerousGoodsQuantityType string

Type of quantity recorded.

Valid value:

  • NET

  • GROSS

  • UNITS

- - -
          dangerousGoodsQuantityValue number Quantity of product at line item level. - - -
          dangerousGoodsQuantityUOM string Quantity unit of measure in master data for dangerous goods. - - -
      dangerousGoodsIdentifiers array It describes the hazardous commodity identification reference number and quantity. - Segment LH1 under LX - N7 loop -
        unitOfMeasure string Unit of measure for dangerous goods identification. - LH101 -
        ladingQuantity Number Number of units (pieces) of the lading commodity. - LH102 -
        hazardousMaterialIndex string The United Nations page number as required for the international transport of hazardous materials. - LH104 -
        hazardousGoodsCommodityCode string Code describing a commodity or group of commodities. - LH105 -
        dangerousGoodsQuantityValue number Quantity of product at line item level for dangerous goods. - LH107 -
        residueIndicatorType string

Types of residue indicator.

Valid values:

  • CONTAINMENT - Residue Last Contained Description (Small Means of Containment)

  • PACKAGES - Residue Last Contained Description (Packages)

  • RAILCAR - Residue Last Contained Description (Rail Car)

 -

LH109 =

  • G (CONTAINMENT) or

  • P (PACKAGES) or

  • R (RAILCAR)

 -
        packagingGroup string Dangerous goods packaging group in terms of Roman number I, II or III. - LH110 -
        dangerousMaterialRegulatoryIdentifier string Identifies the current regulatory version number used for hazardous materials shipments. - LH111 -
        dangerousGoodsEndorsementInformation array LH2 segment describes about hazardous material notation and endorsement. - Segment LH2 under LX - N7 - LH1 loop -
          dangerousGoodsClassCode string Dangerous goods identifier. - LH201 -
          dangerousGoodsClassification string

Describes the hazardous material class.

Valid Values :

  • PRIMARY - Primary Goods

  • SECONDARY - Secondary Goods

 -

LH202 =

  • P (PRIMARY) or

  • S (SECONDARY)

 -
          reportableSubstanceQuantityCode string To capture the presence of hazardous substance quantity code for quick action in case of emergency. - LH205 -
          unitOfMeasure string Unit of measure for dangerous goods identification. - LH206 -
          shipmentFlashPoint string Indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - LH207 -
          shipmentControlTemperature string Indicating the controlled temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - LH209 -
          shipmentEmergencyTemperature string Indicating the maximum emergency temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - LH211 -
          weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton
  • GRAMS - Grams
  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

-

LH212 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

 -
          explosiveWeight Number Net weight of the explosive quantity of the hazardous commodity. - LH213 -
        dangerousGoodsRegulatedIdentifiers array To uniquely identify the variable information required by government regulation covering the transportation of hazardous material shipments. - Segment LFH under LX - N7 - LH1 loop -
          hazardMaterialInformationType string

Type of shipment descriptor recorded.

Valid value:

  • AIRLIFT - Cargo airlift only

  • ISSUEINGAUTHORITY - Person certifying that the shipment complies with the regulations

  • WET - "Dangerous When Wet" Declaration

  • EMERGENCYSCHEDULE - Emergency Schedule (EMS) Page Number

  • INHALATION - Inhalation Hazard

  • LIMITEDQUANTITY - Limited Quantity Declaration

  • MFAG - Medical First Aid Guide (MFAG) Page Number

  • POLLUTANT - Marine Pollutant

  • POISION - Poison Declaration

  • RADIOACTIVE - Radioactive Material Data

  • CHEMICAL - Technical or Chemical Group Name

 -

LFH01 =

  • CAO (AIRLIFT) or

  • CER (ISSUEINGAUTHORITY) or

  • DWW (WET) or

  • EMS (EMERGENCYSCHEDULE) or

  • INH (INHALATION) or

  • LQY (LIMITEDQUANTITY) or

  • MFA (MFAG) or

  • MPI (POLLUTANT) or

  • POI (POISION) or

  • RAM(RADIOACTIVE) or

  • TEC (CHEMICAL)

 -
          description string Specific information required by law for hazardous material shipments. - LFH02 + LFH03 -
      iotDetailsInformation array Tracking devices which are placed inside the equipment to track shipment end to end. -   -
        iotIdendifier string The ID of a customer IoT device attached to this shipment. -   -
        iotType string The type/brand of the IoT device attached to this shipment. -   -
        iotService string The service of the IoT device attached to this shipment. -   -
        deviceName string Hardware modal name or serial. -   -
        iotDeviceOwner string Account or organization responsible for the device. -   -
        batteryPercent number Current battery life percentage. -   -
        isPowerButtonEnabled boolean Indicates whether the physical power button on the tracking device is active (true) or locked (false), controlling manual on/off capability. -   -
        isGpsEnabled boolean Indicates if GPS is active. -   -
        isWifiEnabled boolean Indicates if Wi‑Fi module is active. -   -
        measurementInterval number Time interval (minutes) between readings. -   -
        transmissionInterval number Time interval (minutes) between data sends. -   -
        estimatedBatteryLife number Estimated remaining battery life. -   -
        description string Free‑form information about this device. -   -
        alertsPresets array Captures predefined rule sets linked to an IoT device that monitor specific shipment or equipment conditions and trigger alerts when threshold criteria are met. -   -
          alertPresetIdentifier string Unique identifier for the predefined alert configuration associated with the tracking device. -   -
          alertPresetName string Business‑friendly name describing the alert preset profile (e.g., “Temperature High,” “Battery Low”). -   -
          alertCondition string Logical condition or threshold that triggers the alert (e.g., temperature above limit, route deviation). -   -
          description string Free‑form description explaining the alert’s purpose or intended monitoring behavior. -   -
      freeTextNote array Free text information. -   -
        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. -   -
        freeText 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. Line item level. -   -
        name string Name of mapped field. -   -
        value string Value in named field. -   -
    shippingInstructionItemDetails array To specify quantity, weight, volume, and type of service for a line item including applicable "quantity/rate-as" data. - LX- L0 loop -
      ladingItemMeasurementServiceDetails   Item details to specify quantity, weight, volume, and type of service for a line item including applicable quantities. - Segment: L0 -
        lineItemNumber string Sequential line number for freight invoice item. - L001 -
        billedQuantityValue string Numeric value representing the quantity or amount on which the rate or item pricing is based, corresponding to the specified pricing basis type. - L002 -
        billedQuantityType string

Code indicating the type of quantity or value used as the basis for calculating the rate or item pricing (e.g., weight, volume, miles, or value).

valid values include:

  • BARRELS - Barrels

  • BOX - Box

  • EACH - Identifies a billable unit as a single item.

  • POUND - Common weight unit in ocean freight billing.

  • KILOGRAM - Metric weight unit used in international shipping.

  • LITER - Liter

 -

L003 =

  • BA (BARRELS) Or

  • BX (BOX) Or

  • EA (EACH) Or

  • LB (POUND) Or

  • KG (KILOGRAM) Or

  • LR (LITER)

 -
        weightValue number Weight of product at PO line item. - L004 -
        weightType string

Type of weight recorded.

Valid values include:

  • GROSSWEIGHT

  • NETWEIGHT

 - L005 -
        volumeValue number Volume for item. - L006 -
        volumeType string

Type of weight recorded.

Valid values include:

  • CUBICFEET - Cubic feet

  • CUBICMETERS - Cubic meters

 - L007 -
        ladingQuantity number Number of handling units of the line item tendered to carrier. - L008 -
        packagingFormatCode string

Packing form of lading quantity.

Valid values include:

  • CONTAINER - Containers

  • BARREL - Barrels

 - L009 -
        description string Material used to protect lading. - L010 -
        weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton
  • GRAMS - Grams
  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

-

L011 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

 -
        transportServiceType string

Types of transport service requested and respective charges billed by the carrier.

Valid values include:

  • AIRPORTTOAIRPORT - Rate for requested transport services from airport to airport

  • BULKBREAK - Rate for requested transport services for bulk break

  • DOORTODOOR - Rate for requested transport services from door to door

  • DOORTOAIRPORT - Rate for requested transport services from door to airport

 -

L012 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

 -
        packageVerificationQuantity number Total number of boxes, cartons, or pieces contained on a pallet, skid, or slip sheet for the line item. - L013 -
        packageVerificationFormatCode string

Packing form of counting required quantity.

Valid values include:

  • BOX - Boxes

  • CARTON - Cartons

  • PIECES - Pieces

 - L014 -
        isVerificationRequired boolean

Describes whether the carrier will be required to verify the number of units contained on a pallet, slip sheet or skid.

Valid values include:

  • True - Yes

  • False - No

 - L015 = Y (TRUE) or N (FALSE) -
      itemQuantity array Equipment quantity. - Segment QTY under LX - L0 loop -
        quantityType string Type of quantity recorded. Valid values: No sample data available. - QTY01 -
        quantityValue number Quantity of product in shipment. - QTY02 -
        unitOfMeasure string Unit or Basis for Measurement Code. Unit of entry UOM's include: UN - Unit. - QTY03 -
      shipmentDimensions array Dimensions of shipment. - - -
        dimensionsType string

Type of dimensions recorded for freight.

Valid values include:

  • LENGTH - Largest horizontal dimension of an object measured when the object is in the upright position

  • WIDTH - Shorter measurement of the two horizontal dimensions measured with the object in the upright position

  • HEIGHT - Vertical dimension of an object measured when the object is in the upright position

 - - -
        dimensionsValue number Volume for item in inches. -

  • L401 where dimensionsType = LENGTH

  • L403 where dimensionsType = HEIGHT

  • L402 where dimensionsType = WIDTH

 -
        unitOfMeasure string Dimension unit of measure for parent packaging. - L404 = E (FT) Or X (MR) Or C (CM) Or N (IN) -
      ladingItemDetails array Lading line item in terms of description, packaging, and marks and numbers. - Segment L5 under LX - L0 loop -
        lineItemNumber number Sequential line number for a lading item. - L501 -
        description string Description of an item as required for rating and billing purposes. - L502 -
        commodityCode string Describes about a commodity or group of commodities. - L503 -
        commoditySystemType string

Describes the commodity coding system used for Commodity Code.

Valid values included:

  • DUNS - Dun's SIC 2+2, Dun & Bradstreet

  • NDC - National Drug Code

  • FREIGHT - Canadian Freight

  • QUOTA - Quota Category

  • TRADE - Standard International Trade Classification

  • TRANSPORTATION - Standard Transportation Commodity Code

  • MUTUALLYDEFINED - Mutually defined

  • EXPORTED - Exported merchandise

 -

L504=

  • 2 (DUNS) or

  • 5 (NDC) or

  • C (FREIGHT) or

  • N (MOTORFREIGHT) or

  • P (BULK) or

  • Q (QUOTA) or

  • S (TRADE) or

  • T (TRANSPORTATION) or

  • Z (MUTUALLYDEFINED) or

  • J (EXPORTED)

 -
        packagingFormatMaterialType string

Code identifying type of material used.

Valid values included :

  • ALUMINUM - Aluminum.

  • GLASS - Glass

  • PLASTIC - Plastic.

  • PLASTICINJECTION - A plastic formed injection

 -

L505 =

  • 01 (ALUMINUM) Or

  • 43 (GLASS) Or

  • 79 (PLASTIC) Or

  • 78 (PLASTICINJECTION)

 -
        packagingIdentifierType string Packaging identifier type. Pass thru mapping for X12. - L507 -
        packagingIdentifier string Packaging identifier value defined by the packaging type. - L506 -
      alternateLadingItemDetails array Captures supplementary or alternate cargo descriptions at the lading‑item level for export, customs, or compliance documentation. - Segment L12 under LX - L0 loop -
        ladingDescriptionType string

Code identifying the kind of alternate description (e.g., export, commercial, packing).

Valid values:

  • BOL - Bill of Lading Description

  • CHEMICAL - Chemical Description

  • TRANSPORT - Department of Transportation Description

  • EXPORTLICENSE - Export License Description

  • INVOICE - Commercial Invoice Description

  • LETTEROFCREDIT - Letter of Credit Description

  • PRODUCT - Product Description

 -

L1201 =

  • B (BOL) or

  • C (CHEMICAL) or

  • D (TRANSPORT) or

  • E (EXPORTLICENSE) or

  • I (INVOICE) or

  • L (LETTEROFCREDIT) or

  • P (PRODUCT)

 -
        description string A free-form description to clarify the related data elements and their content. - L1202 -
      transactionReferenceIdentifierList array List of documents and transactions for equipment specification at line item level of the message. - Segment N9 under LX - L0 loop -
        b2bTransactionIdentifierType string

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

Valid values include:

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • MASTERBOL - Master BOL

 -

N901 =

  • BM (BOL) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • MB (MASTERBOL)

-
        b2bTransactionIdentifierValue string Transaction reference identifier value defined by enum in transactionReferenceType defined by transaction reference type. - N902 for remaining qualifiers and respective enums in b2bTransactionIdentifierType -
        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. - N904+N905 for remaining qualifiers in b2bTransactionIdentifierType -
        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, L11 and N9 and EDIFACT RFF for information other than transaction documents. - Segment N9 under LX - L0 loop -
        transactionReferenceType string

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

Valid values include:

  • BOOKINGIDENTIFIER - Booking confirmation number

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

  • CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assigned shipment identifier.

  • PICKUPIDENTIFIER - Pickup reference number

  • LETTEROFCREDIT - Letter of credit number

 -

N901 =

BN (BOOKINGIDENTIFIER)

FN (FORWARDERREFERENCE) Or

OC (OCEANCONTAINERIDENTIFIER) Or

8X (TRANSACTIONTYPE)

-
        transactionReferenceIdentifier string Transaction reference identifier value. - N902 (for all other cases) -
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02) - N903 -
        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. - - -
      exportLicense array Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates. - Segment X1 under LX - L0 loop -
        licenseNumber string License number assigned by authority. - X102 -
        licenseIssuingAgency string License number given authority or agency code. - X101 -
        licenseTypeCode string License control/type, code. - X106 -
        licenseCountry string Issuing country code. - X107 -
        IssueDate string License issued date. - - -
        epochIssueDate integer License issued date in epoch format. - - -
        expirationDate string License expiry date. - X104 -
        epochExpirationDate integer License expiry date in epoch format. - - -
        exportClassificationCode string Export classification code ECCN code. - X116 -
      importLicense array Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates. - Segment X2 under LX - L0 loop -
        licenseNumber string License number assigned by authority. - X201 -
        licenseIssuingAgency string License number given authority or agency code. - - -
        licenseTypeCode string License control/type, code. - - -
        licenseCountry string Issuing country code. - - -
        IssueDate string License issued date. - X202 -
        epochIssueDate integer License issued date in epoch format. - - -
        expirationDate string License expiry date. - X203 -
        epochExpirationDate integer License expiry date in epoch format. - - -
        exportClassificationCode string Export classification code ECCN code. - - -
      certificationClause array Defines standardized certifications or contractual clauses associated with a shipment, capturing both the coded clause and its descriptive text for inclusion in transport documents like the Bill of Lading. - Segment C8 under LX - L0 loop -
        lineItemNumber string Transaction set line number. - - -
        certificationOrClauseCode string

Coded certification or condition applied.

Valid values include:

  • SHORTSHIPPED - Cargo Short‑Shipped

  • EMERGENCYSTATEMENT - Instructions for accident handling (spill, fire, DG).

  • IMOCERTIFICATION - Confirms cargo meets maritime safety rules.

  • CERTIFICATIONSTATEMENT - General compliance confirmation.

  • NOEXPORTDECLARATION - No Shipper’s Export Declaration Required

  • CUSTOM - Custom / Mutually Defined Clause

 -

C802 =

  • 08 (SHORTSHIPPED) Or

  • 29 (EMERGENCYSTATEMENT) Or

  • 30 (IMOCERTIFICATION) Or

  • 38 (CERTIFICATIONSTATEMENT) Or

  • 20 (NOEXPORTDECLARATION) Or

  • CC (CUSTOM)

 -
        description string Free‑form clause or descriptive text supporting the code. - C803 -
        certificationClauseDescription array Stores additional free‑form continuation texts associated with a certification or contractual clause. - Segment C8C under LX - L0 - C8 loop -
          description string Clause free form text description. - C8C01 / C802 / C803 -
        supplementaryInformation array Captures structured supplementary information qualifiers and text, such as printing instructions, export notes, or onward routing instructions. - Segment SUP under LX - L0 - C8 loop -
          supplementaryInformationType string

Identifies the type of supplementary information, such as supporting documents (invoice, certificate, packing list) or special instructions (routing, printing, validation).

Valid values include:

  • INCLUDEPRINTINGINSTRUCTIONS - Include Printing Instructions

  • EXPORTINSTRUCTIONS - Export Instructions

  • MATERIALSAFETYDATASHEET - Material Safety Data Sheet

  • SANITARYCERTIFICATE - Sanitary Certificate

 -

SUP01 =

  • IPI (INCLUDEPRINTINGINSTRUCTIONS) Or

  • EXP (EXPORTINSTRUCTIONS) Or

  • MSD (MATERIALSAFETYDATASHEET) Or

  • SAN (SANITARYCERTIFICATE)

 -
          description string Free‑form descriptive message of supplementary information. - SUP03 -
      dangerousGoodsInformation array Describes the details of the dangerous goods for shipment instructions. - Segment H1 & H2 under LX - L0 loop -
        shipmentDerivedRisk string It describes the risks involved while shipping dangerous goods. It can be more specific based on UN code. - - -
        shipmentDerivedSubRisk string It describes the sub-risks involved while shipping dangerous goods. It can be more specific based on UN code. - - -
        shipmentFlashPoint string Temperature value indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - H107 -
        isLimitedQuantity boolean

Check point, if the dangerous goods quantity is limited in the shipment.

Valid values:

  • True - 1 - Yes

  • False - 0 - NA

 - - -
        isMarinePollutant boolean

Check point, if the dangerous goods are pollutant into water.

Valid values:

  • True - 1 - Yes Pollutant

  • False - 0 - No

 - - -
        packagingGroup string Dangerous goods packaging group. - H109 -
        designatedDangerousGoodsName string The UN proper shipping name derived from the mandatory UN code. If supplied, this value shall correspond to the proper shipping name stored for the provided UN code. - H104 -
        designatedTechnicalName string Designated technical name for carrier identity. - - -
        designatedTechnicalNationalName string Designated technical name for carrier and international identity. - - -
        minTemperatureValue number It describes from temperature. - - -
        maxTemperatureValue number It describes to temperature. - - -
        dangerousGoodsType string

There are different types of goods which are shipped globally. Multiple organizations has their own usage.

Widely used codes are:

  • ADR - European agreement on the international carriage of dangerous goods on road.

  • IMDG - According to "International Maritime Dangerous Goods Code".

  • IATADG - According to "International Air Transport Association (IATA) Dangerous Goods Regulations (DGR)"

  • ICAO - International civil aviation organization

  • UN - United nations code

 -

H103 =

  • I (IMDG) or

  • A (ADR) or

  • T (IATA)

 -
        dangerousGoodsIdentifier string Dangerous goods identifier. - H101 -
        additionalDangerousGoodsIdentifier string Additional Dangerous goods identifier. - - -
        dangerousGoodsClassCode string It specifies the kind of hazard can be generated by a material. - H102 -
        emergencyContactDetails string Phone number and name of person or department to contact in case of emergency. - H105 -
        dangerousGoodsPackagedQuantity number Packaged quantity of dangerous goods. - - -
        hazardousGoodsPackageType string Package type containing these dangerous goods.

Possible values are:

  • BAG - Bag

  • BOX - Carton / Box

  • CONTAINER - Intermediate Bulk Container

  • COMPOSITE - Composite Packaging

  • GAUGE - Light Gauge Metal Packaging

  • BOTTLES - Bundle of Bottles

  • PRESSUREDRUM - Pressure Drum

  • STEELBOTTLE - Steel Bottle

  • DRUM - Drum

  • CAN - Jerry Can

 - - -
        netQuantityUnit string Net quantity unit of the dangerous goods. - - -
        grossQuantityUnit string Gross quantity unit of the dangerous goods. - - -
        isEmpty boolean

To check if package is empty.

Valid values:

  • True - 1 - Yes

  • False - 0 - No

 - - -
        hazardousMaterialIndex string The United Nations page number as required for the international transport of hazardous materials. - H106 -
        unitOfMeasure string Dimension unit of measure for parent packaging. - H108 -
        additionalDangerousGoodsDescription string Material name, special instructions, and phone number if any. - - -
        additionalDangerousGoodsClassification string Free-form description of hazardous material classification or division or label requirements. - - -
        temperatureScale string

Temperature unit of measure.

valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

 - - -
        additionalDangerousGoodsInformation array Additional Dangerous Goods information to be considered while specifying shipment instructions. - Segment H2 under LX - L0 - H1 loop -
          additionalDangerousGoodsDescription string Material name, special instructions, and phone number if any. - H201 -
          additionalDangerousGoodsClassification string Free-form description of hazardous material classification or division or label requirements. - H202 -
        dangerousGoodsItemQuantity array Dangerous Goods item quantity related information to identify quantity, UOM and value. -   -
          dangerousGoodsQuantityType string

Type of quantity recorded.

Valid value:

  • NET

  • GROSS

  • UNITS

-   -
          dangerousGoodsQuantityValue number Quantity of product at line item level. -   -
          dangerousGoodsQuantityUOM string Quantity unit of measure in master data for dangerous goods. -   -
      dangerousGoodsIdentifiers array It describes the hazardous commodity identification reference number and quantity. - Segment LH1 under LX - L0 loop -
        unitOfMeasure string Unit of measure for dangerous goods identification. - LH101 -
        ladingQuantity string Number of units (pieces) of the lading commodity. - LH102 -
        hazardousMaterialIndex string The United Nations page number as required for the international transport of hazardous materials. - LH104 -
        hazardousGoodsCommodityCode string Code describing a commodity or group of commodities. - LH105 -
        dangerousGoodsQuantityValue number Quantity of product at line item level for dangerous goods. - LH107 -
        residueIndicatorType string

Types of residue indicator.

Valid values include:

  • CONTAINMENT - Residue Last Contained Description (Small Means of Containment)

  • PACKAGES - Residue Last Contained Description (Packages)

  • RAILCAR - Residue Last Contained Description (Rail Car)

 -

LH109 =

  • G (CONTAINMENT) or

  • P (PACKAGES) or

  • R (RAILCAR)

 -
        packagingGroup string Dangerous goods packaging group in terms of Roman number I, II or III. - LH110 -
        dangerousMaterialRegulatoryIdentifier string Identifies the current regulatory version number used for hazardous materials shipments. - LH111 -
        dangerousGoodsEndorsementInformation array LH2 segment describes about hazardous material notation and endorsement. - Segment LH2 under LX - L0 - LH1 loop -
          dangerousGoodsClassCode string Dangerous goods identifier. - LH201 -
          dangerousGoodsClassification string

Describes the hazardous material class.

Valid Values are:

  • PRIMARY - Primary Goods

  • SECONDARY - Secondary Goods

 -

LH202 =

  • P (PRIMARY) or

  • S (SECONDARY)

 -
          reportableSubstanceQuantityCode string To capture the presence of hazardous substance quantity for quick action in case of emergency. - LH205 -
          unitOfMeasure string Unit of measure for dangerous goods identification. - LH206 -
          shipmentFlashPoint string Indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - LH207 -
          shipmentControlTemperature string Indicating the controlled temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - LH209 -
          shipmentEmergencyTemperature string Indicating the maximum emergency temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” - LH211 -
          weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton
  • GRAMS - Grams
  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

-

LH212 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

 -
          explosiveWeight number Net weight of the explosive quantity of the hazardous commodity. - LH213 -
        dangerousGoodsRegulationIdentifiers array To uniquely identify the variable information required by government regulation covering the transportation of hazardous material shipments. - Segment LFH under LX - L0 - LH1 loop -
          hazardMaterialInformationType string

Identifies the regulatory qualifier specifying what type of hazardous‑material information is being provided (e.g., Inhalation Hazard, Marine Pollutant, Radioactive Material).

Valid value:

  • AIRLIFT - Cargo airlift only

  • ISSUEINGAUTHORITY - Person certifying that the shipment complies with the regulations

  • WET - "Dangerous When Wet" Declaration

  • EMERGENCYSCHEDULE - Emergency Schedule (EMS) Page Number

  • INHALATION - Inhalation Hazard

  • LIMITEDQUANTITY - Limited Quantity Declaration

  • MFAG - Medical First Aid Guide (MFAG) Page Number

  • POLLUTANT - Marine Pollutant

  • POISION - Poison Declaration

  • RADIOACTIVE - Radioactive Material Data

  • CHEMICAL -Technical or Chemical Group Name

 -

LFH01 =

  • CAO (AIRLIFT) or

  • CER (ISSUEINGAUTHORITY) or

  • DWW (WET) or

  • EMS (EMERGENCYSCHEDULE) or

  • INH (INHALATION) or

  • LQY (LIMITEDQUANTITY) or

  • MFA (MFAG) or

  • MPI (POLLUTANT) or

  • POI (POISION) or

  • RAM(RADIOACTIVE) or

  • TEC (CHEMICAL)

 -
          description string Specific information required by law for hazardous material shipments. - LFH02 + LFH03 -
      partnerBusinessInformation array Business Parties identifiers and address information. - Segment N1 under LX - L0 loop -
        partnerEntityType string

Denotes type of the entity involved in this business transaction.

Valid values include:

  • SUPPLIER - Supplier

  • CUSTOMER - Buyer

  • MANUFACTURER - Manufacturer

  • CARRIER - Carrier

  • FREIGHTFORWARDER - Freight forwarder

  • WEIGHMASTER - Party to Receive Scale Ticket

- N101 -
        businessName string Business name for partner or location. - N102 -
        additionalBusinessName string Additional Business name for partner or location. - N201 -
        companyLocationPartnerName string Additional Location of same Business partner. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Company identifier type for business partner. - N103 -
          companyIdentifierValue string Company identifier value for business partner. - N104 -
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
        address - Party address information. - Segment N3, N4 under LX - L0 - N1 loop -
          address1 string Main street address. - N301 -
          address2 string Supplemental street address. - N302 -
          city string City - N401 -
          district string District - N/A -
          state string State or region code - N402 -
          postalCode string Postal code - N403 -
          country string Country code - N404 -
          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 - - - Segment G61 under LX - L0 - N1 loop -
          contactType string

Contact type.

Valid values include:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

  • CONFIRMEDWITH - Person whom the content of the PO has been discussed and agreed prior to sending this message.

  • EMERGENCYDANGEROUS - Emergency dangerous goods contact

  • SENDER - Message sender contact

  • RESPONSIBLE - Responsible person contact

 -

G6101 =

  • IC (INFORMATION) or

  • FW (FORWARDER) Or

  • RP (RESPONSIBLE)

 -
          contactName string Contact name. - G6102 -
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - G6104 where G6103 = "TE" -
          contactEmail string Contact email address. - G6104 where G6103 = "EM" -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - Segment N4 under LX - L0 - N1 loop -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          orderType string Order Type. - - -
          address3 string Additional address information that is not included in addressTypeDefinition. - N201 -
          address4 string Additional address information that is not included in addressTypeDefinition. - N202 -
          postalArea string Postal Area. - - -
          timeZone string Time zone for referenced dates. - - -
          telephone string Telephone Number. - - -
          emailAddress string Email Address. - - -
          vatRegistrationNumber string Vat Registration Number. - - -
          taxExemptCode string Tax exempt Code. - - -
          locationType string Business Partner Location Type. - N405 -
          locationIdentifier string Business Partner location Identifier. - N406 -
          countrySubDivisionCode string Describes the country subdivision. - N407 -
      ladingItemRateCharges array Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements. - Segment L1 under LX - L0 loop -
        lineItemNumber string Sequential line number for freight invoice item. - L101 -
        freightRatesChargesIdentifier string Identification of a charge by code and/or by name. Describes about freight and other charges, it can be combination of freight costs, type and charges description. - - -
        freightRate number Rate that applies to the specific commodity. - L102 -
        freightRateType string

Qualifiers to extend charges or interpret or calculate value.

Valid values are:

  • UNIT - Per Unit

  • CAR - Per Car

  • POUND - Per Pound

  • PERCENTAGE - Percentage

  • CHARGES - Charges based on mentioned percentage

  • MILES - Per Miles

  • MINIMUM - Minimum Charge

  • FLAT - Flat rate

  • PERHUNDRED - Per Hundred (of Basic Unit )

 -

L103 =

  • PU (UNIT) or

  • PC (CAR) or

  • PW (PERCENTAGE) or

  • CR (CHARGES) or

  • PM (MILES) or

  • MN (MINIMUM) or

  • PH (PERHUNDRED) or

  • FR (FLAT) or

  • LB (POUND)

 -
        totalCharges number Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency. - L104 (implied 2 decimal points) -
        advancePayment number Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. - L105 (implied 2 decimal points) -
        prepaidAmount number Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency. - L106 (implied 2 decimal points) -
        rateCombinationPointCode string

The code denoting the connecting station for a joint rate obtained by combining two or more published rates which are used for the calculation of transportation charges.

Valid values are:

  • RAIL - Rail

  • AIR - Air

  • MOTOR - Motor

  • R260 - Association of American Railroads Accounting Rule 260

 - - -
        specialChargeCode string

Type of special charge or allowance allowed.

Valid values include:

  • DISCOUNT - Discount

  • SPECIALDISCOUNT - Special Discount

  • CUSTOMSENTRY - Customs Entry

  • CUSTOMSCHARGE - Customs Charge

 -

L108 =

  • DSC (DISCOUNT) or

  • 295 (SPECIALDISCOUNT) or

  • CSE (CUSTOMSENTRY) or

  • CUS (CUSTOMSCHARGE)

 -
        rateClassCode string

Identifies specific & designated class of goods; Note: For international air shipments, see IATA Resolution 600k

Valid values are:

  • CONTRACT - Contract rate

  • EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate

  • MINIMUM - Minimum

  • QUOTED - Quoted rate

  • SENDER - Sender rate

  • CONTAINER - IATA Container or Unit Load Device (ULD)

  • EXCEPTION - Exception rating

 -

L109 =

  • CTR (CONTRACT) or

  • E (EXCESSWEIGHT) or

  • M (MINIMUM) or

  • QUO (QUOTED) or

  • T (SENDER) or

  • X (CONTAINER) or

  • Y (EXCEPTION)

 -
        chargeEntitlementParty string

To describe the types of party involved.

Valid values:

  • SHIPPER

  • CONSIGNEE

  • ISSUINGCARRIER

  • DESTINATIONCARRIER

 -

L110 =

  • S (SHIPPER) or

  • C (CONSIGNEE) or

  • I (ISSUINGCARRIER) or

  • D (DESTINATIONCARRIER)

 -
        chargePaymentMethod string

Payment method for freight invoice charges.

Valid values:

  • PREPAIDCASH

  • PREPAIDCREDIT

  • COLLECT

  • COLLECTCASH

  • COLLECTCREDIT

  • PREPAID

  • THIRDPARTYPAY

-

L111 =

  • A (PREPAIDCASH) or

  • B (PREPAIDCREDIT) or

  • C (COLLECTCASH) or

  • D (COLLECTCREDIT) or

  • E (COLLECT) or

  • P (PREPAID)

 -
        description string Identification of special charge; this data element is used whenever an applicable code cannot be found under rate handling code. - L112 -
        billedQuantityType string

Type of billed quantity recorded.

Valid values include:

  • KILOMETERS - Kilometers

  • MILES - Miles

  • DRIVERS - Identifies a billable unit expressed as persons operating equipment

  • EACH - Each

  • POUND - Pound

  • MILEAGE - Mileage

  • LOAD - Load

  • TRAINPREPAID - Train

  • CONTAINER - Container

  • UNIT - Unit

 -

L118 =

  • DK (KILOMETERS) or

  • DM (MILES) or

  • EA (EACH) or

  • DR (DRIVERS) or

  • LB (POUND) or

  • MR (MILEAGE) or

  • NL (LOAD) or

  • NN (TRAIN) or

  • NR (CONTAINER) or

  • NU (UNIT)

 -
        billedQuantityValue number Quantity of product in delivery. - L117 -
        freightRatePercent number Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%). - L119 -
        currencyCode string Billed Currency Code. - L120 -
        rateOrTariffClassDescription string Free form description of an applicable rate or tariff class. - - -
        freightInvoiceCurrency array Currency for bill of landing. - segment CUR under LX - L0 - L1 loop -
          currencyCode string Currency Code. - CUR02 -
          exchangeRateCurrencyCode string Exchange Rate Currency Code. - - -
          exchangeRate string Exchange Rate. - - -
          validityRate string Validity Date. - - -
          currencyEntityCode string Currency Entity Code. - CUR01 -
        itemQuantity array Quantity details at rate and changes line item. - - -
          quantityType string Type of quantity recorded. Valid values: No sample data available. - - -
          quantityValue number Quantity of product in shipment. - - -
          unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit

 - - -
      freeTextNote array Free text information. - - -
        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. - - -
        freeText 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. Line item level. - - -
        name string Name of mapped field. - - -
        value string Value in named field. - - -
    transactionReferenceIdentifierList array List of documents and transactions at the item level of the message. - Segment L11 under LX loop -
      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:

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • MASTERBOL - Master BOL

 -

L1102 =

  • BM (BOL) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • MB (MASTERBOL)

-
      b2bTransactionIdentifierValue string Transaction reference identifier value. - L1101 for remaining qualifiers and respective enums in b2bTransactionIdentifierType -
      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. - L1104 for remaining qualifiers in b2bTransactionIdentifierType -
      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, L11 and N9 and EDIFACT RFF for information other than transaction documents. - Segment L11 under LX loop -
      transactionReferenceType string

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

Valid values include:

  • BOOKINGIDENTIFIER - Booking confirmation number

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

  • CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assigned shipment identifier.

  • PICKUPIDENTIFIER - Pickup reference number

  • LETTEROFCREDIT - Letter of credit number

 -

L1102 =

  • BN (BOOKINGIDENTIFIER)

  • FN (FORWARDERREFERENCE) Or

  • OC (OCEANCONTAINERIDENTIFIER) Or

  • 8X (TRANSACTIONTYPE)

 -
      transactionReferenceIdentifier string Transaction reference identifier value. - L1101 (for all other cases) -
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier. - L1103 -
      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. - - -
    mpcDates array Dates relevant to shipments events at port, does not have any X12 or EDIFACT related segment, kept as place holder - - -
      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 Arrrivale date

  • ACTUALARRIVAL - Actual arrival date

  • CUSTOMSCLEARANCE - Customs Clearance date

  • VESSELLOADED - Loaded on vessel date

  • CUSTOMSENTRY - Customs entry date

  • PACKED - Date 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. - - -
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
      timeZone string Time zone for referenced dates. - - -
    freeTextNote array Ship to party company identifiers and address information. - Segment K1 under LX loop -
      textReferenceCode string Text reference or subject code. - K101 -
      textFunctionCode string Text function code. - - -
      language string Language of free text. - - -
      textFormatCode string Format code for free text. - - -
      freeFormText string Free test string. - K102 -
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalShippingInstructionSummary - Describes the summary of shipments in terms of weight, volume, rates, charges, advances, paperwork and prepaid amounts applicable to one or more line items - Weight and Charges summary -
    shippingInstructionWeightCharges - Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others - Segment L3 -
      weightValue number Weight of product at PO line item. - L301 -
      weightType string

Type of weight recorded.

Valid values include:

  • GROSSWEIGHT

  • NETWEIGHT

  • TARE

  • DIMENSIONALWEIGHT

- L302 t -
      freightRate number (implicit decimal) Rate that applies to the specific commodity. - L303 -
      freightRateType string

Qualifiers to extend charges or interpret or calculate value.

Valid values are:

  • UNIT - Per Unit

  • CAR - Per Car

  • POUND - Per Pound

  • PERCENTAGE - Percentage

  • CHARGES - Charges based on mentioned percentage

  • MILES - Per Miles

  • MINIMUM - Minimum Charge

  • FLAT - Flat rate

  • PERHUNDRED - Per Hundred (of Basic Unit )

 -

L304 or L315 =

  • PU (UNIT) or

  • PC (CAR) or

  • PW (PERCENTAGE) or

  • CR (CHARGES) or

  • PM (MILES) or

  • MN (MINIMUM) or

  • PH (PERHUNDRED) or

  • FR (FLAT) or

  • LB (POUND)

 -
      totalCharges number Describes about freight or special charge or total charges -- expressed in the standard monetary denomination for specified currency. - L305 -
      advancePayment number Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. - L306 -
      prepaidAmount number Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency. - L307 -
      specialChargeCode string

Type of special charge or allowance allowed.

Valid values include:

  • DISCOUNT - Discount

  • SPECIALDISCOUNT - Special Discount

  • CUSTOMSENTRY - Customs Entry

  • CUSTOMSCHARGE - Customs Charge

 -

L308 =

  • DSC (DISCOUNT) or

  • 295 (SPECIALDISCOUNT) or

  • CSE (CUSTOMSENTRY) or

  • CUS (CUSTOMSCHARGE)

 -
      volumeValue number Volume for item - L309 -
      volumeType string Type of weight recorded. Valid values include: - TOTAL - L310 -
      quantityValue number Quantity of product in delivery - L311 where quantityType = LADING -
      weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton
  • GRAMS - Grams
  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

-

L312 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

 -
      tariffIdentifier string Standard tariff number for the tariff which governs the rates applied to the commodity item(s). - L313 -
      quantityType string

Type of quantity recorded.

The valid values include LADING.

 - - -
    mpcCurrency array Currency for bill of landing. - segment CUR under L3 loop -
      currencyCode string Currency Code. - CUR02 -
      exchangeRateCurrencyCode string Exchange Rate Currency Code. - - -
      exchangeRate string Exchange Rate. - - -
      validityRate string Validity Date. - - -
      currencyEntityCode string Currency Entity Code. - CUR01 -
    creditsAndCharges array Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others. - Segment SAC under L3 loop -
      creditChargeKeyType string

Key identifies credit or charges as discounts or additional charges.

Valid values include:

  • ALLOWANCE

  • CHARGE

  • PROMOTION

  • INCREASE

  • DECREASE

  • NONE

  • ADDITIONALALLOWANCES

-

SAC01 =

  • A (ALLOWANCE) or

  • C (CHARGE) or

  • N (NONE)

 -
      creditChargeType string Code representing type of credit or charge. - SAC02 -
      creditChargeSubType string Code representing sub type of credit or charge. - - -
      creditChargeAmount string Total amount for the payment. - SAC05 -
      qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. - - -
      discountQualifyingLeadTimeType string

Discount Qualifying lead time to define the number of days within which discount or any other allowances are applicable.

Valid values are:

  • DAYS - Additional discount, if paid within mentioned number of days

  • WEEKS - Additional discount, if paid within mentioned number of weeks

  • MONTH - Additional discount, if paid within mentioned number of months

 - - -
      creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. - SAC07 -
      percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. - SAC06 -
      creditChargeCurrencyCode string Currency code for credit or charge. - - -
      creditChargeHandlingCode  

Method of handling for discount or charge.

Valid values include:

  • ADVANCE

  • CANCELALLOWANCE

  • COLLECT

  • CREDITCUSTOMER

  • GROSSINVOICED

  • INFORMATION

  • PREPAID

  • RESELLERALLOWANCE

  • VENDORPAID

 - SAC12 -
      description string Description of credit or charge. - SAC15 -
      unitPriceAmount string Unit price amount. - - -
      unitPriceBasisQuantity string Unit price basis quantity. - - -
      itemQuantity string Quantity of product for credits or charges. - - -
      unitOfMeasure string Unit of measure for item quantity. - - -
      baseValue string Base value for credit or charge. - - -
      creditChargeConditionType string Credit charge condition type. - - -
    shipmentPaperworkInformation array To describe the type or transmission or both of paperwork or supporting information. - Segment PWK under L3 loop -
      reportOrDocumentType string

Specifies the type of supporting document or report accompanying the shipment, such as a Bill of Lading, Invoice, Certificate of Origin, or Packing List.

Valid values include:

  • BOL - Bill of lading

  • BOLCOPY - Copy of bill of lading

 - PWK01 =BO (BOL) Or BC (BOLCOPY) -
      transmissionMethodType string

Specifying timing, transmission method or format by which reports or documents are to be sent.

Valid values are:

  • ELECTRONICINVOICE - Full Electronic Invoice

  • PRINTEDINVOICE - Printed Invoice Sent by Mail

  • ELECTRONICMAIL - Electronic Mail

  • ORIGINALPRINTED - Printed Original Required

  • COURIER - By courier

  • EMAIL - E-mail

  • FT - File transfer

  • FAX - By fax

  • TEXT - Text

 -

PWK02 =

  • TX (TEXT) or

  • PO (ORIGINALPRINTED) or

  • FX (FAX) or

  • EM (EMAIL) or

  • FT (FT) or

  • CF (COURIER) or

  • 9 (ELECTRONICMAIL) or

  • 2 (ELECTRONICINVOICE) or

  • 3 (PRINTEDINVOICE)

 -
      reportCopiesQuantity number The number of copies of a report that should be sent to the addressee. - PWK03 -
      partnerEntityType string

Denotes type of the entity involved in this business transaction.

Valid values include:

  • SUPPLIER - Supplier

  • CUSTOMER - Buyer

  • MANUFACTURER - Manufacturer

  • CARRIER - Carrier

  • FREIGHTFORWARDER - Freight forwarder

  • WEIGHMASTER - Party to Receive Scale Ticket

- PWK04 -
      partyIdentifierType string Indicate who the paperwork is intended for — i.e., the addressee of the report or documentation. - PWK05 -
      companyIdentifierValue string Company identifier value for paperwork. - PWK06 -
      description string A free-form description to clarify the related data elements and their content. - PWK07 -
    shippingInstructionRateChargesSummary array Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements. - Segment L1 under L3 loop -
      lineItemNumber string Sequential line number for freight invoice item. - L101 -
      freightRatesChargesIdentifier string Identification of a charge by code and/or by name. Describes about freight and other charges, it can be combination of freight costs, type and charges description. - - -
      freightRate number Rate that applies to the specific commodity. - L102 -
      freightRateType string

Qualifiers to extend charges or interpret or calculate value.

Valid values include:

  • UNIT - Per Unit

  • CAR - Per Car

  • POUND - Per Pound

  • PERCENTAGE - Percentage

  • MILES - Per Miles

  • MINIMUM - Minimum Charge

  • FLAT - Flat rate

  • PERHUNDRED - Per Hundred (of Basic Unit)

-

L103 =

  • PU (UNIT) or

  • PC (CAR) or

  • PW (PERCENTAGE) or

  • PM (MILES) or

  • MN (MINIMUM) or

  • PH (PERHUNDRED) or

  • FR (FLAT) or

  • LB (POUND)

 -
      totalCharges number Describes about freight or special charge or total charges -- expressed in the standard monetary denomination for specified currency. - L104 (implied 2 decimal points) -
      advancePayment number Incidental charges occured during transportation expressed in the standard monetary denomination for the specified currency. - L105 (implied 2 decimal points) -
      prepaidAmount number Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency. - L106 (implied 2 decimal points) -
      rateCombinationPointCode string

The code denoting the connecting station for a joint rate obtained by combining two or more published rates which are used for the calculation of transportation charges.

Valid values are:

  • RAIL - Rail

  • AIR - Air

  • MOTOR - Motor

  • R260 - Association of American Railroads Accounting Rule 260

 - - -
      specialChargeCode string

Type of special charge or allowance allowed.

Valid values include:

  • DISCOUNT - Discount

  • SPECIALDISCOUNT - Special Discount

  • CUSTOMSENTRY - Customs Entry

  • CUSTOMSCHARGE - Customs Charge

 -

L108 =

  • DSC (DISCOUNT) or

  • 295 (SPECIALDISCOUNT) or

  • CSE (CUSTOMSENTRY) or

  • CUS (CUSTOMSCHARGE)

 -
      rateClassCode string

Identifies specific & designated class of goods; Note: For international air shipments, see IATA Resolution 600k.

Valid values are:

  • CONTRACT - Contract rate

  • EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate

  • MINIMUM - Minimum

  • QUOTED - Quoted rate

  • SENDER - Sender rate

  • CONTAINER - IATA Container or Unit Load Device (ULD)

  • EXCEPTION - Exception rating

 -

L109 =

  • CTR (CONTRACT) or

  • E (EXCESSWEIGHT) or

  • M (MINIMUM) or

  • QUO (QUOTED) or

  • T (SENDER) or

  • X (CONTAINER) or

  • Y (EXCEPTION)

 -
      chargeEntitlementParty string

To describe the types of party involved.

Valid values:

  • SHIPPER

  • CONSIGNEE

  • ISSUINGCARRIER

  • DESTINATIONCARRIER

-

L110 =

  • S (SHIPPER) or

  • C (CONSIGNEE) or

  • I (ISSUINGCARRIER) or

  • D (DESTINATIONCARRIER)

 -
      chargePaymentMethod string

Payment method for freight invoice charges.

Valid values:

  • PREPAIDCASH

  • PREPAIDCREDIT

  • COLLECT

  • COLLECTCASH

  • COLLECTCREDIT

  • PREPAID

  • THIRDPARTYPAY

-

L111 =

  • A (PREPAIDCASH) or

  • B (PREPAIDCREDIT) or

  • C (COLLECTCASH) or

  • D (COLLECTCREDIT) or

  • E (COLLECT) or

  • P (PREPAID)

 -
      description string Identification of special charge; this data element is used whenever an applicable code cannot be found under rate handling code. - L112 -
      billedQuantityType string

Type of billed quantity recorded.

Valid values include:

  • KILOMETERS - Kilometers

  • MILES - Miles

  • DRIVERS - Identifies a billable unit expressed as persons operating equipment

  • EACH - Each

  • POUND - Pound

  • MILEAGE - Mileage

  • LOAD - Load

  • TRAINPREPAID - Train

  • CONTAINER - Container

  • UNIT - Unit

 -

L118 =

  • DK (KILOMETERS) or

  • DM (MILES) or

  • EA (EACH) or

  • DR (DRIVERS) or

  • LB (POUND) or

  • MR (MILEAGE) or

  • NL (LOAD) or

  • NN (TRAIN) or

  • NR (CONTAINER) or

  • NU (UNIT)

 -
      billedQuantityValue number Quantity of product in delivery. - L117 -
      freightRatePercent number Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%). - L119 -
      currencyCode string Billed Currency Code. - L120 -
      rateOrTariffClassDescription string Free form description of an applicable rate or tariff class. - - -
      freightInvoiceCurrency array Currency for bill of landing. - segment CUR under L3 - L1 loop -
        currencyCode string Currency Code. - CUR02 -
        exchangeRateCurrencyCode string Exchange Rate Currency Code. - - -
        exchangeRate string Exchange Rate. - - -
        validityRate string Validity Date. - - -
        currencyEntityCode string Currency Entity Code. - CUR01 -
      itemQuantity array Quantity details at rate and changes line item. - - -
        quantityType string Type of quantity recorded. Valid values: No sample data available. - - -
        quantityValue number Quantity of product in shipment. - - -
        unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit.

 - - -
    shippingInstructionEventDetails array To report events occurred during ocean, rail, air shipments. - Segment V9 under L3 loop -
      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:

  • CONTAINERDELAY - Import Container Delay

  • INCORRECTADDRESS - Incorrect Address

  • CONSIGNEEREFUSED - Refused by Consignee

  • DAMAGEDDELIVERYNOTCOMPLETED - Damaged - Delivery Not Completed

 -

V908 =

  • 052 (CONTAINERDELAY) Or

  • A03 (INCORRECTADDRESS) Or

  • A07 (CONSIGNEEREFUSED) Or

  • A10 (DAMAGEDDELIVERYNOTCOMPLETED) Or

 -
      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 TRUCK

  • CARGO - Cargo operation temparature

  • 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. - - -
    transactionReferenceIdentifierList array List of documents and transactions at the summary level of the message. - Segment L11 under L3 loop -
      b2bTransactionIdentifierType string

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

Valid values include:

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • MASTERBOL - Master BOL

 -

L1102 =

  • BM (BOL) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • MB (MASTERBOL)

-
      b2bTransactionIdentifierValue string Transaction reference identifier value defined by enum in transactionReferenceType defined by transaction reference type. - L1101 for remaining qualifiers and respective enums in b2bTransactionIdentifierType -
      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. - L1104 for remaining qualifiers in b2bTransactionIdentifierType -
      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, L11 and N9 and EDIFACT RFF for information other than transaction documents. - Segment L11 under L3 loop -
      transactionReferenceType string

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

Valid values include:

  • BOOKINGIDENTIFIER - Booking confirmation number

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

  • CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assigned shipment identifier.

  • PICKUPIDENTIFIER - Pickup reference number

  • LETTEROFCREDIT - Letter of credit number

 -

L1102 =

  • BN (BOOKINGIDENTIFIER)

  • FN (FORWARDERREFERENCE) Or

  • OC (OCEANCONTAINERIDENTIFIER) Or

  • 8X (TRANSACTIONTYPE)

-
      transactionReferenceIdentifier string Transaction reference identifier value. - L1101 (for all other cases) -
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier. - L1103 -
      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. - Segment K1 under L3 loop -
      textReferenceCode string Text reference or subject code. Will map whatever is found. - K101 -
      textFunctionCode string Text function code. Will map whatever is found. - - -
      language string Language of free text - - -
      textFormatCode string Format code for free text - - -
      freeFormText string Free test string - K102 -
    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. - - -
  freeTextNote array Free text, instructions, notes, descriptions and other free text elements - K1 -
    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 - K101 -
  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