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

Ocean shipment arrival notice canonical guidelines

Ocean Shipment Arrival Notice, is an electronic message used by ocean carriers or freight forwarders to notify the shipper, manufacturer or, consignee when an ocean freight shipment is nearing or has arrived at its destination port. An Ocean Shipment Arrival Notice typically includes the estimated arrival date and time, details of the vessel and voyage, the port of arrival, and shipment and container identifiers. It also outlines customs clearance requirements and specifies any charges due before cargo arrival.

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. – – –
  canonicalOceanShipmentArrivalNoticeHeader – Header details for the canonical Ocean Shipment Arrival Notice message canonical. – B3 BGM
    processingFunctionTypeCode string

Processing function, transaction set purpose code.

Valid values include:

  • CREATE

  • CHANGE

  • CANCEL

  • ORIGINAL

  • REPLACE

  • STATUS

– -

BGM030 =

  • 8 (STATUS) or

  • 9 (ORIGINAL)
    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 - Supplemental billing

  • ROUNDTRIPMOVEMENT - Roundtrip Movement

  • VOIDBILL - Void bill

 – B301 –
    shipmentChargePaymentMethodType string

Method of payment for delivery.

Valid values:

  • ADVANCECOLLECT - Advance collect

  • ADVANCEPREPAID - Advance prepaid

  • BUYER - Paid by buyer

  • BUYERSELLERDEFINED - Defined by buyer and seller

  • COLLECT - Collect

  • NOCHARGESERVICEFREIGHT - Service freight, no charge

  • PREPAIDONLY - Prepaid only

  • SELLER - Paid by seller

  • THIRDPARTYPAY - Third party pay.

 –

B304 (Mandetory)

–
    netAmountDue number Total charges to be paid by the receiver of this transaction. – B307 (Mandetory) (Implied Decimal) MOA010-020 when MOA010-010 = 9
    correctionType string

Code specifying correction to previous arrival notification.

Valid values include:

  • ADJUSTMENT - Adjustment of Previous Freight Bill Charges

  • CANCELLEDBILL - Canceled Bill

  • BALANCEDUE - Balance Due Billing

  • DIVERSION - Shipment was diverted or reconsigned

  • SHIPMENTDELAYED - Shipment was delayed

  • SHIPMENTMISROUTED - Shipment was misrouted

  • TRANSLOADED - Shipment was trans-loaded to another conveyance

 –

B308

–
    dateType string

Date type qualifier.

The valid value is DELIVERY - Delivery date.

 –

B310

DTM010-010 = 35 (DELIVERY)
    deliveryDate string Date for delivery of cargo to final consignee or to next mode of transport. – B309 DTM010-020
    epochDeliveryDate long Date for delivery of cargo to final consignee in long format. – – –
    carrierCode string Shipping carrier alpha code (SCAC). – B311 (Mandetory) RFF02 when RFF01 = AAZ
    servicesTariffCode string

Types of services rendered 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

 –

B313 =

  • BB (BARGETOBARGE) or

  • BD (BARGETODOOR) or

  • BM (BARGETOMOTOR) or

  • BR (BARGETORAIL)

–
    deliveryTermCode string Code identifying the trade terms, X12 pass through. – B314 –
    arrivalDetails – Vessel or shipment estimated arrival date at destination port. – Q3 (Mandetory) –
      dateValue string Estimated arrival date at port of discharge. – Q301 (Mandetory) DTM010-020 when DTM010-010 = 17 (ESTIMATEDDELIVERY)
      epochDateValue long Date for arrival of cargo at port of discharge in long format. – – –
      shipmentChargePaymentMethodType string

Method of payment for delivery.

Valid values:

Valid values:

  • ADVANCECOLLECT - Advance collect

  • ADVANCEPREPAID - Advance prepaid

  • BUYER - Paid by buyer

  • BUYERSELLERDEFINED - Defined by buyer and seller

  • COLLECT - Collect

  • NOCHARGESERVICEFREIGHT - Service freight, no charge

  • PREPAIDONLY - Prepaid only

  • SELLER - Paid by seller

  • THIRDPARTYPAY - Third party pay.

 –

Q302 (Mandetory)

–
    mpCurrency array Currency. – segment C3 –
      currencyCode string Currency Code. – C301 –
      exchangeRateCurrencyCode string Exchange Rate Currency Code. – – –
      exchangeRate string Exchange Rate. – – –
      validityRate string Validity Date. – – –
      currencyEntityCode string Currency Entity Code. – – –
    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 TDT - group8
      carrierCode string Shipping carrier alpha code (SCAC). – R201 TDT050-010
      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

TDT010-010

      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:

  • 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

 –

R212 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

–
      description string Routing description. – R213 –
    transportStageLocationDetails array Transport details such as mode of transport, means of transport, its conveyance reference number and the identification of the means of transport. The segment may be pointed to by the TPL segment. – – TDT Group 8
      carrierSequenceCode string

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

