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,
Routing carrier instructions canonical guidelines
The routing and carrier instructions are essential in the transportation and shipping industry, providing detailed guidelines to ensure efficient and compliant movement of goods. These instructions allow shippers to define shipping preferences, specifying transportation modes, carriers, pickup and delivery schedules, and route preferences. They also ensure supplier compliance by guiding manufacturers' upstream partners on carrier selection and shipping terms, fostering consistency in inbound logistics. Additionally, routing instructions align shipments with cost, time, and quality goals, enabling carriers and freight forwarders to plan optimal routes and capacity utilization. Compliance with regulatory requirements is another critical aspect, as instructions often detail documentation needs, labeling standards, customs procedures, and handling protocols for specific goods like hazardous materials. By incorporating elements such as carrier details, freight handling needs, billing terms, and routing guidelines, these instructions improve coordination, reduce costs, enhance service quality, and minimize logistical and regulatory errors, streamlining the entire supply chain.
| 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. | – | – | – | ||||||
| canonicalRoutingCarrierInstructionHeader | – | Payload for canonical Routing and carrier Instruction message. | segment E1EDT18 | segment BGN | segment BGM | ||||||
| processingFunctionTypeCode | string |
Processing function, transaction set purpose code. Required for X12, optional for Idoc and EDIFACT. Valid values include:
|
EDI_VTDT18 =
|
BGN01 =
|
BGM030 = 1 (CANCEL) or 2 (CREATE) or 3 (DELETE) or 4 (CHANGE) or 5 (REPLACE) or 9 (ORIGINAL) | ||||||
| dateReported | string | To indicate a date applying for message. | – | BGN03 | DTM010-020 | ||||||
| epochDateReported | integer | Routing Carrier Instruction requirements profile. | – | – | – | ||||||
| transactionReferenceIdentifierList | array | Transaction references for Routing and carrier Instruction at header level that affects the entire message. | segment E1EDT20 | segment BGN | segment BGM, RFF | ||||||
| b2bTransactionIdentifierType | string |
Referenced document type. Valid values:
|
– | – |
Set BGM010-010 to 340 (Shipping Instructions) where b2bTransactionIdentifierType =
RFF010-010 -
|
||||||
| b2bTransactionIdentifierValue | string |
Shipment or delivery identifier for routing carrier instruction message. |
TKNUM where b2bTransactionIdentifierType =
|
BGN02 where b2bTransactionIdentifierType =
BGN06 where b2bTransactionIdentifierType =
|
BGM020-010 where b2bTransactionIdentifierType =
RFF010-020 |
||||||
| transactionDate | string | Date transaction created. | – | – | – | ||||||
| epochTransactionDate | integer | Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | – | – | – | ||||||
| lineItemNumber | string | Line item number in customer purchase order. Line item level only. | – | – | – | ||||||
| termsOfPayment | array | Terms of payment looping group. | – | – | – | ||||||
| discountDueDate | string | Due date for payment. | – | – | – | ||||||
| termsOfPaymentKey | string | Terms of payment. | – | – | – | ||||||
| termsOfPaymentTypeCode | string |
Code identifying type of payment terms. Valid values:
|
– | – | – | ||||||
| termsOfPaymentDateBasis | string |
Terms of payment date type codes. Valid values:
|
– | – | – | ||||||
| numberOfDays | string | Terms of payment: number of days. | – | – | – | ||||||
| termsOfPaymentPercent | string | Terms of payment: percentage. | – | – | – | ||||||
| dayOfMonth | number | Due date for payment. | – | – | – | ||||||
| epochPaymentDeferredToDate | integer | Date deferred payment or percent of invoice payable is due. | – | – | – | ||||||
| discountDueNumberOfDays | number | Deferred amount due for payment. | – | – | – | ||||||
| description | string | Terms of payment description. | – | – | – | ||||||
| invoicePayablePercent | string | Percentage of invoice payable. | – | – | – | ||||||
| paymentDueDate | string | Due date for payment. | – | – | – | ||||||
| paymentDeferredToDate | date | Date deferred payment or percent of invoice payable is due. | – | – | – | ||||||
| paymentDeferredDueAmount | number | Deferred amount due for payment. | – | – | – | ||||||
| totalTermDiscountAmount | number | Deferred amount due for payment. | – | – | – | ||||||
| epochDiscountDueDate | string | Due date for payment. | – | – | – | ||||||
| epochPaymentDueDate | string | Due date for payment. | – | – | – | ||||||
| deliveryTerms | array | Terms of delivery, transport or inco terms looping group. | – | – | – | ||||||
| deliveryTermCode | string | Inco term code. | – | – | – | ||||||
| description | string | Description for inco term. | – | – | – | ||||||
| deliveryChargePaymentMethodType | string |
Method of payment for delivery. Valid values:
|
– | – | – | ||||||
| fobTransferLocation | string |
Code specifying the type of location at which the risk of loss for the shipment transfers. Valid values:
|
– | – | – | ||||||
| shipmentHeaderInformation | - | Details about the shipment at the header level that affects the entire message. | segment E1EDT20 | – | – | ||||||
| shippingType | string | Shipment type. Identifies transportation type processing. SAP pass thru. | SHPTYP | – | – | ||||||
| shippingTypeDescription | string | Description of the shipment type. | E1EDT22/SHTYP_BEZ | – | – | ||||||
| shipmentCompletionType | string | Specifies whether the shipment is an outbound, inbound or empty shipment. SAP pass thru. | ABFER | – | – | ||||||
| processingControl | string |
Indicates how a shipment defined by the shipment type field is to be performed. For example, an individual shipment using one mode of transport, ie, truck. |
ABWST | – | – | ||||||
| shipmentServiceLevel | string | Indicates the general service level of the shipment: whether it is a load, general cargo, groupage, or an express shipment. | BFART | – | – | ||||||
| shipmentServiceLevelDescription | string | Description of the shipment service level. | E1EDT22/BFART_BEZ | – | – | ||||||
| shipmentStageShippingType | string |
Shipping type for the shipping stage. Identifies the mode of shipment (truck, goods train, etc.) used to transport goods on a particular leg of a route. SAP pass thru. |
VSART | – | – | ||||||
| shipmentStageShippingTypeDescription | string | Description of the shipping type for the shipment stage.. | E1EDT22/VSART_BEZ | – | – | ||||||
| shipmentLegIndicator | string | Specifies whether the shipment is linked to other shipments. Linked to transportation planning. | LAUFK | – | – | ||||||
| shipmentLegIndicatorDescription | string | Description of the shipment leg. | E1EDT22/LAUFK_BEZ | – | – | ||||||
| externalShipmentIdentifier1 |
Instance 1 of the external identifier for the shipment used by an external partner. The identifier type varies by the type of shipment. SAP pass thru. For example, if by road this would be the shipment number of the carrier, by rail a shipping number, by sea a BOL, or by air an airway bill number. |
– | – | ||||||||
| transactionReferenceIdentifier | string | Instance 1 of the external shipment identifier. | EXTI1 | – | – | ||||||
| externalShipmentIdentifier2 | - |
Instance 2 of the external identifier for the shipment used by an external partner. The identifier type varies by the type of shipment. SAP pass thru. |
- | – | – | ||||||
| transactionReferenceIdentifier | string | Instance 2 of the external shipment identifier. | EXTI2 | – | – | ||||||
| shipmentStatus | string |
Overall status of a shipment. Indicates the current processing stage of a shipment. Valid values:
|
STTRG | – | – | ||||||
| shipmentStatusDescription | string | Description of the shipment status. | E1EDT22/STTRG_BEZ | – | – | ||||||
| isPackagingInShipment | boolean |
Does shipment include handling units (packaging). Valid values:
|
PKSTK | – | – | ||||||
| weightUOM | string | Unit of weight for transportation planning. | DTMEG | – | – | ||||||
| volumeUOM | string | Unit of volume for transportation planning. | DTMEV | – | – | ||||||
| shipmentDistance | number | Total distance that shipment will travel. | DISTZ | – | – | ||||||
| travelTime | number | Travel time between two locations not including any stops or breaks. | FAHZT | – | – | ||||||
| totalTravelTime | number | Total travel time between two locations including breaks. | GESZT | – | – | ||||||
| plannedTotalTransportationTime | number | Total planned transportation time for a shipment in days. | GESZTD | – | – | ||||||
| plannedDurationOfTransportation | number | Planned duration of transportation in hours and minutes. | FAHZTD | – | – | ||||||
| actualTotalTransportationTime | number | Actual total transportation time for a shipment in days. | GESZTDA | – | – | ||||||
| actualDurationOfTransportation | number | Actual duration of transportation in hours and minutes. | FAHZTDA | – | – | ||||||
| plannedWaitingTimeForShipment | number | Planned waiting time for shipment in hours and minutes. | WARZTD | – | – | ||||||
| currentWaitingTimeForShipment | number | Current waiting time for shipment in hours and minutes. | WARZTDA | – | – | ||||||
| shipmentServiceRequirements | array | Identifies information about services, conditions, contract and priority requirements for the shipment. EDIFACT pass thru. | – | – | segment TSR | ||||||
| contractCarriageConditionCode | string | Contract and carriage condition code identifying the conditions of the transportation contract and carriage. EDIFACT pass thru. | – | – | TSR010-010 | ||||||
| shipmentDateRange | array | Shipment date ranges. This can also be mapped to the X12 and EDIFACT by mapping the end date across. | segment E1EDT10 | segment G62 at header | – | ||||||
| referenceDateType | string |
Date type at header level for routing and carrier Instruction in date format YYYYMMDDTHH:MM:SS.nnnZ. Valid values:
Use Java call-out to new lookup table CL_DateType.txt. |
QUALF =
|
G6201 =
|
DTM010-010 =
|
||||||
| startDateTime | string | Start date for shipment event recorded in string datetime format YYYYMMDDYHH:MM:SS.nnnZ. | NTANF NTANZ (if startDateTime includes time) | – | – | ||||||
| epochStartDateTime | integer | Shipment start date in epoch format. | – | – | – | ||||||
| endDateTime | string | End date for shipment event recorded in string datetime format YYYYMMDDYHH:MM:SS.nnnZ. | NTEND NTENZ (if startDateTime includes time) | G6202 | DTM010-020 | ||||||
| epochEndDate | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | ||||||
| timeZone | string | Time zone for referenced dates. | – | – | – | ||||||
| carrierInformation | Carrier identifiers and address information. | segment E1ADRM4 PARTNER_Q = SP | segment N1 N101 = CA | segment group 12 NAD NAD010 = CA | |||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner . | - |
N103 |
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | Party address information. | – | – | – | |||||||
| address1 | string | Main street address. | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address. | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | REGION | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | POSTL_COD1 | N403 | NAD080 | ||||||
| country | string | Country code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number. | – | – | – | ||||||
| contactEmail | string | Contact email address. | – | – | – | ||||||
| transportationPlanningPoint | Customer or buyer party company identifiers and address information. | segment E1ADRM4 PARTNER_Q = AG | – | – | |||||||
| businessName | string | Business name for partner or location. | NAME1 | – | – | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - | – | – | ||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | – | – | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | Party address information. | – | – | – | |||||||
| address1 | string | Main street address. | STREET1 | – | – | ||||||
| address2 | string | Supplemental street address. | STREET2 | – | – | ||||||
| city | string | City | CITY1 | – | – | ||||||
| state | string | State or region code | POSTL_COD1 | – | – | ||||||
| postalCode | string | Postal code | COUNTRY1 | – | – | ||||||
| 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 | – | – | – | ||||||
| customerBusinessInformation | Customer or buyer party company identifiers and address information. | segment E1ADRM4 PARTNER_Q = AG | segment N1 N101 = BY | segment group 12 NAD NAD010 = BY | |||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | - | Party address information. | – | – | – | ||||||
| address1 | string | Main street address. | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address. | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| supplierBusinessInformation | - | Supplier party company identifiers and address information. | segment E1ADRM4 PARTNER_Q = LF | segment N1 N101 = SU | segment group 12 NAD NAD010 = BY | ||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | ||||||
| address | - | Party address information | – | – | – | ||||||
| address1 | string | Main street address | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| shipFromLocationInformation | - | Ship from location identifiers and address information. | segment E1ADRM4 PARTNER_Q = OSP | segment N1 N101 = SF | segment group 12 NAD NAD010 = SF | ||||||
| businessName | string | Business name for partner or location | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | ||||||
| address | - | Party address information | – | – | – | ||||||
| address1 | string | Main street address | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| shipToLocationInformation | - | Ship To location identifiers and address information. | segment E1ADRM4 PARTNER_Q = OSP | segment N1 N101 = ST | segment group 12 NAD NAD010 = ST | ||||||
| businessName | string | Business name for partner or location | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | ||||||
| address | Party address information | – | – | – | |||||||
| address1 | string | Main street address | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| packagingIdentifiersList | array | Packaging identifiers at header level. Records info about packaging used in shipment. | E1EDT37 | – | – | ||||||
| packagingIdentifierType | string | Packaging identifier type at header level. Pass thru mapping for X12. | – | – | – | ||||||
| packagingIdentifier | string | Packaging identifier value defined by the packaging type. | EXIDV | – | – | ||||||
| packagingMaterialDescription | string | Description of handling unit/packaging material | E1EDT37/E1EDT38/VEBEZ | – | – | ||||||
| tareWeight | number | Tare weight of handling unit/packaging item. | TARAG | – | – | ||||||
| tareWeightUOM | string |
Unit of measure for tare weight. Use java call-out to lookup table UOM_TableLookup2.txt. Do not add enums to attribute. |
GWEIT | – | – | ||||||
| grossWeight | number | Total weight of handling unit/packaging item. | BRGEW | – | – | ||||||
| netWeight | number | Net weight of handling unit/packaging item. | NTGEW | – | – | ||||||
| allowedLoadingWeight | number | Allowed loading weight of handling unit/packaging item. | MAGEW | – | – | ||||||
| weightUOM | string |
Unit of measure for tare, gross and net weights of handling unit/packaging. |
GWEIM |
– | – | ||||||
| totalVolume | number | Total volume of handling unit/packaging item. | BTVOL | – | – | ||||||
| loadingVolume | number | Loading volume of handling unit/packaging item. | NTVOL | – | – | ||||||
| allowedVolume | number | Allowed loading volume of handling unit/packaging item. | MAVOL | – | – | ||||||
| volumeUOM | string |
Unit of measure for total, loading, and allowed volumes of handling unit/packaging. |
VOLEM | – | – | ||||||
| tareVolume | number | Tare volume of handling unit/packaging item. | TAVOL | – | – | ||||||
| tareVolumeUOM | string |
Unit of measure for tare volume of handling unit/packaging item. |
VOLET |
– | – | ||||||
| packagingMaterialCode | string | Packaging material code in sender's ERP system. | VHILM | – | – | ||||||
| packagingLength | number | Length of handling unit/packing item | LAENG | – | – | ||||||
| packagingWidth | number | Width of handling unit/packing item | BREIT | – | – | ||||||
| packagingHeight | number | Height of handling unit/packing item | HOEHE | – | – | ||||||
| dimensionsUOM | string |
Unit of measure dimensions such as length, width, height for handling unit/packaging. |
MEABM |
– | – | ||||||
| packagingMaterialType | string | Packaging material type for handling unit/packaging item. | VHART | – | – | ||||||
| packagingMaterialTypeDescription | string | Description of the packaging material type for handling unit/packaging item. | E1EDT37/E1EDT38/VHART_BEZ | – | – | ||||||
| materialGroup | string | Material group in ERP system for packaging materials. | MAGRV | – | – | ||||||
| materialGroupDescription | string | Descriptions of material group in ERP system for packaging materials. | MAGRV_BEZ | – | – | ||||||
| packagingMaterialCategory | string | Packaging material category for handling unit/packaging items in shipment. | VELTP | – | – | ||||||
| freeTextNote | array | Free text, instructions, notes, descriptions and other free text elements | – | – | – | ||||||
| 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. | – | – | – | ||||||
| canonicalRoutingCarrierInstructionItemDetails | array | Routing and carrier Instruction Item details. | E1EDK33 | TD5 loop | – | ||||||
| carrierSequenceCode | string |
Code identifying sequence of carriers in shipment, beginning with the original carrier. Valid values include:
|
– |
TD501 |
– | ||||||
| companyIdentifierType | string | Company identifier type for party in shipment stage, moist likely an SCAC code. | – |
TD502 |
– | ||||||
| companyIdentifierValue | string | Company identifier value for business party in shipment stage. | – | TD503 | – | ||||||
| routingDescription | string | Free-form description of the routing or requested routing for shipment, or the originating carrier's identity | – | TD505 | – | ||||||
| routingLocationIdentifierType | string |
Code identifying the type of location for the routing stage of the shipment. Valid values include:
|
– |
TD507 |
– | ||||||
| routingLocationIdentifier | string | Identifier of the location for the routing stage of the shipment. | – | TD508 | – | ||||||
| carrierTransitTimeType | string |
Code specifying the value of time used to measure the transit time. Valid values:
|
– |
TD510 =
|
– | ||||||
| carrierTransitTimeValue | integer | The numeric amount of transit time defined by carrier transit time type. | – | TD511 | – | ||||||
| shipmentRoutingStages |
Routing point -- shipment stages point. |
E1EDK33 | – | – | |||||||
| transportStageNumber | number | Stage of transport identifier. | TSNUM | – | – | ||||||
| transportSequenceStageNumber | number | Stage of transport sequence number. | TSRFO | – | – | ||||||
| transportStageCategory | string |
Stage type of transport sequence. Identifies whether shipment is loading, in transport, or at a border. |
TSTYP | – | – | ||||||
| transportStageCategoryDescription | string |
Description of stage category of transport sequence. Identifies whether shipment is loading, in transport, or at a border. |
E1EDK33/E1EDT50/TSTYP_BEZ | – | – | ||||||
| transportMethod | string |
Transport method type. Valid values include:
|
VSART =
|
TD504 =
|
– | ||||||
| transportMethodDescription | Description of transport method type. | E1EDK33/E1EDT50/VSART_BEZ | – | – | |||||||
| routingLegIndicator | string | Routing leg indicator for shipment stage. SAP pass thru. | LAUFK | – | – | ||||||
| routingLegIndicatorDescription | string | Description of routing leg indicator for shipment stage. SAP pass thru. | E1EDK33/E1EDT50/LAUFK_BEZ | – | – | ||||||
| routingLegDistance | number | Distance to be traveled for routing leg. SAP pass thru | DISTZ | – | – | ||||||
| routingStageDistanceUOM | string | Unit of measure for routing stage distance. | MEDST | – | – | ||||||
| travelTimeTwoLocations | number | The amount of time required to travel between two locations, not including breaks. | FAHZT | – | – | ||||||
| totalTravelTimeTwoLocations | number | The total amount of time required to travel between two locations, including breaks. | GESZT | – | – | ||||||
| routingStagePlannedTotalTime | integer | Planned total time at stage level in days. | GESZTD | – | – | ||||||
| routingStageActualTotalTime | integer | Actual total time at stage level in days. | GESZTDA | – | – | ||||||
| routingStagePlanActualDuration | integer | Planned actual duration at stage level in hours and minutes. | FAHZTD | – | – | ||||||
| routingStageActualDuration | integer | Actual duration at stage level in hours and minutes. | FAHZTDA | – | – | ||||||
| routingStagePlannedWaitingTime | integer | Planned waiting time in routing stage of shipment in hours and minutes. | WARZTD | – | – | ||||||
| routingStageCurrentWaitingTime | integer | Current waiting time in routing stage of shipment in hours and minutes. | WARZTDA | – | – | ||||||
| shipmentRoutingStage | array | Shipment routing stages point. | E1EDK33/E1EDT44 | – | – | ||||||
| isBeginOrEndPoint | boolean | Identifies whether the routing stage is a begging or end point. |
QUALI = 001 or 002
|
– | – | ||||||
| shippingReceivingPoint | string | Shipping or receiving point for routing stage | VSTEL | – | – | ||||||
| shippingReceivingPointDescription | string | Description of shipping or receiving point for routing stage. | E1EDT44/E1EDT49/VSTEL_BEZ | – | – | ||||||
| routingShipOrReceivingPoint | array | Identifier list for the shipping or receiving point for the routing stage. | E1EDK33/E1EDT44/E1EDT44 | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - | – | – | ||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | – | – | ||||||
| businessName | string | Business name for partner or location. | NAME1 | – | – | ||||||
| address | Address information for the shipping or receiving point for the routing stage. | – | – | – | |||||||
| address1 | string | Main street address. | STREET1 | – | – | ||||||
| address2 | string | Supplemental street address. | STREET2 | – | – | ||||||
| city | string | City | CITY1 | – | – | ||||||
| state | string | State or region code | POSTL_COD1 | – | – | ||||||
| postalCode | string | Postal code | COUNTRY1 | – | – | ||||||
| country | string | Country code | – | – | – | ||||||
| telephone | string | Telephone number | – | – | – | ||||||
| fax | string | Fax number | – | – | – | ||||||
| url | string | Website URL | – | – | – | ||||||
| carrierInformation | array | Carrier identifiers and address information for the routing stage. | segment E1EDK33/E1ADRM7 PARTNER_Q = SP | – | – | ||||||
| businessName | string | Business name for partner or location. | NAME1 | – | – | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | E1ADRM7 | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - | – | – | ||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | ||||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | Party address information. | – | – | – | |||||||
| address1 | string | Main street address. | STREET1 | – | – | ||||||
| address2 | string | Supplemental street address. | STREET2 | – | – | ||||||
| city | string | City | CITY1 | – | – | ||||||
| state | string | State or region code | REGION | – | – | ||||||
| postalCode | string | Postal code | POSTL_COD1 | – | – | ||||||
| country | string | Country code | COUNTRY1 | – | – | ||||||
| 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 | – | – | – | ||||||
| transportationEquipment | array | Details about the carrier's equipment that will ship the delivery. | – | segment TD3 in TD5 loop | EQD in segment group 36 | ||||||
| carrierCode | string | Carrier code for shipper. | – | – | – | ||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values:
|
– |
TD301 =
|
EQD010 =
|
||||||
| equipmentPrefix | string | Prefix or alphabetic part of an equipment unit's identifying number. | – | TD302 | – | ||||||
| equipmentIdentifier | string | Sequencing or serial part of an equipment unit's identifying number. | – | TD303 | EQD020-010 | ||||||
| sealNumber | string | Unique number on seal used to close a shipment | – | TD309 | SEL010 (EQD/SEL loop) | ||||||
| sealStatusCode | string |
Seal status code indicating condition of door seal upon arrival. Valid values:
|
– |
TD308 =
|
SEL030 =
|
||||||
| equipmentSizeTypeCode | string | Equipment size and type description code | – | TD310 | SEL030-040 | ||||||
| shipmentMeasurements | array | Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. | – | segment MEA in TD5 loop | segment MEA in EQD loop | ||||||
| measurementType | string |
Code identifying a measurement type for a measurement value. Valid values:
|
– |
MEA02 =
|
MEA010 =
|
||||||
| measurementValue | string | The value of the measurement. | – | MEA03 | MEA030-020 | ||||||
| unitOfMeasure | string | Unit of measure for the measurement type and value recorded. | – | MEA04 Use Java call-out to enum lookup table UOM_TableLookup2.txt. | – | ||||||
| routingFactor | To explain the route and indicate individual carrier divisions or factors. | – | segment FK in TD5 loop | – | |||||||
| carrierCode | string | factor carrier Standard Carrier Alpha Code (SCAC). | – | FK01 | – | ||||||
| transportMethod | string |
Transport method type. Valid values include:
|
– |
TD504 =
|
– | ||||||
| state | string | Code (Standard State/Province) as defined by appropriate government agency. | – | FK03 | – | ||||||
| city | string | City Name | – | FK04 | – | ||||||
| freightRevenuePercent | number | The portion of freight revenue to be apportioned to an identified carrier, expressed as a percent, which shall not exceed 100.00 | – | FK06 | – | ||||||
| factorAmount | number | A number that indicates the portion of freight rate revenue to be apportioned to an identified carrier | – | FK07 | – | ||||||
| mpcDates | array | Dates relevant for routing and carrier instruction at item | – | segment G62 in TD5 loop | – | ||||||
| dateType | string |
Date type at header level for Routing and carrier Instruction in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– |
G6201 =
|
– | ||||||
| dateValue | string | Date defined by date type in date format YYYY-MM-DD. | – | G6202 | – | ||||||
| epochDateValue | integer |
Date defined by date type in epoch date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | ||||||
| timeZone | string | Time zone for referenced dates. | – | – | – | ||||||
| carrierInformation | Carrier identifiers and address information. | – | segment N1 in TD5 loop N101 = CA | segment group 38 NAD in EQD loop NAD010 = CA | |||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | – |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | – | N104 | NAD030-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 | ||||||
| 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 | – | – | – | ||||||
| transportationPlanningPoint | Customer or buyer party company identifiers and address information. | segment E1ADRM7 PARTNER_Q = AG | – | – | |||||||
| businessName | string | Business name for partner or location. | NAME1 | – | – | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - | – | – | ||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | – | – | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | Party address information | – | – | – | |||||||
| address1 | string | Main street address | STREET1 | – | – | ||||||
| address2 | string | Supplemental street address | STREET2 | – | – | ||||||
| city | string | City | CITY1 | – | – | ||||||
| state | string | State or region code | POSTL_COD1 | – | – | ||||||
| postalCode | string | Postal code | COUNTRY1 | – | – | ||||||
| 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 | – | – | – | ||||||
| customerBusinessInformation | Customer or buyer party company identifiers and address information. | segment E1ADRM7 PARTNER_Q = AG | segment N1 in TD5 loop N101 = BY | segment group 38 NAD in EQD loop NAD010 = BY | |||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | Party address information. | – | – | – | |||||||
| address1 | string | Main street address. | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address. | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address. | – | – | – | ||||||
| supplierBusinessInformation | Supplier party company identifiers and address information. | segment E1ADRM7 PARTNER_Q = LF | segment N1 in TD5 loop N101 = SU | segment group 38 NAD in EQD loop NAD010 = SU | |||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner. | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | Party address information | – | – | – | |||||||
| address1 | string | Main street address | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| shipFromLocationInformation | Ship from location identifiers and address information. | segment E1ADRM7 PARTNER_Q = OSP | segment N1 in TD5 loop N101 = SF | segment group 38 NAD in EQD loop NAD010 = SF | |||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | – | Party address information. | – | – | – | ||||||
| address1 | string | Main street address. | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address. | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| shipToLocationInformation | – | Ship To location identifiers and address information. | segment E1ADRM7 PARTNER_Q = OSP | segment N1 in TD5 loop N101 = ST | segment group 38 NAD in EQD loop NAD010 = ST | ||||||
| businessName | string | Business name for partner or location. | NAME1 | N102 | NAD030-010 | ||||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | ||||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | ||||||
| companyIdentifierType | string | Company identifier type for business partner | - |
N103 =
|
NAD020-030 =
|
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | PARTNER_ID | N104 | NAD030-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | – | Party address information. | – | – | – | ||||||
| address1 | string | Main street address. | STREET1 | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address. | STREET2 | N302 | NAD050-020 | ||||||
| city | string | City | CITY1 | N401 | NAD060 | ||||||
| state | string | State or region code | POSTL_COD1 | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | COUNTRY1 | 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 | – | – | – | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | – | – | ||||||
| contactEmail | string | Contact email address | – | – | – | ||||||
| freeTextNote | array | Free text, instructions, notes, descriptions and other free text elements. | – | – | – | ||||||
| textReferenceCode | string | Text reference or subject code. | – | – | – | ||||||
| textFunctionCode | string | Text function code. | – | – | – | ||||||
| language | string | Language of free text. | – | – | – | ||||||
| textFormatCode | string | Format code for free text. | – | – | – | ||||||
| freeFormText | string | Free test string. | – | – | – | ||||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. | – | – | – | ||||||
| name | string | Name of mapped field. | – | – | – | ||||||
| value | string | Value in named field. | – | – | – | ||||||
| canonicalRoutingCarrierInstructionSummary | array | Summary totals for price authorization acknowledgment. | – | segment CTT | segment CNT | ||||||
| summaryType | string |
Summary type for price authorization acknowledgment. Number of line items. The valid value is |
– | CTT01 | CNT010-010 = 2 (NUMBEROFITEMS) | ||||||
| summaryValue | string | Summary value. | – | CTT02 | CNT020 | ||||||
| summaryValueUnit | string | Summary value unit of measure. | – | – | – | ||||||
Tag end


