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,
Motor carrier load tender canonical guidelines
The Motor Carrier Load Tender is an electronic transaction used by a shipper or third-party logistics provider (3PL) to offer a shipment to a motor carrier for transportation. This message communicates all required shipment details so the carrier can evaluate and respond to the load.
| 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. | – | – | – | |||||||
| canonicalMotorCarrierLoadTenderHeader | – | Header details for motor carrier load tender. | – | Segment B2 and B2A | – | |||||||
| processingFunctionTypeCode | string |
Processing function, transaction set purpose code. Valid values include:
|
– | B2A01 | – | |||||||
| loadTenderType | string |
It defines the business context or classification of the load tender. Valid values:
|
– |
B2A02 =
|
– | |||||||
| servicesTariffCode | string |
Types of services rendered for this shipment and respective charges billed by the carrier. Valid values include:
|
– |
B201 =
|
– | |||||||
| carrierCode | string | Shipping carrier standard alpha code (SCAC). | – | B202 | – | |||||||
| locationIdentifier | string | Standard point location code (SPLC) used for rate making. | – | B203 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
B205 =
|
– | |||||||
| shipmentChargePaymentMethodType | string |
Method of payment for shipment. Valid values inlcude:
|
– |
B206 =
|
– | |||||||
| 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:
|
– | B207 | – | |||||||
| equipmentQuantity | number | Total number of equipments used in this transaction | – | B208 | – | |||||||
| transportTradeTerms | string |
Describes the trade terms which apply to the shipment transportation responsibility. It also helps to describe the party responsible for making payment. Valid values are:
|
– |
B211 =
|
– | |||||||
| paymentMethod | string |
Method of payment. Valid values include:
|
– |
B212 =
|
– | |||||||
| transactionReferenceIdentifierList | array | List of documents and transactions at the header level of the message | – | Segment L11 & B2 | – | |||||||
| b2bTransactionIdentifierType | string |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| b2bTransactionIdentifierValue | string | Transaction reference identifier value. | – | B204 when b2bTransactionIdentifierType =BOL & MOTORCARRIERLOADTENDER L1101 for remaining qualifiers in b2bTransactionIdentifierType | – | |||||||
| transactionDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | ISA09&10 if empty L1104 for remaining qualifiers in b2bTransactionIdentifierType | – | |||||||
| epochTransactionDate | string | Transaction reference date and time, if time available, in epoch date format. | – | – | – | |||||||
| lineItemNumber | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| transactionReferenceInformation | array | Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF, L11 and N9 and EDIFACT RFF for information other than transaction documents. | – | Segment L11 | – | |||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value. | – | L1101 | – | |||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | L1103 | – | |||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | L1104 | – | |||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| mpcCurrency | – | Currency for motor carrier load tender. | – | segment C3 | – | |||||||
| currencyCode | string | Currency Code. | – | C301 | – | |||||||
| exchangeRateCurrencyCode | string | Exchange Rate Currency Code. | – | – | – | |||||||
| exchangeRate | string | Exchange Rate. | – | C302 | – | |||||||
| validityRate | string | Validity Date. | – | – | – | |||||||
| currencyEntityCode | string | Currency Entity Code. | – | C303 | – | |||||||
| mpcDates | – | Dates relevant for Motor carrier load tender at header. | – | Segment G62 | – | |||||||
| dateType | string |
Date type at header level for shipping instructions in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– | G6201 | – | |||||||
| 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. | – | G6202 | – | |||||||
| epochDateValue | integer | Date defined by referenced date type generated in epoch integer date format. | – | – | – | |||||||
| dateTimePeriodFormat | string |
Code specifiying representation of date or time or format presented in date value. Valid values include:
|
– | – | – | |||||||
| timeZone | string | Time zone for referenced dates. | – | G6205 | – | |||||||
| eventTimeType | string | Event Time Type. | – | G6203 | – | |||||||
| carrierSequenceInformation | – | Carrier sequence information for shipment. Records cit and state or province location for each carrier used for shipment. | – | Segment MS3 - interline info | – | |||||||
| carrierCode | string | Shipping carrier alpha code (SCAC). | – | MS301 | – | |||||||
| carrierSequenceCode | string |
Code identifying sequence of carriers in shipment, beginning with the original carrier. Valid values include:
|
– | MS302 | – | |||||||
| transportMethod | string |
Transport method type. Valid values include:
|
– | MS304 | – | |||||||
| city | string | City name for the shipment's current carrier sequence. | – | MS303 | – | |||||||
| state | state | Name of state or province for the shipment's current carrier sequence. | – | MS305 | – | |||||||
| ladingItemHandlingInformation | array | Bill of lading handling instructions for shipment. All parameters to be understood in the form of different codes used by industry, | – | Segment AT5 | – | |||||||
| handlingCode | string |
Code specifying special transportation handling instructions. Valid Values are:
|
– |
AT501 =
|
– | |||||||
| protectiveServiceCode | string | To specify perishable protective service - rail carriers only. | – | AT502 | – | |||||||
| description | string | Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. | – | AT503 | – | |||||||
| temperatureScale | string |
Temperature unit of measure, Valid values:
|
– |
AT504 =
|
– | |||||||
| minTemperatureValue | Number | – | – | AT505 | – | |||||||
| maxTemperatureValue | Number | It describes maximum temperature. | – | AT506 | – | |||||||
| mpcCurrency | – | Currency for motor carrier load tender. | – | segment C3 under AT5 loop | – | |||||||
| currencyCode | string | Currency Code. | – | C301 | – | |||||||
| exchangeRateCurrencyCode | string | Exchange Rate Currency Code. | – | – | – | |||||||
| exchangeRate | string | Exchange Rate. | – | C302 | – | |||||||
| validityRate | string | Validity Date. | – | – | ||||||||
| currencyEntityCode | string | Currency Entity Code. | – | C303 | – | |||||||
| dangerousGoodsCertificateInformation | array | To specify the name of the person certifying that the shipment complies with the regulations and/or the actual certification. | – | Segment LH6 | – | |||||||
| certificateApproverAuthority | string | Free-form name of the person or organization approved the certificate. | – | LH601 | – | |||||||
| dangerousGoodsCertificateType | string |
To specify the form of the hazardous certification. Valid values are:
|
– |
LH602 =
|
– | |||||||
| description | string | Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. | – | LH603 | – | |||||||
| shipmentPallet | It specifies pallet information including quantity, exchange, and weight. | – | Segment PLD | – | ||||||||
| shippedPalletQuantity | Number | Number of pallets shipped. | – | PLD01 | – | |||||||
| palletExchangeType | string |
It specifies pallet exchange instructions. Valid values include:
|
– |
PLD02 =
|
– | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
PLD03 =
|
– | |||||||
| weightType | string |
Type of weight recorded in shipment. Valid values include:
|
– | – | – | |||||||
| weightValue | string | Weight of shipped pallet at header level. | – | PLD04 | – | |||||||
| loadTenderHeaderEquipmentInformation | array | Shipment equipment details. | – | Segment N7 | – | |||||||
| 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 | – | |||||||
| carrierCode | string | Carrier code for shipper. | – | N712 | – | |||||||
| shipmentFlashPoint | string | Free-form abbreviation of temperature range or flash-point temperature. | – | N713 | – | |||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values include:
|
– |
N711 =
|
– | |||||||
| equipmentTypeISOCode | string | Equipment type ISO code. | – | – | – | |||||||
| checkDigitIdentifier | number | Equipment check digit number, (Container check digit number). | – | N718 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
N717 =
|
– | |||||||
| weightType | string |
Type of weight recorded in shipment. Valid values include:
|
– | N704 | – | |||||||
| weightValue | string | Weight of product at delivery header level | – | N703 in all other cases. N705 where weightType = TARE | – | |||||||
| tareType | string |
Tare Qualifier Code
|
– |
N716 =
|
– | |||||||
| tareWeight | number | Tare weight of equipment | – | N705 | – | |||||||
| volumeType | string |
Type of volume recorded. Valid values include:
|
– | N709 | – | |||||||
| volumeValue | Number | Vessel volume for type. | – | N708 | – | |||||||
| equipmentDimensions | array | Dimensions of freight. | – | Segment N7 | – | |||||||
| dimensionsType | string |
Type of dimensions recorded for freight. Valid values include:
|
– | – | – | |||||||
| dimensionsValue | Number | Volume for item in inches. | – | N715where dimensionsType = LENGTH N720 where dimensionsType = HEIGHT N721 where dimensionsType = WIDHT | – | |||||||
| unitOfMeasure | string | Dimension unit of measure for parent packaging. | – | – | – | |||||||
| itemQuantity | array | Equipment quantity. | – | – | – | |||||||
| quantityType | string |
Type of quantity recorded. Valid values: No sample data available. |
– | – | – | |||||||
| quantityValue | number | Quantity of product in shipment. | – | – | – | |||||||
| unitOfMeasure | string |
Unit or Basis for Measurement Code. Unit of entry UOM's include:
|
– | – | ||||||||
| equipmentSealNumbers | array | Shipment carrying equipments seal numbers. | – | Segment M7 (under N7 loop) | – | |||||||
| sealNumber | string | Applied seal number for shipment carrying equipment. | – | M701, M702, M703, M704 | – | |||||||
| sealAppliedEntityType | string |
Seal applied entity type code, it could be an organization or location or an individual. Valid values include:
|
– |
M705 =
|
– | |||||||
| shipmentMeasurements | Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. | – | segment MEA in N7 loop | – | ||||||||
| measurementCategory | string |
Broad category of measurement to which measurement type belongs to or applies. Valid values include:
|
– |
MEA01 =
|
– | |||||||
| measurementType | string |
Code identifying a measurement type for a measurement value. Valid values includes:
|
– |
MEA02 =
|
– | |||||||
| measurementValue | string | The value of the measurement. | – | MEA03 | – | |||||||
| unitOfMeasure | string |
Unit of measure for the measurement type and value recorded. Valid values includes:
|
– | MEA04 | – | |||||||
| measuredType | string |
Code identifying a measured type for a measured value. Valid values include:
|
– | – | ||||||||
| partnerEntityBusinessInformation | array | Partner Entity group location identifiers and address information. | – | N1 | – | |||||||
| partnerEntityType | string |
Explains the type of the partner entity involved in this business transaction. Valid values include:
|
– | N101 | – | |||||||
| businessName | string | Business name for partner or location. | – | N102 | – | |||||||
| additionalBusinessName | string | Additional Business name for partner or location. | – | – | – | |||||||
| companyLocationPartnerName | string | Additional Location of same Business partner. | – | – | – | |||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | |||||||
| companyIdentifierType | string | Company identifier type for business partner. | – |
N103 = 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) N103 = 93 (TRANSACTION_SET_SENDER) or N103 = 94 (TRANSACTION_SET_RECEIVER) or N103 = FA (FACILITY_IDENTIFIER) or N103 = 20 (STANDARD_POINT_LOCATION_CODE) or N103 = ZZ (CUSTOM) N103 = 97 (RECEIVER CODE) |
– | |||||||
| companyIdentifierValue | string | Company identifier value for business partner. | – | N104 | – | |||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | |||||||
| address | – | Party address information. | – | N3, N4, | – | |||||||
| address1 | string | Main street address. | – | N301 | – | |||||||
| address2 | string | Supplemental street address. | – | N302 | – | |||||||
| city | string | City | – | N401 | – | |||||||
| district | string | District | – | – | ||||||||
| state | string | State or region code. | – | N402 | – | |||||||
| postalCode | string | Postal code | – | N403 | – | |||||||
| country | string | Country code | – | N404 | – | |||||||
| telephone | string | Telephone number | – | – | – | |||||||
| fax | string | Fax number | – | – | – | |||||||
| url | string | Website URL | – | – | – | |||||||
| buildingNumber | string | Building number | – | – | – | |||||||
| plantNumber | string | Plant number | – | – | – | |||||||
| floorNumber | string | Floor number in building | – | – | – | |||||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||||
| village | string | Village name | – | – | – | |||||||
| houseNumber | string | House number | – | – | – | |||||||
| township | string | Township | – | – | – | |||||||
| premisesCode | string | Premises code | – | – | – | |||||||
| companyLocationContactInformation | – | – | – | N1- G61 | – | |||||||
| contactType | string |
Contact type. Valid values include:
|
– |
G6101 =
|
– | |||||||
| contactName | string | Contact name. | – | G6102 | – | |||||||
| contactTitle | string | Title of contact. | – | – | – | |||||||
| contactPhone | string | Contact phone number. | – | G6104 where G6103 = "TE" | – | |||||||
| contactEmail | string | Contact email address. | – | G6104 where G6103 = "EM" | – | |||||||
| mpcAdditionalAddressInformation | Additional address information that is not included in addressTypeDefinition. | – | – | – | ||||||||
| externalERPUserName | string | External ERP system user name for user who generated message. | – | – | – | |||||||
| organizationCode | string | Code for organization responsible for generating the message. | – | – | – | |||||||
| organizationDescription | string | Description of the organization responsible for generating the message. | – | – | – | |||||||
| groupCode | string | Code identifying group responsible for generating the message. | – | – | – | |||||||
| language | string | Language key for message. | – | – | – | |||||||
| languageCode | string | ISO language code for message. | – | – | – | |||||||
| referenceIdentifier | string | Partner reference identifier. | – | – | – | |||||||
| orderType | string | Order Type. | – | – | – | |||||||
| address3 | string | Additional address information that is not included in addressTypeDefinition. | – | – | – | |||||||
| postalArea | string | Postal Area. | – | – | – | |||||||
| timeZone | string | Time zone for referenced dates. | – | – | – | |||||||
| telephone | string | Telephone Number. | – | – | – | |||||||
| emailAddress | string | Email Address. | – | – | – | |||||||
| vatRegistrationNumber | string | Vat Registration Number. | – | – | – | |||||||
| taxExemptCode | string | Tax exempt Code. | – | – | – | |||||||
| locationType | string | Business Partner Location Type. | – | – | – | |||||||
| locationIdentifier | string | Business Partner location Identifier. | – | – | – | |||||||
| countrySubDivisionCode | string | Describes the country subdivision. | – | – | – | |||||||
| transactionReferenceInformation | array | Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF, L11 and N9 and EDIFACT RFF for information other than transaction documents. | – | Segment L11 under n1 Loop | – | |||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value. | – | L1101 | – | |||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | L1103 | – | |||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | L1104 | – | |||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| mpcDates | Dates relevant for Motor carrier load tender at header. | – | – | – | ||||||||
| dateType | string |
Date type at header level for shipping instructions in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– | – | – | |||||||
| 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. | – | – | – | |||||||
| dateTimePeriodFormat | string |
Code specifiying representation of date or time or format presented in date value, Valid values include:
|
– | – | – | |||||||
| timeZone | string | Time zone for referenced dates | – | – | – | |||||||
| freeTextNote | array | Ship to party company identifiers and address information. | – | Segment NTE | – | |||||||
| textReferenceCode | string | Text reference or subject code. | – | NTE01 | – | |||||||
| textFunctionCode | string | Text function code. | – | – | – | |||||||
| language | string | Language of free text. | – | – | – | |||||||
| textFormatCode | string | Format code for free text. | – | – | – | |||||||
| freeFormText | string | Free text string. | – | NTE02 | – | |||||||
| 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. | – | – | – | |||||||
| canonicalMotorCarrierLoadTenderItemDetails | array | Line item details for motor carrier load tender. | – | Line item Details for motor carrier load tender | – | |||||||
| lineItemNumber | string | Motor carrier load tender transaction set line number. | – | LX01 | – | |||||||
| shipmentDimensions | array | Dimensions of freight. | – | Segment LX - L4 | – | |||||||
| dimensionsType | string |
Type of dimensions recorded for freight. Valid values include:
|
– | – | – | |||||||
| dimensionsValue | Number | Volume for item in inches. | – | L401, when dimensionsType = LENGTH L402, when dimensionsType = WIDTH L403, when dimensionsType = HEIGHT | – | |||||||
| shipmentDimensionsUnitType | string |
Dimensions unit for shipment to be booked. Valid Values are:
|
– |
L404 =
|
– | |||||||
| dimensionsQuantity | number | Quantity of dimensions in shipment booking. | – | L405 | – | |||||||
| logisticsStopPointInformation | array | To understand specific reason behind Motor carrier stop-off detail, their reference numbers and stop reason. | – | S5 loop starts | – | |||||||
| stopPointSequenceCode | string |
Code identifying sequence of carriers stop in shipment, beginning with the original carrier. It identifies number for the specific stop and the sequence in which the stop is to be performed. Valid values include:
|
– |
S501 It is a incremental value based on different stop point.
|
– | |||||||
| stopReasonCode | string |
Code identifying the reason of a carriers at stop point. Valid values include:
|
– |
S502=
|
– | |||||||
| quantityType | string | Type of quantity recorded.
Valid value UNIT. |
– | – | ||||||||
| quantityValue | string | Quantity of product at delivery header level. | – | S505 where quantityType = UNIT | – | |||||||
| quantityUOM | string | Quantity unit of measure in master data for product. | – | S506 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
S504 =
|
– | |||||||
| weightValue | string | Weight of product at delivery header level. | – | S503 | – | |||||||
| volumeType | string |
Type of weight recorded. Valid values include:
|
– |
S508 =
|
– | |||||||
| volumeValue | Number | Volume for delivery. | – | S507 | – | |||||||
| description | string | A free-form description to clarify the related data elements and their content. | – | S509 | – | |||||||
| actionStatus | boolean |
To indicate the status of a specified stop. Valid values:
|
– |
S511 =
|
– | |||||||
| transactionReferenceIdentifierList | array | List of documents and transactions at the header level of the message. | – | Segment L11 under S5 loop | – | |||||||
| b2bTransactionIdentifierType | – |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| b2bTransactionIdentifierValue | string | Transaction reference identifier value. | – | L1101 | – | |||||||
| transactionDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | L1104 | – | |||||||
| epochTransactionDate | string | Transaction reference date and time, if time available, in epoch date format. | – | – | – | |||||||
| lineItemNumber | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| transactionReferenceInformation | array | Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF, L11 and N9 and EDIFACT RFF for information other than transaction documents. | – | Segment L11 under S5 loop | – | |||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value. | – | L1101 | – | |||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | L1103 | – | |||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | L1104 | – | |||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| mpcDates | array | Dates relevant for Motor carrier load tender at header. | – | Segment S5 - G62 | – | |||||||
| dateType | string |
Date type at header level for shipping instructions in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– | G6201 | – | |||||||
| 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. | – | G6202 | – | |||||||
| epochDateValue | integer | Date defined by referenced date type generated in epoch integer date format. | – | – | – | |||||||
| eventTimeType | string |
Date type at header level for shipping instructions in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– | G6201 | – | |||||||
| dateTimePeriodFormat | string |
Code specifiying representation of date or time or format presented in date value. Valid values include:
|
– | – | – | |||||||
| timeZone | string | Time zone for referenced dates. | – | G6205 | – | |||||||
| shipmentMeasurements | Consolidated segment with weights, quantities and volume for the shipment. | – | Segment S5 - AT8 | – | ||||||||
| weightType | string |
Type of weight recorded in shipment. Valid values include:
|
– | AT801 | – | |||||||
| weightValue | string | Weight of product at delivery header level. | – | AT803 | – | |||||||
| weightUOM | string | Weight unit of measure in
master data for product. Valid value LB
- KG. |
– | – | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– | AT802 | – | |||||||
| quantityType | string |
Type of quantity recorded. Valid value
|
– | – | – | |||||||
| quantityValue | string | Quantity of product at delivery header level. | – | AT804 where quantityType = LADING | – | |||||||
| quantityUOM | string | Quantity unit of measure in master data for product. | – | – | ||||||||
| volumeType | string |
Type of weight recorded. Valid values include:
|
– | AT806 | – | |||||||
| volumeValue | string | Volume for delivery. | – | AT807 | – | |||||||
| volumeUOM | string | Volume unit of measure. | – | – | – | |||||||
| ladingQuantity | Number | It describes the quantity of handling units that are unitized. | – | AT805 | – | |||||||
| additionalLadingItemInformation | array | To record or transmit detailed lading data pertinent to a pickup or delivery. | – | Segment S5 - LAD | – | |||||||
| packagingFormatCode | string | Packing form of lading quantity. | – | LAD01 | – | |||||||
| ladingQuantity | Number | Number of units (pieces) of the lading commodity. | – | LAD02 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– | LAD05 | – | |||||||
| weightValue | string | Weight of product at line item level. | – | LAD06 | – | |||||||
| shipmentUnitWeight | string | Unit weight of shipment at line item level. | – | LAD04 | – | |||||||
| description | string | Description of an item as required for rating and billing purposes. | – | LAD13 | – | |||||||
| weightType | string | Weight type for inner containers or bundles, or the number of eaches if there are no inner containers or bundles, per outer container. | – | – | – | |||||||
| ladingItemCodeIdentifiers | array | Product code identifiers for all other product types. | – | Product code qualifer followed by identifiers are represented in pairs from LAD07 & LAD08 through LAD11 & LAD12.. If qualifier is present, then identifier is required. | – | |||||||
| productCodeType | String |
Code to qualify product identifier type:
|
– |
LAD07 =
|
– | |||||||
| productCodeValue | string | Product code identifier value. | – | LAD08 | – | |||||||
| ladingItemHandlingInformation | array | Bill of lading handling instructions for shipment. All parameters to be understood in the form of different codes used by industry, | – | Segment S5 - AT5 | – | |||||||
| handlingCode | string |
Code specifying special transportation handling instructions. Valid Values are:
|
– |
AT501 =
|
– | |||||||
| protectiveServiceCode | string | To specify perishable protective service - rail carriers only. | – | AT502 | – | |||||||
| description | string | Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. | – | AT503 | – | |||||||
| temperatureScale | string |
Temperature unit of measure. Valid values:
|
– |
AT504 =
|
– | |||||||
| minTemperatureValue | Number | It describes minimum temperature. | – | AT505 | – | |||||||
| maxTemperatureValue | Number | It describes maximum temperature. | – | AT506 | – | |||||||
| shipmentPallet | It specifies pallet information including quantity, exchange, and weight. | – | Segment S5 - PLD | – | ||||||||
| shippedPalletQuantity | Number | Number of pallets shipped. | – | PLD01 | – | |||||||
| palletExchangeType | string |
It specifies pallet exchange instructions. Valid values include:
|
– |
PLD02 =
|
– | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
PLD03 =
|
– | |||||||
| weightType | string |
Type of weight recorded in shipment. Valid values include:
|
– | – | – | |||||||
| weightValue | string | Weight of shipped pallet at header level | – | PLD04 | – | |||||||
| partnerEntityBusinessInformation | – | Partner Entity group location identifiers and address information. | – | N1 under S5 loop | – | |||||||
| partnerEntityType | string |
Explains the type of the partner entity involved in this business transaction. Valid values include:
|
– | N101 | – | |||||||
| businessName | string | Business name for partner or location. | – | N102 | – | |||||||
| additionalBusinessName | string | Additional Business name for partner or location. | – | – | – | |||||||
| companyLocationPartnerName | string | Additional Location of same Business partner. | – | – | – | |||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | |||||||
| companyIdentifierType | string | Company identifier type for business partner. | – |
N103 = 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) N103 = 93 (TRANSACTION_SET_SENDER) or N103 = 94 (TRANSACTION_SET_RECEIVER) or N103 = FA (FACILITY_IDENTIFIER) or N103 = 20 (STANDARD_POINT_LOCATION_CODE) or N103 = ZZ (CUSTOM) |
– | |||||||
| companyIdentifierValue | string | Company identifier value for business partner. | – | N104 | – | |||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | |||||||
| address | – | Party address information. | – | N3, N4, | – | |||||||
| address1 | string | Main street address. | – | N301 | – | |||||||
| address2 | string | Supplemental street address. | – | N302 | – | |||||||
| city | string | City | – | N401 | – | |||||||
| district | string | District | – | – | – | |||||||
| state | string | State or region code | – | N402 | – | |||||||
| postalCode | string | Postal code | – | N403 | – | |||||||
| country | string | Country code | – | N404 | – | |||||||
| telephone | string | Telephone number | – | – | – | |||||||
| fax | string | Fax number | – | – | – | |||||||
| url | string | Website URL | – | – | – | |||||||
| buildingNumber | string | Building number | – | – | – | |||||||
| plantNumber | string | Plant number | – | – | – | |||||||
| floorNumber | string | Floor number in building. | – | – | – | |||||||
| lscAddressIdentifier | string | LSC address identifier. | – | – | – | |||||||
| village | string | Village name | – | – | – | |||||||
| houseNumber | string | House number | – | – | – | |||||||
| township | string | Township | – | – | – | |||||||
| premisesCode | string | Premises code | – | – | – | |||||||
| companyLocationContactInformation | – | – | – | N1- G61 under S5 Loop | – | |||||||
| contactType | string |
Contact type. Valid values include:
|
– |
G6101 =
|
– | |||||||
| contactName | string | Contact name. | – | G6102 | – | |||||||
| contactTitle | string | Title of contact. | – | – | – | |||||||
| contactPhone | string | Contact phone number. | – | G6104 where G6103 = "TE" | – | |||||||
| contactEmail | string | Contact email address. | – | G6104 where G6103 = "EM" | – | |||||||
| mpcAdditionalAddressInformation | – | Additional address information that is not included in addressTypeDefinition. | – | – | – | |||||||
| externalERPUserName | string | External ERP system user name for user who generated message. | – | – | – | |||||||
| organizationCode | string | Code for organization responsible for generating the message. | – | – | – | |||||||
| organizationDescription | string | Description of the organization responsible for generating the message. | – | – | – | |||||||
| groupCode | string | Code identifying group responsible for generating the message. | – | – | – | |||||||
| language | string | Language key for message. | – | – | – | |||||||
| languageCode | string | ISO language code for message. | – | – | – | |||||||
| referenceIdentifier | string | Partner reference identifier. | – | – | – | |||||||
| orderType | string | Order Type. | – | – | – | |||||||
| address3 | string | Additional address information that is not included in addressTypeDefinition. | – | – | – | |||||||
| postalArea | string | Postal Area. | – | – | – | |||||||
| timeZone | string | Time zone for referenced dates. | – | – | – | |||||||
| telephone | string | Telephone Number. | – | – | – | |||||||
| emailAddress | string | Email Address. | – | – | – | |||||||
| vatRegistrationNumber | string | Vat Registration Number. | – | – | – | |||||||
| taxExemptCode | string | Tax exempt Code. | – | – | – | |||||||
| locationType | string | Business Partner Location Type. | – | N405 | – | |||||||
| locationIdentifier | string | Business Partner location Identifier. | – | N406 | – | |||||||
| countrySubDivisionCode | string | Describes the country subdivision. | – | N407 | – | |||||||
| loadTenderItemDetails | array | Lading line item in terms of description, packaging, and marks and numbers. | – | Segment L5 under S5 loop | – | |||||||
| lineItemNumber | number | Sequential line number for a lading item. | – | L501 | – | |||||||
| description | string | Description of an item as required for rating and billing purposes. | – | L502 | – | |||||||
| commodityCode | string | Describes about a commodity or group of commodities. | – | L503 | – | |||||||
| commoditySystemType | string |
Describes the commodity coding system used for Commodity Code. Valid values included:
|
– |
L504=
|
– | |||||||
| packagingFormatMaterialType | string |
Code identifying type of material used. Valid values included :
|
– |
L505 =
|
– | |||||||
| packagingIdentifierType | string | Packaging identifier type. Pass thru mapping for X12. | – | L507 | – | |||||||
| packagingIdentifier | string | Packaging identifier value defined by the packaging type. | – | L506 | – | |||||||
| shipmentMeasurements | array | Consolidated segment with weights, quantities and valumes for the shipment. | – | Segment S5 - L5 - AT8 | – | |||||||
| weightType | string |
Type of weight recorded in shipment. Valid values include:
|
– | AT801 | – | |||||||
| weightValue | string | Weight of product at delivery header level. | – | AT803 | – | |||||||
| weightUOM | string | Weight unit of measure in
master data for product. Valid values LB
- KG. |
– | – | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– | AT802 | – | |||||||
| quantityType | string |
Type of quantity recorded. Valid value:
|
– | – | – | |||||||
| quantityValue | string | Quantity of product at delivery header level. | – | AT804 where quantityType = LADING | – | |||||||
| quantityUOM | string | Quantity unit of measure in master data for product. | – | – | – | |||||||
| volumeType | string |
Type of weight recorded. Valid values include:
|
– | AT806 | – | |||||||
| volumeValue | string | Volume for delivery. | AT807 | |||||||||
| volumeUOM | string | Volume unit of measure. | – | – | – | |||||||
| ladingQuantity | Number | It describes the quantity of handling units that are unitized. | – | AT805 | – | |||||||
| shipmentDimensions | array | Dimensions of freight. | – | Segment S5 - L5 - L4 | – | |||||||
| dimensionsType | string |
Type of dimensions recorded for freight. Valid values include:
|
– | – | – | |||||||
| dimensionsValue | Number | Volume for item in inches. | – | L401, when dimensionsType = LENGTH L402, when dimensionsType = WIDTH L403, when dimensionsType = HEIGHT | – | |||||||
| shipmentDimensionsUnitType | string |
Dimensions unit for shipment to be booked. Valid Values are:
|
– |
L404 =
|
– | |||||||
| dimensionsQuantity | number | Quantity of dimensions in shipment booking. | – | L405 | – | |||||||
| ladingItemDangerousGoodsContactInformation | array | Lading item information with party contact, document reference and dangerous goods information. | – | Segment S5 - L5 - G61 | – | |||||||
| contactType | string |
Contact type. Valid values include:
|
– |
G6101 =
|
– | |||||||
| contactName | string |
Contact name. |
– | G6102 | – | |||||||
| contactTitle | string | Title of contact. | – | – | – | |||||||
| contactPhone | string | Contact phone number | – | G6104 where G6103 = "TE" | – | |||||||
| contactEmail | string | Contact email address | – | G6104 where G6103 = "EM" | – | |||||||
| transactionReferenceIdentifierList | array | List of documents and transactions at the header level of the message | – | Segment S5 - L5 - G61 - L11 | – | |||||||
| b2bTransactionIdentifierType | – |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| b2bTransactionIdentifierValue | string | Transaction reference identifier value. | – | L1101 | – | |||||||
| transactionDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | L1104 | – | |||||||
| epochTransactionDate | string | Transaction reference date and time, if time available, in epoch date format. | – | – | – | |||||||
| lineItemNumber | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| transactionReferenceInformation | array | Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF, L11 and N9 and EDIFACT RFF for information other than transaction documents. | – | Segment S5 - L5 - G61 - L11 | – | |||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
L1102 =
|
– | |||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value. | – | L1101 | – | |||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | L1103 | – | |||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | L1104 | – | |||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||||
| dangerousGoodsCertificateInformation | array | To specify the name of the person certifying that the shipment complies with the regulations and/or the actual certification. | – | Segment S5 - L5 - G61 - LH6 | – | |||||||
| certificateApproverAuthority | string | Free-form name of the person or organization approved the certificate. | – | LH601 | – | |||||||
| dangerousGoodsCertificateType | string |
To specify the form of the hazardous certification. Valid values are:
|
– |
LH602 =
|
– | |||||||
| description | string | Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. | – | LH603 | – | |||||||
| dangerousGoodsIdentifiers | array | It describes the hazardous commodity identification reference number and quantity. | – | Segment S5 - L5 - G61 - LH1 Loop | – | |||||||
| lineItemNumber | number | Sequential line number for a lading item. | – | – | – | |||||||
| unitOfMeasure | string | Unit of measure for dangerous goods identification. | – | LH101 | – | |||||||
| ladingQuantity | Number | Number of units (pieces) of the lading commodity. | – | LH102 | – | |||||||
| hazardousMaterialIndex | string | The United Nations page number as required for the international transport of hazardous materials. | – | LH104 | – | |||||||
| hazardousGoodsCommodityCode | string | Code describing a commodity or group of commodities. | – | LH105 | – | |||||||
| dangerousGoodsQuantityValue | number | Quantity of product at line item level for dangerous goods. | – | LH107 | – | |||||||
| residueIndicatorType | string |
Types of residue indicator. Valid values:
|
– |
LH109 =
|
– | |||||||
| packagingGroup | string | Dangerous goods packaging group in terms of Roman number I, II or III. | – | LH110 | – | |||||||
| dangerousMaterialRegulatoryIdentifier | string | Identifies the current regulatory version number used for hazardous materials shipments. | – | LH111 | – | |||||||
| dangerousGoodsEndorsementInformation | array | LH2 segment describes about hazardous material notation and endorsement. | – | Segment S5 - L5 - G61 - LH1 Loop - LH2 | – | |||||||
| dangerousGoodsClassCode | string | Dangerous goods identifier. | – | LH201 | – | |||||||
| dangerousGoodsClassification | string |
Describes the hazardous material class. Valid Values :
|
– |
LH202 =
|
– | |||||||
| reportableSubstanceQuantityCode | string | To capture the presence of hazardous substance quantity code for quick action in case of emergency. | – | LH205 | – | |||||||
| unitOfMeasure | string | Unit of measure for dangerous goods identification. | – | LH206 | – | |||||||
| shipmentFlashPoint | string | Indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” | – | LH207 | – | |||||||
| shipmentControlTemperature | string | Indicating the controlled temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” | – | LH209 | – | |||||||
| shipmentEmergencyTemperature | string | Indicating the maximum emergency temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” | – | LH211 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
LH212 =
|
– | |||||||
| explosiveWeight | Number | Net weight of the explosive quantity of the hazardous commodity. | – | LH213 | – | |||||||
| additionalDangerousGoodsInformation | array | Additional Dangerous Goods information to be considered while specifying shipment instructions. | – | Segment S5 - L5 - G61 - LH1 Loop - LH3 | – | |||||||
| additionalDangerousGoodsDescription | string | Material name, special instructions, and phone number if any. | – | LH301 | – | |||||||
| additionalDangerousGoodsClassification | string | Free-form description of hazardous material classification or division or label requirements. | – | LH302 | – | |||||||
| dangerousGoodsRegulatedIdentifiers | array | To uniquely identify the variable information required by government regulation covering the transportation of hazardous material shipments. | – | Segment S5 - L5 - G61 - LH1 Loop - LFH | – | |||||||
| hazardMaterialInformationType | string |
Type of shipment description recorded. Valid value:
|
– |
LFH01 =
|
– | |||||||
| description | string | Specific information required by law for hazardous material shipments. | – | LFH02 + LFH03 | – | |||||||
| shipmentPurchaseOrderDetail | array | Details about the shipment purchase order. Can be used to show order level delivery status. | – | Segment OID under S5 Loop | – | |||||||
| purchaseOrderNumber | string | Purchase order number for shipment. | – | OID02 | – | |||||||
| transactionReferenceIdentifier | string | Additional transaction reference identifier for the shipment purchase order. | – | OID01 | – | |||||||
| shipmentApplicationErrorCode | string | Error code for purchase order shipment. | – | OID10 | – | |||||||
| packagingFormatCode | string | Packing form of lading quantity. | – | OID04 | – | |||||||
| orderQuantity | integer | Number of units (pieces) of the lading/exception quantity. | – | If OID04 present map to/from OID05 If OID12 present map from/to OID13 | – | |||||||
| weightValue | string | Weight recorded in the order. | – | OID07 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
OID06 =
|
– | |||||||
| volumeType | string |
Type of weight recorded. Valid values include:
|
– |
OID08 =
|
– | |||||||
| volumeValue | Number | Volume recorded in shipment purchase order. | – | OID09 | – | |||||||
| loadTenderItemEquipmentInformation | array | Shipment equipment details | – | Segment N7 under S5 Loop | – | |||||||
| equipmentPrefix | string | Prefix or alphabetic part of an equipment unit's identifying number. | – | N701 | – | |||||||
| equipmentIdentifier | string | Sequencing or serial part of an equipment unit's identifying number. | – | N702 | – | |||||||
| carrierCode | string | Carrier code for shipper. | – | N712 | – | |||||||
| shipmentFlashPoint | string | Free-form abbreviation of temperature range or flash-point temperature. | – | N713 | – | |||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values:
|
– |
N711 =
|
– | |||||||
| equipmentTypeISOCode | string | Equipment type ISO code. | – | – | – | |||||||
| checkDigitIdentifier | number | Equipment check digit number, (Container check digit number). | – | N718 | – | |||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
N717 =
|
– | |||||||
| weightType | string |
Type of weight recorded in shipment. Valid values include:
|
– | N704 | – | |||||||
| weightValue | string | Weight of product at delivery header level. | – | N703 in all other cases. N705 where weightType = TARE | – | |||||||
| tareType | string |
Tare Qualifier Code.
|
– | N716 = A (ACTUAL) Or M (MARKED) | – | |||||||
| tareWeight | number | Tare weight of equipment. | – | N705 | – | |||||||
| volumeType | string |
Type of volume recorded. Valid values include:
|
– | N709 | – | |||||||
| volumeValue | Number | Vessel volume for type. | – | N708 | – | |||||||
| equipmentDimensions | array | Dimensions of freight. | – | Segment N7 | – | |||||||
| dimensionsType | string |
Type of dimensions recorded for freight. Valid values include:
|
– | – | – | |||||||
| dimensionsValue | Number | Volume for item in inches. | – | N715where dimensionsType = LENGTH N720 where dimensionsType = HEIGHT N721 where dimensionsType = WIDHT | – | |||||||
| unitOfMeasure | string | Dimension unit of measure for parent packaging. | – | – | – | |||||||
| itemQuantity | array | Equipment quantity. | – | – | – | |||||||
| quantityType | string | Type of quantity recorded. | – | – | – | |||||||
| quantityValue | number | Quantity of product in shipment. | – | – | – | |||||||
| unitOfMeasure | string |
Unit or Basis for Measurement Code. Unit of entry UOM's include
|
– | – | – | |||||||
| equipmentSealNumbers | array | Shipment carrying equipments seal numbers. | – | Segment S5 - N7 - M7 | – | |||||||
| sealNumber | string | Applied seal number for shipment carrying equipment. | – | M701, M702, M703, M704 | – | |||||||
| sealAppliedEntityType | string |
Seal applied entity type code, it could be an organization or location or an individual. Valid values include:
|
– |
M705 =
|
– | |||||||
| shipmentMeasurements | – | Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. | – | Segment S5 - N7 - MEA | – | |||||||
| measurementCategory | string |
Broad category of measurement to which measurement type belongs to or applies. Valid values include:
|
– |
MEA01 =
|
– | |||||||
| measurementType | string |
Code identifying a measurement type for a measurement value. Valid values includes:
|
– |
MEA02 =
|
– | |||||||
| measurementValue | string | The value of the measurement. | – | MEA03 | – | |||||||
| unitOfMeasure | string |
Unit of measure for the measurement type and value recorded. Valid values includes:
|
– | MEA04 | – | |||||||
| measuredType | string |
Code identifying a measured type for a measured value. Valid values include:
|
– | – | – | |||||||
| freeTextNote | array | Ship to party company identifiers and address information. | – | Segment S5 - NTE | – | |||||||
| textReferenceCode | string | Text reference or subject code. | – | NTE01 | – | |||||||
| textFunctionCode | string | Text function code. | – | – | – | |||||||
| language | string | Language of free text | – | – | – | |||||||
| textFormatCode | string | Format code for free text | – | – | – | |||||||
| freeText | string | Free test string | – | NTE02 | – | |||||||
| 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. | – | – | – | |||||||
| freeTextNote | array | Ship to party company identifiers and address information. | – | – | – | |||||||
| textReferenceCode | string | Text reference or subject code. | – | – | – | |||||||
| textFunctionCode | string | Text function code. | – | – | – | |||||||
| language | string | Language of free text | – | – | – | |||||||
| textFormatCode | string | Format code for free text | – | – | – | |||||||
| freeText | string | Free test string | – | – | – | |||||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. | – | – | – | |||||||
| name | string | Name of mapped field. | – | – | – | |||||||
| value | string | Value in named field. | – | – | – | |||||||
| canonicalLoadTenderWeightChargesSummary | -– | Describes the total shipment of load tender in terms of weight, volume, rates, charges, advances, and prepaid amounts applicable to one or more line items. | – | Segment L3 (weight and charges summary) | – | |||||||
| freightRate | number (implicit decimal) | Rate that applies to the specific commodity. | – | L303 | – | |||||||
| freightRateType | string |
Qualifiers to extend charges or interpret or calculate value. Valid values are:
|
– |
L304 or L315 =
|
– | |||||||
| totalCharges | number | Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency. | – | L305 | – | |||||||
| advancePayment | number | Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. | – | L306 | – | |||||||
| prepaidAmount | number | Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency. | – | L307 | – | |||||||
| specialChargeCode | string |
Type of special charge or allowance allowed. Valid values include:
|
– |
L308 =
|
– | |||||||
| 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:
|
– |
L312 =
|
– | |||||||
| quantityType | string |
Type of quantity recorded. Valid values include |
– | – | – | |||||||
| quantityValue | number | Quantity of product in delivery. | – | L311 where quantityType = LADING | – | |||||||
| weightType | string |
Type of weight recorded. Valid values include:
|
– | L302 | – | |||||||
| weightValue | Number | Weight of product at PO line item. | – | L301 | – | |||||||
| volumeType | string |
Type of weight recorded. Valid
values include |
– | L310 | – | |||||||
| volumeValue | Number | Volume for item. | – | L309 | – | |||||||
| canonicalMotorCarrierLoadTenderEventDetails | array | To report events occurred during ocean, rail, air shipments. | – | – | – | |||||||
| shipmentEventType | string |
Code to specify type of the ocean shipment event. Valid values include:
|
– | – | – | |||||||
| eventName | string | Event descriptive information. | – | – | – | |||||||
| 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. | – | – | – | |||||||
| epochTransportEventTimeStamp | integer | Event date and time in epoch format. | – | – | – | |||||||
| timeZone | string | Time zone code. | – | – | – | |||||||
| city | string | Event city. | – | – | – | |||||||
| state | string | State code. | – | – | – | |||||||
| countryCode | string | Event Country code. | – | – | – | |||||||
| transactionStatusReasonCode | string |
Reason indicating why a shipment status code was transmitted. Valid values included:
|
– | – | – | |||||||
| 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 include:
|
– | – | – | |||||||
| temperatureType | string |
Type of temperature follow while shipment. Valid values:
|
– | – | – | |||||||
| 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:
|
– | – | – | |||||||
| rangeType | string |
Type of range. Valid values:
|
– | – | – | |||||||
| minTemperature | number | Equipment minimum allowable temperature. | – | – | – | |||||||
| maxTemperature | number | Equipment maximum allowable temperature. | – | – | – | |||||||
| ventSetting | string |
To specifying equipment vent adjustment code. Valid values:
|
– | – | – | |||||||
| description | string | Descriptive information about environment required in refrigerated container when other then normal air required. | – | – | – | |||||||
| humidityPercent | number | Percent in integer format , example: 50% required, in 50. | – | – | – | |||||||
| supplyTemperature | number | The temperature of the air coming into the container. | – | – | – | |||||||
| returnTemperature | number | The temperature of the air leaving the container. | – | – | – | |||||||
| co2Setpoint | number | The designated CO2 atmosphere level for transporting your cargo. | – | – | – | |||||||
| co2Reading | number | The CO2 atmosphere level. | – | – | – | |||||||
| o2Setpoint | number | The designated O2 atmosphere level for transporting your cargo. | – | – | – | |||||||
| o2Reading | number | The O2 atmosphere level. | – | – | – | |||||||
| relativeHumidity | number | The relative humidity | – | – | – | |||||||
| humiditySetpoint | number | The designated humidity level for transporting your cargo. | – | – | – | |||||||
| pulpLocation1Temperature | number | One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. | – | – | – | |||||||
| pulpLocation2Temperature | number | One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. | – | – | – | |||||||
| pulpLocation3Temperature | number | One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. | – | – | – | |||||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. | – | – | – | |||||||
| name | string | Name of mapped field. | – | – | – | |||||||
| value | string | Value in named field. | – | – | – | |||||||
Tag end