Valid values include:

  • ORIGINAL - Original carrier

  • FIRST - First carrier after original

  • SECOND - Second carrier after original

  • THIRD - Third carrier after original

  • FOURTH - Fourth carrier after original

  • FIFTH - Fifth carrier after original

 – –

TDT010 =

  • 3 (ATARRIVAL) or

  • 11 (ATBORDER) or

  • 12 (ATDEPARTURE) or

  • 13 (ATDESTINATION) or

  • 15 (FOURTH) or

  • 16 (FIFTH) or

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

Transport method type.

Valid values include:

  • TRUCK - Truck

  • RAIL- Shipped by train

  • SEA - By sea

  • AIR - By air

  • LTL - Less than truckload

  • AIREXPRESS - Air express

  • CONTAINERSEA - Container by ship

 – –

TDT030-010

      carrierCode string Shipping carrier alpha code (SCAC). – – TDT050-010
      carrierCodeListAgencyIdentifier – Agency codes and its referenced code list to interpret the carrier code correctly. – – –
        codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – TDT050-020
        codeListResponsibleAgencyType string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT050-030
      carrierName string Name of carrier. – – TDT050-040
      transportMeansIdentifier string Means of transport identifier given by code list agency. – – TDT080-010
      transportMeansIdentifierCodeListAgencyIdentifier – Agency codes and its referenced code list to interpret the transport means code correctly. – – –
        codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – TDT080-020
        codeListResponsibleAgencyType string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT080-030
      vesselName string Name of ship as documented in "Lloyd's Register of Ships". – – TDT080-040
      countryCode string Ship/Vessel registered country code - ISO 2 Alpha Country Codes. – – TDT080-050
      transactionReferenceInformation array

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

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

 – – TDT-RFF
        transactionReferenceType string

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

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

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

Port or Terminal function codes ,

Valid values include:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of Loading

  • PORTOFDISCHARGE - Port of Discharge

  • TRANSSHIPMENT - Transshipment Port

  • CONSOLIDATIONPOINT - Re-consolidation Point

  • DECONSOLIDATIONPOINT - De-Consolidation Point

  • FINALDESTINATION - Final Destination

 – –

LOC010

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

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

Valid values include:

  • ESTIMATEDDEPARTURE - Estimated Departure Date

  • ACTUALDEPARTURE - Actual Departure date

  • ESTIMATEDARRIVAL - Estimated Arrival date

  • ACTUALARRIVAL - Actual arrival date

 – –

DTM010-010

          dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. – – DTM010-020
          epochDateValue integer Date defined by referenced date type generated in epoch integer date format. – – –
          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

 – – DTM010-030
          timeZone – – – – –
    transactionReferenceIdentifierList array List of documents and transactions((Do not have sample data, kept this based on 315 sample data) at the header level of the message. – N9 & B3 RFF and BGM
      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:

  • OCEANSHIPMENTARRIVALNOTICE (Required) - Transaction unique identifier

  • CONTRACT - Contract number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • SHIPMENT - Shipper's identifier for the shipment

  • INVOICE - Seller invoice number (Required)

  • MASTERBOL - Master BOL

  • SEALNUMBER - Seal number

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDERIDENTIFIER - Conginees order number

–

N901 =

  • BM (BOL) Or

  • CT (CONTRACT) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • SI (SHIPMENT) Or

  • IV (INVOICE) Or

  • MB (MASTERBOL) Or

  • SN (SEALNUMBER) Or

  • AG (AGENTSHIPMENT) Or

  • CN (CARRIERREFERENCE) Or

N/A RFF010-010 =

  • BM (BOL) Or

  • ON (PURCHASEORDER) Or

  • SN (SEALNUMBER) Or

  • CG (CONSIGNEEORDER) Or
      b2bTransactionIdentifierValue string Transaction reference identifier value defined by enumeration in transactionReferenceType defined by transaction reference type. –

  • B302 when b2bTransactionIdentifierType = OCEANSHIPMENTARRIVALNOTICE and INVOICE (Mandetory)

  • B303 when b2bTransactionIdentifierType = SHIPMENT

  • N902 for remaining qualifiers in b2bTransactionIdentifierType

  • BGM020-010 when b2bTransactionIdentifierType = OCEANSHIPMENTARRIVALNOTICE

  • RFF010-020 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. –

  • B306 (Date)b2bTransactionIdentifierType =OCEANSHIPMENTARRIVALNOTICE

  • N904+N905 for remaining qualifiers in b2bTransactionIdentifierType

 ST-DTM010-020 when ST-DTM010-010 = 137 (Document Date) when b2bTransactionIdentifierType =OCEANSHIPMENTARRIVALNOTICE
      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.(Do not have sample data, kept this based on 315 sample data).

 – N9 –
      transactionReferenceType string

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

Valid values include:

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • CUSTOM - Mutually defined reference number

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

  • CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assiged shipment identifier.

  • PICKUPIDENTIFIER - Pickup reference number

 –

N901 =

  • FN (FORWARDERREFERENCE) Or

  • ZZ (CUSTOM) Or

  • OC (OCEANCONTAINERIDENTIFIER) Or

  • 8X (TRANSACTIONTYPE)

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

  • SRN (CARRIERASSIGNEDSHIPPERIDENTIFIER) Or

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

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

Valid values:

  • DOCUMENT

  • INVOICE

  • ESTIMATEDARRIVAL

  • ACTUALARRIVAL

– –

DTM010-010 =

  • 137 (DOCUMENT) Or

  • 003 (INVOICE) Or

  • 132 (ESTIMATEDARRIVAL) Or

  • 178 (ACTUALARRIVAL)

      dateValue string

Date defined by referenced date type in date format YYYY-MM-DD.

Transform will pass thru whatever it finds in IDoc date and time fields.

 – – DTM010-020
      epochDateValue integer

Date defined by referenced date type generated in epoch integer date format.

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

 – –

DTM010-030

      timeZone string Time zone for referenced dates. – – –
    vesselDetails array Vessel identifier information along with transportation details such as dates, quantity , weight and volume. – V1 –
      carrierSequenceCode string

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

Valid values include:

  • ORIGINAL - Original carrier

  • PRECARRIAGE - Pre carriage transport

  • ONCARRIAGE - On carriage transport

 – – –
      vesselIdentifier string Vessel Identifier. – V101 –
      vesselCodeType string

Vessel code type.

Valid values :

  • USCENSUS - U.S. Bureau of Census

  • SHIPSRADIO - Ship's Radio Call Signal

  • LLOYD - Lloyd's Register of Shipping

  • MUTUALLYDEFINED - Mutually defined number

 –

V108 =

  • B (USCENSUS) 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 Shipping carrier alpha code (SCAC). – V105 –
    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

–

H301 =

  • EP (EXPEDITE) or

  • DM (DOMESTIC) or

  • DA (DANGEROUS) or

  • CH (CARRIER)

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

 –
    ladingItemDetails   Lading item in terms of description, quantity, packaging, and marks and numbers. – L5 –
      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 Drung Code

  • FREIGHT - Canadian Freight

  • MOTORFREIGHT - Motor Freight Classification

  • BULK - Bulk Codes

  • QUOTA - Quota Category

  • TRADE - Standard International Trade Classification

  • TRANSPORTATION - Standard Transportation Commodity Code

  • MUTUALLYDEFINED - Mutually defined

 –

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)

 –
      packagingFormatMaterialType string

Code identifying type of package.

Valid values included :

  • ENVELOPE - Envelope

  • SACHET - Sachet

  • TUBE - Tube

  • VIAL - Vial

  • WRAPPED - Wrapped

 – L505 –
    notifyPartyBusinessInformation – Recipient party of Arrival notification. – N101 = "N1" NAD01 = "NI"
      businessName string Business name for partner or location. – N102 NAD040-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values include:

  • DUNS - D-U-N-S number, Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r, Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name – PER02 CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extdended street address. – – –
        address4 string Extendd supplemental street address. – – –
    notifyParty1BusinessInformation – Notifying 2nd party business information. – – NAD01 = "N2"
      businessName string Business name for partner or location. – – NAD040-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values include:

  • DUNS - D-U-N-S number, Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r, Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 – –

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. – – NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address   Party address information. – – –
        address1 string Main street address. – – NAD050-010
        address2 string Supplemental street address. – – NAD050-020
        city string City – – NAD060
        district string District – – –
        state string State or region code – – NAD070-010
        postalCode string Postal code – – NAD080
        country string Country code – – NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – -
        contactName string Contact name – – CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – – COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. – – COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    shipperBusinessInformation – shipper party company identifiers and address information. – N101 = "SH" NAD01 = "DEQ"
      businessName string Business name for partner or location. – N102 NAD040-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

–

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – N3, N4 –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name – PER02 CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    shipToBusinessInformation – Ship to party or warehouse location company identifiers and address information. – – –
      businessName string Business name for partner or location. – – –
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Note: Need to create lookup file for java exits for companyIdentifierType.

 – – –
        companyIdentifierValue string Company identifier value for business partner. – – –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – – –
        address2 string Supplemental street address. – – –
        city string City – – –
        district string District – – –
        state string State or region code – – –
        postalCode string Postal code – – –
        country string Country code – – –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – – –
        contactName string Contact name – – –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – – –
        contactEmail string Contact email address. – – –
      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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    carrierInformation array Carrier party company identifiers and address information. – N101 = "CA" NAD01= "CA"
      businessName string Business name for partner or location. – N102 NAD030-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

–

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

NAD020-030

 
        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – N3, N4, v4010 only –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name – PER02 CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    billToBusinessInformation – Party representing the carrier for arranging transportation or handling. – N101 = "BT" NAD01= "BT"
      businessName string Business name for partner or location. – N102 NAD030-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

-

 –

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

NAD020-030

-
        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – N3, N4 –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name. – PER02 CTA020-020
        contactTitle string Title of contact. – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    consigneeBusinessInformation – Consignee party company identifiers and address information. – N101 = "CN" NAD01= "CN"
      businessName string Business name for partner or location. – N102 NAD030-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner

–

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

NAD020-030

 
        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – N3, N4 –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name – PER02 CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    consignorBusinessInformation – Consignor party company identifiers and address information. – N101 = "CI" NAD01= "CZ"
      businessName string Business name for partner or location. – N102 NAD030-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

–

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

NAD020-030

-
        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – N3, N4 –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name – PER02 CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    freightForwarderInformation – Party representing the carrier for arranging transportation or handling. – N101 = "FW" NAD01= "FW"
      businessName string Business name for partner or location. – N102 NAD030-010
      additionalBusinessName string Additional business name or overflow of business name. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

–

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

NAD020-030

-
        companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – N3, N4 –
        address1 string Main street address. – N301 NAD050-010
        address2 string Supplemental street address. – N302 NAD050-020
        city string City – N401 NAD060
        district string District – – –
        state string State or region code – N402 NAD070-010
        postalCode string Postal code – N403 NAD080
        country string Country code – N404 NAD090
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – - -
        contactName string Contact name – PER02 CTA020-020
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
        contactEmail string Contact email address. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "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. – – –
        address3 string Extended street address. – – –
        address4 string Extended supplemental street address. – – –
    cargoMovementPortDetails array Port or terminal details related to cargo movement. – R4 Loop LOC Loop - group1
      portOrTerminalDetails – – – R4 LOC
        portOrTerminalFunctionCode string

Port or Terminal function codes.

Valid values include:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of loading

  • PORTOFDISCHARGE - Port of discharge

  • TRANSSHIPMENT - Transshipment port

  • CONSOLIDATIONPOINT - Re-consolidation point

  • DECONSOLIDATIONPOINT - De-consolidation point

  • FINALDESTINATION - Final destination

 –

R401 =

  • O (ORIGIN) Or

  • L (PORTOFLOADING) Or

  • D (PORTOFDISCHARGE) Or

  • T (TRANSSHIPMENT) Or

  • B (CONSOLIDATIONPOINT) Or

  • C (DECONSOLIDATIONPOINT) Or

  • N (FINALDESTINATION)

LOC010

        oceanShipmentLocationCode string

Movement of the cargo location identifier type code:

Valid values include:

  • ONVESSEL - On vessel (Free On Board [FOB] point)

  • CONTAINERYARD - Container yard

  • DESTINATION - Destination - shipping

  • PORTOFEMBARKATION - Port of embarkation

  • PORTOFLOADING - Port of loading

  • PORTOFDISCHARGE - Port of discharge

  • PLACEOFDELIVERY - Place of delivery

  • PORTOFENTRY - Port of entry

 –

R402

–
        locationCodeListIdentifier – Agency codes and its referenced code list to interpret the carrier code correctly. – –  
          codeListIdentifier string Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. – – LOC020-020
          agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – LOC020-030
        oceanShipmentLocationIdentifier string Identifies the cargo's specific location. – R403 LOC020-010
        portName string Name of the port. – R404 LOC020-040
        countryCode string Country code. – R405 LOC030-010 (LOC030-020 = 162 (Country))
        terminalName string Terminal Name – R406 –
        state string State code – R408 LOC040-010 (LOC040-020 = 169 (Country- sub entity))
      mpcDates array Dates relevant to location events, provision given to map to EDIFACT data. – DTM LOC-DTM
        dateType string

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

Valid values include:

  • ESTIMATED - Estimated

  • ACTUAL - Actual

  • ESTIMATEDDEPARTURE - Estimated departure date

  • ACTUALDEPARTURE - Actual departure date

  • ESTIMATEDARRIVAL - Estimated arrival date

  • ACTUALARRIVAL - Actual arrival date

  • CUSTOMSCLEARANCE - Customs clearance date

  • VESSELLOADED - Loaded on vessel date

  • CUSTOMSENTRY - Customs entry date

  • PACKED - Date packed

 –

DTM01 =

  • 139 (ESTIMATED) Or

  • 140 (ACTUAL) Or

  • 369 (ESTIMATEDDEPARTURE) Or

  • 370 (ACTUALDEPARTURE) Or

  • 371 (ESTIMATEDARRIVAL) Or

  • 372 (ACTUALARRIVAL) Or

  • 058 (CUSTOMSCLEARANCE) Or

  • 161 (VESSELLOADED) Or

  • 813 (CUSTOMSENTRY) Or

  • 510 (PACKED)

DTM010-010

        dateValue string

Date defined by referenced date type in date format YYYY-MM-DD.

Transform will pass thru whatever it finds in IDoc date and time fields.

 – DTM02 & DTM03 DTM010-020
        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

 – –

DTM010-030

        timeZone string Time zone for referenced dates. – DTM04 –
    deliveryTerms array Terms of delivery, transport or inco terms looping group. – – TOD Loop - group 2
      deliveryTermCode string Inco term code. – – –
      deliveryTermsConditionCode string Delivery Terms condition code. – – TOD010
      description string Description for inco term. – – TOD030-040
      deliveryChargePaymentMethodType string Method of payment for delivery – – TOD010-020
      fobTransferLocation string

Code specifying the type of location at which the risk of loss for the shipment transfers.

Valid values:

  • CITY

  • PLANT

  • SHIPPINGDESTINATION

  • SHIPPINGORIGIN

– – –
    freightRateCharges array Describes rate and charges details related to item including freight charges, advances, special charges, and entitlements. – L1 TCC - group 7
      lineItemNumber string Sequential line number for freight invoice item. – L101 TCC010-060
      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. – – TCC010-010
      freightRate number Rate that applies to the specific commodity. – L102 –
      freightRateType string

Qualifiers to extend charges or interpret or calculate value.

Valid values Including:

  • HUNDREDWEIGHT - Per hundredweight (transportation rate per 100 lbs)

  • CUBICFEET - Per cubic foot (volume-based rating)

  • STOP - Per stop (accessibility charge qualifier)

  • CUBICMETER - Per cubic meter

  • CONTAINER - Per container

  • DAY - Per day

  • HOUR - Per hour

  • SHIPMENT - Per shipment

  • PACKAGE - Per package charge

  • WEIGHT - Weight or Measurement

 –

L103

–
      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) MOA010-020 when MOA010-010= 128
      currencyUsageType string Describes the type of currency based on usage. – – –
      advancePayment number Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. – L105 (implied 2 decimal points) MOA010-020 when MOA010-010= 74
      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) MOA010-020 when MOA010-010= 113
      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. – – –
      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 include:

  • 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

  • BASIC - Basic rate

  • COMMODITY - Specific commodity rate

  • EXPORT - Export Subsidy Rate

  • SUBSIDY - Subsidy Rate

  • KILOGRAM - Rate per kilogram

  • MINIMUM - Minimum charge rate

 –

L109 =

  • CTR (CONTRACT) or

  • E (EXCESSWEIGHT) or

  • M (MINIMUM) or

  • QUO (QUOTED) or

  • T (SENDER) or

  • X (CONTAINER) or

  • Y (EXCEPTION)

TCC020-010 =

  • B (BASIC) or

  • C (COMMODITY) or

  • G (EXPORT) or

  • H (SUBSIDY) or

  • K (KILOGRAM) or

  • M (MINIMUM)
      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

–

L111 =

  • A (PREPAIDCASH) or

  • B (PREPAIDCREDIT) or

  • C (COLLECTCASH) or

  • D (COLLECTCREDIT) or

  • E (COLLECT) or P (PREPAID)

TCC010-050 =

  • C (COLLECT) or

  • P (PREPAID) or B (THIRDPARTYPAY)
      description string Identification of special charge; this data element is used whenever an applicable code cannot be found under rate handling code. – L112 TCC010-040
      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

  • TRAIN - 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 Currency code for the pricing amount. – L120 MOA030
      rateOrTariffClassDescription string Free form description of an applicable rate or tariff class. – – TCC020-040
      itemQuantity array

Shipment quantity, chargable quantity that applies charges.

Notes: Rebate returns are indicated by negative values in the QTY and AMT segments.

 – – QTY
        quantityType string

Type of quantity recorded.

Valid values include.

  • CHARGEABLEWEIGHT - Chargeable weight quantity, out of consignment quantity.

  • SHIPPED - Shipped quantity

 – –

QTY010-010

        quantityValue number Quantity of product in shipment. – – QTY010-020
        unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include: UN - Unit.

 – –

QTY010-030

    freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – K1 –
      textReferenceCode string Text reference or subject code. Will map whatever is found. – – –
      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. – – –
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level. – – –
      name string Name of mapped field. – – –
      value string Value in named field. – – –
  canonicalOceanShipmentArrivalNoticeItemDetails array Details for the canonical Ocean Shipment Arrival Notice message. – LX Loop (Mandatory) GID
    lineItemNumber string transaction set line number. – LX01 (Mandatory) –
    equipmentDetails array Shipment equipment details. – N7 Loop EQD
      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 EQD020-010
      carrierCode string Carrier code for shipper. – N712 –
      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)

EQD010 =

  • AK (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TE (TRAILER)
      equipmentTypeISOCode string Equipment type ISO code – - EQD030-010 when EQD030-030 = 5 (ISO)
      checkDigitIdentifier number Equipment check digit number, (Container check digit number). – N718 –
      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)

MEA030-010

      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

MEA020-010

      weightValue string Weight of product at delivery header level. – N703 in all other cases. N705 where weightType = TARE MEA030-020
      tareType string

Tare Qualifier Code

  • ACTUAL - Actual tare

  • MARKED - Marked tare

 –

N716 =

  • A (ACTUAL) Or

  • M (MARKED)

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

Type of volume recorded.

Valid values include:

  • BARGE - Volume of barge

  • CONTAINER - Volume of container

  • CUBICCENTIMETERS - Cubic centimeters

  • CUBICDECIMETERS - Cubic decimeters

 –

N709

–
      volumeValue Number Vessel volume for type. – N708 –
      equipmentDimensions array Dimensions off freight. – Segment N7 EQD-DIM
        dimensionsType string

Type of dimensions recorded for freight.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

– – –
        dimensionsValue Number Volume for item in inches –

  • N715 where dimensionsType = LENGTH

  • N720 where dimensionsType = HEIGHT

  • N721 where dimensionsType = WIDHT

  • DIM020-020, when dimensionsType = LENGTH

  • DIM020-030, when dimensionsType = WIDTH

  • DIM020-040, when dimensionsType = HEIGHT
        unitOfMeasure string Dimension unit of measure for parent packaging. – – DIM020-010
      itemQuantity array Equipment quantity. – segment loop LX-N7-QTY EQD - EQN
        quantityType string

Type of quantity recorded.

Valid values: No sample data available.

–

QTY01

–
        quantityValue number Quantity of product in shipment. – QTY02 EQN010-010, when EQN010-020 = 2
        unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit.

 –

QTY03

–
      equipmentSealNumbers array Shipment carrying equipments seal numbers. – M701 EQD - SEL
        sealNumber string Applied seal number for shipment carrying equipment. – M701 SEL010
        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 deparment applied seal number

  • TERMINALOPERATOR - Terminal operator applied seal number

 –

M705 =

  • CA (CARRIER) Or

  • SH (SHIPPER) Or

  • CM (CUSTOMS) Or

  • T6 (TERMINALOPERATOR)

SEL020-010 =

  • CA (CARRIER) Or

  • SH (SHIPPER) Or

  • CU (CUSTOMS) Or

  • TO (TERMINALOPERATOR)
      equipmentTypeTemperatures – Equipment type and its required temperatures – W09 –
        equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

–

W0901 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK)

EQD010 =

  • AK (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TE (TRAILER)
        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

 – –

TMP010 =

  • 1 (STORAGE) Or

  • 2 (TRANSPORT) Or

  • 3 (CARGO) Or

  • 4 (EMERGENCY) Or

  • 5 (TRANSPORTCONTROL) Or

  • 7 (TEMPERATURECORDED)
        temperatureSetpoint number Temperature value setting expressed in degrees – – TMP020-010
        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)

TMP020-020=

  • CEL (CELSIUS) Or

  • FAH (FAHRENHEIT) Or

  • KEL (KELVIN)
        rangeType string

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 – –

RMG010 =

  • 5 (TEMPERATURE) or

  • 12 (TRANSPORTTEMPERATURE)
        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

 – –

RMG020-010 =

  • CEL (CE) Or

  • FAH (FA)

  • KEL (KV)
        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 –
    oceanShipmentArrivalNoticeItemDetails array Each shipment item details such as quantity, measurement , packing and other details. – LX- L0 loop GID
      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 GID010
        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)

–
        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 –
        packagingFormatCode string

Packing form of lading quantity.

Valid values include:

  • CONTAINER - Containers

  • BARREL - Barrels

 –

L009

GID020-020

        ladingQuantity number Number of handling units of the line item tenderd to carrier. – L008 GID020-010
        description string Material used to protect lading – L010 GID020-050
        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 are:

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

–
        weightType string

Type of weight recorded.

Valid values include

  • GROSSWEIGHT

  • NETWEIGHT

– L005 –
        weightValue Number Weight of product at PO line item – L004 –
        volumeType string

Type of weight recorded.

The valid value is TOTAL.

 – L007 –
        volumeValue Number Volume for item. – L006 –
        isVerificationRequired boolean

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

  • TRUE - Yes

  • FALSE - No

 –

L015 =

  • Y (TRUE) or

  • N (FALSE)

 –
        packageVerificationFormatCode string

Packing form of counting required quantity,

Valid values include:

  • BOX - Boxes

  • CARTON - Cartons

  • PIECES - Pieces

 –

L014

–
        packageVerificationQuantity number Total number of boxes, cartons, or pieces contained on a pallet, skid, or slip sheet for the line item. – L013 –
      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). – – GID-HAN
        handlingCode string

Code specifying special transportation handling instructions.

Valid Values included:

  • CARRIER

  • DANGEROUS

  • DOMESTIC

  • EXPEDITE

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

Code indicating to which traffic a tariff applies.

Valid values are:

  • INTERSTATE

  • INTRASTATE

  • REGIONAL

  • RECIPROCAL

  • INTERNATIONAL

– – –
      itemTemperature array Temperature setting required for goods items. – – GID-TMP
        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

 – –

TMP010 =

  • 1 (STORAGE) Or

  • 2 (TRANSPORT) Or

  • 3 (CARGO) Or

  • 4 (EMERGENCY) Or

  • 5 (TRANSPORTCONTROL) Or

  • 7 (TEMPERATURECORDED)
        temperatureSetpoint number Temperature value setting expressed in degrees. – – TMP020-010
        temperatureScale string

Temperature unit of measure,

Valid values includes:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 – –

TMP020-020=

  • CEL (CELSIUS) Or

  • FAH (FAHRENHEIT) Or

  • E98 (KELVIN)
        humidityPercent integer Percent in integer format , example: 50% required, in 50. – – –
        description string Descriptive information about environment required for item. – – –
      itemTemperatureRange array Temperature range setting details required to be maintained during throughput transport for goods items. – – GID-RNG
        rangeType string

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 – –

RMG010 =

  • 5 (TEMPERATURE) or

  • 12 (TRANSPORTTEMPERATURE)
        minimumValue number Shipment minimum allowable temperature – – RMG020-020
        maximumValue number Shipment maximum allowable temperature – – RMG020-030
        unitOfMeasure string

Temperature unit of measure,

Valid values includes:

  • CE - Celsius

  • FA - Fahrenheit

 – –

RMG020-010 =

  • CEL (CE) Or

  • FAH (FA)
        description string Descriptive information about environment required for goods item. – –  
      locationDetails – Location or country details related to item in transport, such as country of origin, destination..etc – – GID-LOC
        portOrTerminalFunctionCode string

Port or Terminal function codes.

Valid values include:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of Loading

  • PORTOFDISCHARGE - Port of Discharge

  • FINALDESTINATION - Final Destination

 – –

LOC010

        oceanShipmentLocationIdentifier string Identifies the cargo's specific location. – – LOC020-010
        portName string Name of the port. – – LOC020-040
        countryCode string Country code. – – LOC030-010 (LOC030-020 = 162 (Country))
        terminalName string Terminal Name. – –  
        state string State code. – –

LOC040-010 (LOC040-020 = 169 (Country- sub entity)
      ladingItemDetails array Lading line item in terms of description, packaging, and marks and numbers. – L5 –
        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 Drung Code

  • FREIGHT - Canadian Freight

  • MOTORFREIGHT - Motor Freight Classification

  • BULK - Bulk Codes

  • QUOTA - Quota Category

  • TRADE - Standard International Trade Classification

  • TRANSPORTATION - Standard Transportation Commodity Code

  • MUTUALLYDEFINED - Mutually defined

 –

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)

 –
        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 –
      ladingItemRateCharges array Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements. – Under LX loop: Segment: L1 (Line item number of L501, L001, L101 and LX01 should match for every loop of LX). –
        lineItemNumber string Sequential line number for freight invoice item. – L101 TCC010-060
        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. – – TCC010-010
        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) MOA010-020 when MOA010-010= 128
        advancePayment number Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. – L105 (implied 2 decimal points) MOA010-020 when MOA010-010= 74
        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) MOA010-020 when MOA010-010= 113
        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 include:

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

TCC020-010 =

  • B (BASIC) or

  • C (COMMODITY) or

  • G (EXPORT) or

  • H (SUBSIDY) or

  • K (KILOGRAM) or

  • M (MINIMUM)
        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)

TCC010-050 =

  • C (COLLECT) or

  • P (PREPAID) or

  • B (THIRDPARTYPAY)
        description string Identification of special charge; this data element is used whenever an applicable code cannot be found under rate handling code. – L112 TCC010-040
        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

  • TRAIN - 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. – – TCC020-040
        itemQuantity array Shipment quantity, chargeable quantity that applies charges. – – QTY
          quantityType string

Type of quantity recorded.

Valid values include.

  • CHARGEABLEWEIGHT - Chargeable weight quantity, out of consignment quantity.

  • SHIPPED - Shipped quantity

 – –

QTY010-010

          quantityValue number Quantity of product in shipment. – – QTY010-020
          unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include: UN = Unit.

 – –

QTY010-030

      tariffReferenceInformation array Freight tariff reference details of the tariff used to arrive at applicable rates or charge. – Under LX loop: Segment: L7 (Line item number of L501, L001, L701, L101 and LX01 should match for every loop of LX) –
        lineItemNumber string Sequential line number for freight invoice item. – – –
        tariffAgencyCode string Tariff defining agency code. – – –
        tariffIdentifier string Standard tariff number for the tariff which governs the rates applied to the commodity item(s). – – –
        tariffSectionIdentifier string Number used as an extension of the basic tariff number to identify the rates published within specific sections of the tariff. – – –
        tariffItemIdentifier string Number assigned in the tariff to specific rate or group of rates that applies to one or more items in the shipment. – – –
        freightClassCode number Code indicating generalized classification that applies to one or more items in the shipment. – – –
    transactionReferenceIdentifierList array List of documents and transactions at the header level of the message (Do not have sample data, kept this based on 315 sample data). – – group 23 - RFF
      b2bTransactionIdentifierType string

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

Valid values include:

  • SHIPMENT - Shipper's identifier for the shipment

  • DELIVERY - Delivery order number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • INVOICE - Seller invoice number

  • MASTERBOL - Master BOL

  • SEALNUMBER - Seal number

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDERIDENTIFIER - Conginees order number

  • PRICEQUOTEIDENTIFIER - Price quote number

 – – –
      b2bTransactionIdentifierValue string Transaction reference identifier value defined by enum in transactionReferenceType defined by transaction reference type. – – –
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionDate string Transaction reference date and time, if time available, in epoch date format – – –
      lineItemNumber integer Transaction reference date and time in EPOCH date time format. – – –
    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.(Do not have sample data, kept this based on 315 sample data)

 – – group 23 - RFF
      transactionReferenceType string

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

Valid values include:

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • CUSTOM - Mutually defined reference number

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

 – –

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

  • SRN (CARRIERASSIGNEDSHIPPERIDENTIFIER) Or

  • SD (SALESDEPARTMENT)
      transactionReferenceIdentifier string Transaction reference identifier value. – – RFF010-020
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –
      transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
    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 Arrival 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. – – FTX
      textReferenceCode string Text reference or subject code. Will map whatever is found. – – FTX030-010
      textFunctionCode string Text function code. Will map whatever is found. – – FTX020
      language string Language of free text. – – FTX050
      textFormatCode string Format code for free text. – – FTX060
      freeText string Free test string. – – FTX040-010
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. – – –
      name string Name of mapped field. – – –
      value string Value in named field. – – –
  canonicalOceanShipmentArrivalNoticeShipmentEventDetails array To report events occurred during ocean, rail, air shipments. – V9 –
    shipmentEventType string

Code to specify type of the ocean shipment event.

Valid values include:

  • ANTICIPATEDPICKUP - Anticipated Pickup

  • VESSELARRIVAL - Vessel Arrival

  • VESSELDEPARTURE - Vessel Departure

  • UNLOADEDFROMVESSEL - Unloaded From Vessel

  • LOADEDONVESSEL - Actually Loaded on Vessel

  • FINALDESTINATIONACTUALARRIVALDATE - Actual Arrival Date at Final Destination

 –

V901 =

  • APU (Anticipated Pickup) Or

  • VAR (Vessel Arrival) Or

  • VDP (Vessel Departure) Or

  • UFV (Unloaded From Vessel) Or

  • ALV (Actually Loaded on Vessel) Or

  • ARD (Actual Arrival Date at Final Destination)

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

Reason indicating why a shipment status code was transmitted.

Valid values included:

  • 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

  • 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 adjournment 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. – – –
  canonicalOceanShipmentArrivalNoticeWeightChargesSummary – Describes the total shipment in terms of weight, volume, rates, charges, advances, and prepaid amounts applicable to one or more line items. – Segment L3 (weight and charges summary) –
    weightType string

Type of weight recorded.

Valid values include:

  • GROSSWEIGHT

  • NETWEIGHT

  • TARE

– L302 use lookup table: CL_WeightType.txt –
    weightValue number Weight of product at PO line item – L301 –
    freightRate number 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 =

  • 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(implied 2 decimal points) –
    advancePayment number Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. – L306(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. – L307(implied 2 decimal points) –
    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)

–
    volumeType string

Total Volume recorded.

The valid values include TOTAL.

 – L310 –
    volumeValue number Value of total volumetric measure of shipment. – L309 –
    quantityType string

Quantity type.

The valid value is LADING.

 – – –
    quantityValue number Total number of units in shipment. – L311 –
    tariffIdentifier string Standard tariff number for the tariff which governs the rates applied to the commodity item(s). – L313 –
    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)

–
  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