Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,
Ocean shipment booking confirmation canonical guidelines
The Ocean Shipment Booking Confirmation is a structured electronic transaction used to communicate the status of a shipment booking request between trading partners in the transportation and logistics industry. It serves as the formal response from a carrier, freight forwarder, or logistics service provider (LSP) confirming whether a booking request has been accepted, modified, or rejected. As part of the ANSI ASC X12 standard, this transaction is a key element of the freight booking process, widely used in ocean, rail, and multi-modal transport operations.
| 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. | – | – | – | ||||||
| canonicalShipmentBookingConfirmationHeader | – | Header details for the cannical booking confirmation message canonical. | – | B1 | BGM | ||||||
| processingFunctionTypeCode | string |
Processing function, transaction set purpose code. Valid values include:
|
– | - |
BGM030 =
|
||||||
| carrierCode | string | Shipping carrier alpha code (SCAC). | – | B101 (if version is 4040 or less optional, other wise mandatory) | RFF02 when RFF01 = AAZ | ||||||
| shipmentBookingStatus | string |
Code specifying status of the booking request. Valid values include:
|
– |
B104 |
BGM040 |
||||||
| bookingDeclineReasonCode | string |
Code specifying reason behind booking cancel by carrier or customer. Valid values include:
|
– |
B106 |
– | ||||||
| isPartialLoad | boolean |
Code specifying partial load allowed. Valid values:
|
– | B105 = Y (true) Or N (false) | – | ||||||
| departureDate | string | Vessel departure date from port in format YYYYMMDD. | – | Y303 | – | ||||||
| epochDepartureDate | integer | Vessel departure date from port in epoch format. | – | N/A | – | ||||||
| pierDate | string |
Required Pier date and load time. Last acceptable date and time by which cargo must be delivered to the terminal to be loaded onto the scheduled vessel. Format YYYYMMDDTHHMMSS |
– | Y307 & Y308 | – | ||||||
| epochPierDate | integer | Last acceptable date in epoch format. | – | N/A | – | ||||||
| estimatedArrivalDate | string | Estimated arrival date at port of discharge. | – | Y304 | – | ||||||
| epochEstimatedArrivalDate | integer | Estimated arrival date in epoch format. | – | N/A | – | ||||||
| locationIdentifier | string | Terminal/ Port / Airport of discharge standard point location code (SPLC). | – | Y305 | – | ||||||
| portName | string | Port / Airport of discharge port name. | – | Y306 | – | ||||||
| transportMethod | string |
Transport method type. Valid values include:
|
– |
Y309 |
– | ||||||
| servicesTariffCode | string |
Types of services rendered and respective charges billed by the carrier. Valid values include:
|
– |
Y310 =
|
– | ||||||
| timeZone | string | timZone | – | Y311 | – | ||||||
| contactInformation | array | Contact information for party business or location | – | G61 | CTA | ||||||
| contactType | string |
Contact type. Valid values include:
|
– |
G6101 =
|
CTA010 =
|
||||||
| contactName | string | Contact name. | – | G6102 | CTA020-020 | ||||||
| contactTitle | string | Title of contact. | – | – | – | ||||||
| contactPhone | string | Contact phone number. | – | G6104 where G6103 = "TE" | COM010-010 where COM010-020 = "TE" | ||||||
| contactEmail | string | Contact email address. | – | G6104 where G6103 = "EM" | COM010-010 where COM010-020 = "EM" | ||||||
| shipmentBookingConfirmationDetails | array | Booking confirmation details consisting of equipment type, no of equipments, carrier code, pickup point location details. | – | Y4 | TSR | ||||||
| bookingIdentifier | string | Number given by carrier for space reservation, first booking number, if only one booking number use this attribute. | – | Y401 | RFF02 when RFF01 = BN | ||||||
| bookingIdentifierTo | string |
To capture last booking number, in case of range of booking numbers available. If only one booking number available, do not use this. |
– | Y402 | RFF02 when RFF01 = BN | ||||||
| equipmentType | string |
Type of equipment requested for booking. Valid values:
|
– | – | – | ||||||
| carrierCode | string | Carrier code for whom containers will be released. | – | Y407 | – | ||||||
| equipmentTypeISOCode | string | Equipment type ISO 6346 size code. | – | Y406 | – | ||||||
| quantityValue | number | No of equipments/ containers booked. | – | Y405 | – | ||||||
| locationIdentifier | string | Equipment SPLC pickup location. | – | Y404 | – | ||||||
| pickupDate | string | Date of equipment availability for pickup. | – | Y403 | – | ||||||
| epochPickupDate | integer | Date of equipment availability for pickup in epoch format. | – | – | – | ||||||
| oceanShipmentLocationCode | string |
Code indicating type of location code: Valid values include:
|
– |
Y408 =
|
– | ||||||
| oceanShipmentLocationIdentifier | string | Identifies the cargo's specific location, UN Location code. | – | Y409 | – | ||||||
| servicesTariffCode | string |
Types of services rendered and respective charges billed by the carrier. Valid values include:
|
– | TSR010-010 | |||||||
| transportServiceType | string |
Code specifying extent of transportation service requested. Valid values include:
|
– |
Y410 =
|
– | ||||||
| serviceRequirementCode | string | Code to identify a service (which may constitute an additional component to a basic contract). EDIFACT Passthrough. | – | – | TSR020-010 | ||||||
| shipmentPriority | string |
To indicate the priority of requested transport service. Valid values are:
|
– | – |
TSR030-010 =
|
||||||
| shipmentCargoType | string | It describes classification of a type of cargo. | – | – | TSR040-010 | ||||||
| description | string | Description of booking request. | – | – | – | ||||||
| equipmentTypeTemperatures | Equipment type and its required temperatures. | – | Y4 loop- W09 | – | |||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values:
|
– |
W0901 =
|
– | ||||||
| temperatureType | string |
Type of temperature follow while shipment. Valid values:
|
– | – | – | ||||||
| temperatureSetpoint | number | Temperature value setting expressed in degrees. | – | – | – | ||||||
| temperatureScale | string |
Temperature unit of measure. Valid values:
|
– |
W0903 =
|
– | ||||||
| rangeType | string |
Type of range. Valid values:
|
– | – | – | ||||||
| minTemperature | number | Equipment minimum allowable temperature. | – | W0902 | – | ||||||
| maxTemperature | number | Equipment maximum allowable temperature. | – | W0904 | – | ||||||
| unitOfMeasure | string | Temperature unit of measure, valid values includes: - CE = degree Celsius - FA = Fahrenheit | – | – | |||||||
| ventSetting | string |
To specifying equipment vent adjustment code. Valid values:
|
– |
W0907 =
|
– | ||||||
| description | string | Descriptive information about environment required in refrigerated container when other then normal air required. | – | W906 | – | ||||||
| humidityPercent | integer |
Percent in integer format. For example: 50% required, in 50. |
– | W908 | – | ||||||
| transactionReferenceIdentifierList | array | List of documents and transactions (Do not have sample data, kept this based on 315 sample data) at the header level of the message. | – | N9 & B3 | RFF and BGM | ||||||
| b2bTransactionIdentifierType | string |
Transaction reference type for X12 segments L11 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
N901 =
|
RFF010-010 =
|
||||||
| b2bTransactionIdentifierValue | string | Transaction reference identifier value defined by enumeration in transactionReferenceType defined by transaction reference type. | – |
|
|
||||||
| transactionDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – |
|
DTM010-020 when DTM010-010 = 137 (Document Date) when b2bTransactionIdentifierType =OCEANSHIPMENTBOOKINGCONFIRMATION |
||||||
| epochTransactionDate | string | Transaction reference date and time, if time available, in epoch date format. | – | – | – | ||||||
| lineItemNumber | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | ||||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.(Do not have sample data, kept this based on 315 sample data). |
– | N9 | – | ||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– |
N901 =
|
RFF010-010 =
|
||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enumeration in transactionReferenceType. | – | N902 | RFF010-020 | ||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | – | – | ||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | N904+N905 | – | ||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | ||||||
| mpcDates | array | Dates relevant for Booking Confirmation header. | – | – | – | ||||||
| dateType | string |
Date type at header level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– | – |
DTM010-010 =
|
||||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | DTM010-020 | ||||||
| epochDateValue | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | ||||||
| dateTimePeriodFormat | string |
Code specifying representation of date or time or format presented in date value, Valid values include:
|
– | – |
DTM010-030 |
||||||
| timeZone | string | Time zone for referenced dates | – | – | – | ||||||
| carrierSequenceInformation | array |
Carrier and routing sequence information for shipment. Records type of transport service provided during this shipment, city and state or province location for each carrier used for shipment. |
– | R2A | – | ||||||
| carrierSequenceCode | string |
Code identifying sequence of carriers in shipment, beginning with the original carrier. Valid values include:
|
– |
R202 |
– | ||||||
| carrierPreferenceCode | string | Sender preference code | – | R2A02 | – | ||||||
| transportMethod | string |
Transport method type. Valid values include:
|
– |
R2A03 |
– | ||||||
| carrierCode | string | Shipping carrier alpha code (SCAC). | – | R2A04 | – | ||||||
| city | string | Station or city name at which carriers interchange shipments. | – | – | – | ||||||
| state | string | Name of state or province for the shipment's current carrier sequence. | – | – | – | ||||||
| transportServiceType | string |
Types of transport service requested and respective charges billed by the carrier. Valid values inlcude:
|
– |
R2A07 =
|
– | ||||||
| description | string | Routing description. | – | – | – | ||||||
| transportStageLocationDetails | array | Transport details such as mode of transport, means of transport, its conveyance reference number and the identification of the means of transport. | – | – | TDT Group 4 | ||||||
| carrierSequenceCode | string |
Code identifying sequence of carriers in shipment, beginning with the original carrier. Valid values include:
|
– | – |
TDT010 =
|
||||||
| voyageIdentifier | string | Unique reference given by the carrier to a certain journey or departure of a means of transport (generic term). (Some customers using this as Voyage identifier and some them as using this for unique reference number and voyage number sending in REF segment, hence both are accommodated) | – | – | TDT020 | ||||||
| transportMeansType | string | Transport means type. Pass through. | – | – | TDT040-010 | ||||||
| description | string | Description for means of transport. | – | – | TDT040-020 | ||||||
| transportMethod | string |
Transport method type. Valid values include:
|
– | – | TDT030-010 | ||||||
| carrierCode | string | Shipping carrier alpha code (SCAC). | – | – | TDT050-010 | ||||||
| carrierCodeIdentifier | – | Agency codes and its referenced code list to interpret the carrier code correctly. | – | – | – | ||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. | – | – | TDT050-020 | ||||||
| codeListResponsibleAgencyType | string | Specifies the organization or responsible agency code that maintains or governs the referenced code list. | – | – | TDT050-030 | ||||||
| carrierName | string | Name of carrier. | – | – | TDT050-040 | ||||||
| transportMeansIdentifier | string | Means of transport identifier given by code list agency, in this case Lloyd's number. | – | – | TDT080-010 | ||||||
| transportMeansCodeIdentifier | – | Agency codes and its referenced code list to interpret the transport means code correctly. | – | – | – | ||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. | – | – | TDT080-020 | ||||||
| codeListResponsibleAgencyType | string | Specifies the organization or responsible agency code that maintains or governs the referenced code list. | – | – | TDT080-030 | ||||||
| vesselName | string | Name of ship as documented in "Lloyd's Register of Ships". | – | – | TDT080-040 | ||||||
| countryCode | string | Ship/Vessel registered country code - ISO 2 Alpha Country Codes. | – | – | TDT080-050 | ||||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. |
– | – | TDT-RFF | ||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– | – | RFF010-010 = VON (VOYAGEIDENTIFIER) | ||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value. | – | – | RFF010-020 | ||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02) | – | – | – | ||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | ||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | ||||||
| cargoMovementPortDetails | array | Stage/ Sequence wise carrier assigned movement details. | – | R4 Loop | TDT-LOC Loop - group5 | ||||||
| portOrTerminalDetails | – | – | – | R4 | LOC | ||||||
| portOrTerminalFunctionCode | string |
Port or Terminal function codes. Valid values include:
|
– |
R401 =
|
LOC010 |
||||||
| oceanShipmentLocationCode | string |
Code indicating type of location code: Valid values include:
|
– |
R402 =
|
– | ||||||
| locationCodeListIdentifier | – | Agency codes and its referenced code list to interpret the carrier code correctly. | – | – | – | ||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. | – | – | LOC020-020 | ||||||
| agencyCode | string | Specifies the organization or responsible agency code that maintains or governs the referenced code list. | – | – | LOC020-030 | ||||||
| oceanShipmentLocationIdentifier | string | Identities the cargo's specific location. | – | R403 | LOC020-010 | ||||||
| portName | string | Name of the port | – | R404 | LOC020-040 | ||||||
| countryCode | string | Country code | – | R405 | LOC030-010 (LOC030-020 = 162 (Country)) | ||||||
| terminalName | string | Terminal Name | – | R406 | – | ||||||
| pierIdentifier | string | Identifying number of the pier | – | R407 | LOC040-010 (LOC040-020 = 169 (Country- sub entity)) | ||||||
| state | string | State code | – | R408 | – | ||||||
| mpcDates | array | Dates relevant to location events, provision given to map to EDIFACT data | – | DTM | TDT-LOC-DTM | ||||||
| dateType | string |
Date type related to shipment events at port] in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS. Valid values include:
|
– |
DTM01 =
|
DTM010-010 |
||||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | DTM02 & DTM03 | DTM010-020 | ||||||
| epochDateValue | integer | Date defined by referenced date type generated in epoch integer date format. | – | – | – | ||||||
| dateTimePeriodFormat | string |
Code specifying representation of date or time or format presented in date value. Valid values include:
|
– | DTM04 | DTM010-030 | ||||||
| timeZone | – | – | – | – | – | ||||||
| partnerBusinessInformation | array | Business Parties identifiers and address information. | – | N1 | NAD | ||||||
| partnerEntityType | string |
Denotes type of the entity involved in this business transaction. Valid values include:
|
– |
N101 |
NAD01 |
||||||
| businessName | string | Business name for partner or location. | – | N102 | NAD030-010 | ||||||
| additionalBusinessName | string | Additional Business name for partner or location. | – | N201 | NAD040-020 | ||||||
| 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 |
NAD020-030 |
||||||
| companyIdentifierValue | string | Company identifier value for business partner. | – | N104 | NAD020-010 | ||||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | ||||||
| address | – | Party address information. | – | N3, N4, | – | ||||||
| address1 | string | Main street address. | – | N301 | NAD050-010 | ||||||
| address2 | string | Supplemental street address. | – | N302 | NAD050-020 | ||||||
| city | string | City | – | N401 | NAD060 | ||||||
| district | string | District | – | – | – | ||||||
| state | string | State or region code | – | N402 | NAD070-010 | ||||||
| postalCode | string | Postal code | – | N403 | NAD080 | ||||||
| country | string | Country code | – | N404 | NAD090 | ||||||
| telephone | string | Telephone number | – | – | – | ||||||
| fax | string | Fax number | – | – | – | ||||||
| url | string | Website URL | – | – | – | ||||||
| buildingNumber | string | Building number | – | – | – | ||||||
| plantNumber | string | Plant number | – | – | – | ||||||
| floorNumber | string | Floor number in building | – | – | – | ||||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | ||||||
| village | string | Village name | – | – | – | ||||||
| houseNumber | string | House number | – | – | – | ||||||
| township | string | Township | – | – | – | ||||||
| premisesCode | string | Premises code | – | – | – | ||||||
| companyLocationContactInformation | – | – | – | N1-G61 | Segment loop NAD-CTA | ||||||
| contactType | string |
Contact type. Valid values include:
|
– |
G6101 =
|
CTA010 =
|
||||||
| contactName | string | Contact name | – | G6102 | CTA020-020 | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number | – | G6104 where G6103 = "TE" | COM010-010 where COM010-020 = "TE" | ||||||
| contactEmail | string | Contact email address | – | G6104 where G6103 = "EM" | COM010-010 where COM010-020 = "EM" | ||||||
| mpcAdditionalAddressInformation | – | Additional address information that is not included in addressTypeDefinition. | – | – | – | ||||||
| externalERPUserName | string | External ERP system user name for user who generated message. | – | – | – | ||||||
| organizationCode | string | Code for organization responsible for generating the message. | – | – | – | ||||||
| organizationDescription | string | Description of the organization responsible for generating the message. | – | – | – | ||||||
| groupCode | string | Code identifying group responsible for generating the message. | – | – | – | ||||||
| language | string | Language key for message. | – | – | – | ||||||
| languageCode | string | ISO language code for message. | – | – | – | ||||||
| referenceIdentifier | string | Partner reference identifier. | – | – | – | ||||||
| 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 | – | ||||||
| specialHandlingInformation | array |
Special handling instructions for shipment. All parameters to be understood in the form of different codes used by industry, (typeDef created as part of X12 210). |
– | Segment H3 | – | ||||||
| handlingCode | string |
Code specifying special transportation handling instructions. Valid Values included:
|
– |
H301 =
|
– | ||||||
| description | string | Free-form additional description of special handling instructions to appear on printed bill if special handling code is not adequate. | – | H302 | – | ||||||
| protectiveServiceCode | string | To specify perishable protective service - rail carriers only. | – | H303 | – | ||||||
| ventInstructionCode | string | To specifying extra and careful instructions. | – | H304 | – | ||||||
| applicationTariffCode | string |
Code indicating to which traffic a tariff applies. Valid values are:
|
– |
H305 =
|
– | ||||||
| vesselDetails | araay | Vessel identifier information | – | V1 | – | ||||||
| vesselIdentifier | string | Vessel Identifier | – | V101 | – | ||||||
| vesselCodeType | string |
Vessel code providing agency code, Valid values :
|
– |
V108 =
|
– | ||||||
| vesselName | string | Name of ship as documented in "Lloyd's Register of Ships". | – | V102 | – | ||||||
| countryCode | string | Ship/Vessel registered country code. | – | V103 | – | ||||||
| voyageIdentifier | string | Voyage identifier on which the cargo travels. | – | V104 | – | ||||||
| carrierCode | string | Identifies Ocean Carrier SCAC code. | – | V105 | – | ||||||
| transportMethod | string |
Transport method type. Valid values include:
|
– | V109 | – | ||||||
| freeTextNote | array | Ship to party company identifiers and address information. | – | – | FTX | ||||||
| textReferenceCode | string | Text reference or subject code. Will map whatever is found. | – | – | FTX030-010 | ||||||
| textFunctionCode | string | Text function code. Will map whatever is found. | – | – | FTX020 | ||||||
| language | string | Language of free text. | – | – | FTX050 | ||||||
| textFormatCode | string | Format code for free text. | – | – | FTX060 | ||||||
| freeText | string | Free test string. | – | – | FTX040-010 | ||||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. | – | – | – | ||||||
| name | string | Name of mapped field. | – | – | – | ||||||
| value | string | Value in named field. | – | – | – | ||||||
| canonicalShipmentBookingConfirmationItemDetails | array | Details for the canonical Booking Confirmation message. | – | LX Loop (Mandatory) | – | ||||||
| lineItemNumber | string | transaction set line number. | – | LX01 (Mandatory) | – | ||||||
| equipmentDetails | array | Shipment equipment details. | – | N7 | EQD | ||||||
| equipmentPrefix | string | Prefix or alphabetic part of an equipment unit's identifying number. | – | N701 | – | ||||||
| equipmentIdentifier | string | Sequencing or serial part of an equipment unit's identifying number. | N702 | EQD020-010 | |||||||
| equipmentCodeIdentifier | Agency codes and its referenced code list to interpret the transport means code correctly. | – | – | – | |||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. - EDIFACT pass through. | – | – | EQD020-020 | ||||||
| agencyCode | string | Specifies the organization or agency codethat maintains or governs the referenced code list. - EDIFACT pass through. | – | – | EQD020-030 | ||||||
| carrierCode | string | Carrier code for shipper. | – | N712 | – | ||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values:
|
– |
N711 =
|
EQD010 =
|
||||||
| equipmentTypeISOCode | string | Equipment type ISO code. | – | N722 | EQD030-010 when EQD030-030 = 5 (ISO) | ||||||
| equipmentSizeCodeIdentifier | Agency codes and its referenced code list to interpret the transport means code correctly. | – | – | – | |||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. | – | – | EQD030-020 | ||||||
| agencyCode | string | Specifies the organization or agency code that maintains or governs the referenced code list. | – | – | EQD030-030 | ||||||
| description | string | Equipment type free form text description. | – | – | EQD030-040 | ||||||
| equipmentSupplier | string |
Equipment supplied party. Valid values :
|
– | – |
EQD040 =
|
||||||
| equipmentLoadIndicator | string |
Indicate the extent of equipment utilized for this consignment. Valid values:
|
– | – |
EQD060 =
|
||||||
| 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 | – | ||||||
| transportServiceType | string |
Types of transport service requested which may differ from contract conditions. Valid values are:
|
– |
N719 =
|
TMD010-010 | ||||||
| serviceTypeDescription | string | Free form description of movement or extended service carrying. | – | – | TMD010-020 | ||||||
| serviceProvidedParty | string |
Equipment haulage arrangements done by. Valid values include:
|
– | – | TMD030 | ||||||
| equipmentDimensions | array | Dimensions of equipment / transportable unit | – | Segment N7 | EQD-DIM | ||||||
| dimensionType | string |
Type of dimensions recorded for cargo / transportable unit. Valid values include:
|
– | – | – | ||||||
| dimensionsValue | Number | Volume for item in inches or centimeters. | – |
|
|
||||||
| unitOfMeasure | string | Dimension unit of measure for parent packaging. | – | – | DIM020-010 | ||||||
| itemQuantity | array | Equipment quantity. | – | – | EQD - EQN | ||||||
| quantityType | string |
Type of quantity recorded. Valid values:
|
– | – | – | ||||||
| quantityValue | number | Quantity of product in shipment | – | – | EQN010-010, when EQN010-020 = 2 | ||||||
| unitOfMeasure | string |
Unit or Basis for Measurement Code. Unit of entry UOM's include:
|
– | – | – | ||||||
| shipmentMeasurements | array | Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. | – | – | segment MEA in EQD loop | ||||||
| measurementType | string |
Code identifying a measurement type for a measurement value. The valid values includes |
– | – |
MEA010 = AAE (MEASUREMENT) |
||||||
| measurementValue | string | The value of the measurement | – | – | MEA030-020 | ||||||
| unitOfMeasure | string |
Unit of measure for the measurement type and value recorded. Valid values includes:
|
– | – |
MEA030-010 =
|
||||||
| measuredType | string |
Code identifying a measured type for a measured value. Valid values include:
|
– | – |
MEA020-010 =
|
||||||
| equipmentTypeTemperatures | Equipment type and its required temperatures. | – | W09 | – | |||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values:
|
– |
W0901 =
|
EQD010 =
|
||||||
| temperatureType | string |
Type of temperature follow while shipment. Valid values:
|
– | – |
TMP010 =
|
||||||
| temperatureSetpoint | number | Temperature value setting expressed in degrees. | – | – | TMP020-010 | ||||||
| temperatureScale | string |
Temperature unit of measure. Valid values:
|
W0903 =
|
TMP020-020=
|
|||||||
| rangeType | string |
Type of range. Valid values:
|
– | – |
RNG010 =
|
||||||
| minTemperature | number | Equipment minimum allowable temperature. | – | W0902 | – | ||||||
| maxTemperature | number | Equipment maximum allowable temperature. | – | W0904 | – | ||||||
| unitOfMeasure | string |
Temperature unit of measure. Valid values includes:
|
– | – |
RNG020-010 =
|
||||||
| ventSetting | string |
To specifying equipment vent adjustment code. Valid values:
|
– |
W0907 =
|
– | ||||||
| description | string | Descriptive information about environment required in refrigerated container when other then normal air required. | – | W906 | – | ||||||
| humidityPercent | integer | Percent in integer format , example: 50% required, in 50. | – | W908 | – | ||||||
| equipmentSealNumbers | array | Shipment carrying equipments seal numbers. | – | – | – | ||||||
| sealNumber | string | Applied seal number for shipment carrying equipment. | – | – | – | ||||||
| sealAppliedEntityType | string |
Seal applied entity type code, it could be an organization or location or an individual. Valid values include:
|
– | – | – | ||||||
| dangerousGoodsInformation | array | Describes the details of the dangerous goods in the booking/shipment. This group will be populated only when "isDangerous" is true. | – | – | EQD-DGS Loop | ||||||
| shipmentDerivedRisk | string | It describes the risks involved while shipping dangerous goods. It can be more specific based on UN code. | – | – | DGS030-010 | ||||||
| shipmentDerivedSubRisk | string | It describes the sub-risks involved while shipping dangerous goods. It can be more specific based on UN code. | – | – | – | ||||||
| shipmentFlashPoint | string | Temperature value indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” | – | – | DGS040-010 | ||||||
| isLimitedQuantity | boolean |
Check point, if the dangerous goods quantity is limited in the shipment.
|
– | – | – | ||||||
| isMarinePollutant | boolean |
Check point, if the dangerous goods are pollutant into water.
|
– | – | – | ||||||
| packagingGroup | string | Dangerous goods packaging group | – | – | DGS050 | ||||||
| designatedDangerousGoodsName | string | The UN proper shipping name derived from the mandatory UN code. If supplied, this value shall correspond to the proper shipping name stored for the provided UN code. | – | – | DGS Loop-FTX040-010 (when FTX030-010 = PSN and FTX010 = AAD) | ||||||
| designatedTechnicalName | string | Designated technical name for carrier identity. | – | – | DGS Loop-FTX040-010 (when FTX030-010 = TN and FTX010 = AAD) | ||||||
| designatedTechnicalNationalName | string | Designated technical name for carrier and international identity. | – | – | – | ||||||
| minTemperatureValue | Number | It describes from temperature | – | – | – | ||||||
| maxTemperatureValue | Number | It describes to temperature | – | – | – | ||||||
| temperatureScale | string |
Temperature unit of measure. Valid values:
|
– | – |
DGS040-020=
|
||||||
| dangerousGoodsType | string |
There are different types of goods which are shipped globally. Multiple organizations has their own usage. Widely used codes are:
|
– | – |
DGS010 =
|
||||||
| dangerousGoodsIdentifier | Number String | Dangerous goods identifier. | – | – | DGS020 -010 | ||||||
| additionalDangerousGoodsIdentifier | String | Additional Dangerous goods identifier. | – | – | DGS140-010 | ||||||
| dangerousGoodsPackagedQuantity | Number | Packaged quantity of dangerous goods. | – | – | – | ||||||
| hazardousGoodsPackageType | string |
Package type containing these dangerous goods. Possible values are:
|
– | – | DGS120 | ||||||
| netQuantityUnit | string | Net quantity unit of the dangerous goods. | – | – | – | ||||||
| grossQuantityUnit | string | Gross quantity unit of the dangerous goods. | – | – | – | ||||||
| isEmpty | boolean |
To check if package is empty.
|
– | – | – | ||||||
| dangerousGoodsItemQuantity | array | Dangerous Goods item quantity related information to identify quantity, UOM and value. | – | – | – | ||||||
| dangerousGoodsQuantityType | string |
Type of quantity recorded. Valid value:
|
– | – | – | ||||||
| dangerousGoodsQuantityValue | Number | Quantity of product at line item level. | – | – | – | ||||||
| dangerousGoodsQuantityUOM | string | Quantity unit of measure in master data for dangerous goods | – | – | – | ||||||
| contactInformation | array | Dangerous goods contact information. | – | – | CTA | ||||||
| contactType | string |
Contact type. Valid values include:
|
– | – |
CTA010 =
|
||||||
| contactName | string | Contact name. | – | – | CTA020-020 | ||||||
| contactTitle | string | Title of contact. | – | – | – | ||||||
| contactPhone | string | Contact phone number. | – | – | COM010-010 where COM010-020 = "TE" | ||||||
| contactEmail | string | Contact email address. | – | – | COM010-010 where COM010-020 = "EM" | ||||||
| freeTextNote | array | Free-form hazardous material descriptive data in addition to the information provided in the H1 segment. | – | – | FTX | ||||||
| textReferenceCode | string | Text reference or subject code. | – | – | FTX010-010 | ||||||
| textFunctionCode | string | Text function code. | – | – | FTX030-010 | ||||||
| language | string | Language of free text. | – | – | FTX050 | ||||||
| textFormatCode | string | Format code for free text. | – | – | FTX060 | ||||||
| freeText | string, array | Free test string. | – | – | FTX040-010 | ||||||
| shipmentBookingConfirmationItemDetails | array | Each shipment item details such as quantity, measurement , packing and other details. | – | LX- L0 loop | GID Loop | ||||||
| ladingItemMeasurementServiceDetails | Item details to specify quantity, weight, volume, and type of service for a line item including applicable quantities | – | Segment: L0 | Segment GID | |||||||
| lineItemNumber | string | Sequential line number for freight invoice item | – | L001 | GID010 | ||||||
| billedQuantityType | string |
Code indicating the type of quantity or value used as the basis for calculating the rate or item pricing (e.g., weight, volume, miles, or value). valid values include:
|
– |
L003 =
|
– | ||||||
| billedQuantityValue | string | Numeric value representing the quantity or amount on which the rate or item pricing is based, corresponding to the specified pricing basis type. | – | L002 | – | ||||||
| packagingFormatCode | string |
Packing form of lading quantity. valid values include:
|
– |
L009 |
GID020-020 |
||||||
| packagingCodeIdentifier | Agency codes and its referenced code list to interpret the transport means code correctly. | – | – | – | |||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. | – | – | GID020-030 | ||||||
| agencyCode | string | Specifies the organization or agency code that maintains or governs the referenced code list. | – | – | GID020-040 | ||||||
| ladingQuantity | number | Number of handling units of the line item tendered to carrier. | – | L008 | GID020-010 | ||||||
| description | string | Material used to protect lading. | – | L010 | GID020-050 | ||||||
| weightUnitType | string |
Type of weight recorded. Valid values include:
|
– |
L011 =
|
– | ||||||
| transportServiceType | string |
Types of transport service requested and respective charges billed by the carrier. Valid values are:
|
– |
L012 =
|
TMD01 | ||||||
| weightType | string |
Type of weight recorded. Valid values include:
|
– | L005 | – | ||||||
| weightValue | Number | Weight of product at PO line item | – | L004 | – | ||||||
| volumeType | string |
Type of weight recorded. Valid values include:
|
– | L007 | – | ||||||
| volumeValue | Number | Volume for item | – | L006 | – | ||||||
| isVerificationRequired | boolean |
Describes whether the carrier will be required to verify the number of units contained on a pallet, slip sheet or skid.
|
– |
L015 =
|
– | ||||||
| packageVerificationFormatCode | string |
Packing form of counting required quantity. Valid values:
|
– |
L014 =
|
– | ||||||
| packageVerificationQuantity | number | Total number of boxes, cartons, or pieces contained on a pallet, skid, or slip sheet for the line item. | – | L013 | – | ||||||
| handlingMovementInstruction |
Handling movement instructions group mapping to line item level. General handling instructions for goods, products, containers, and other articles. |
– | – | GID- HAN | |||||||
| handlingInstructionCode | string |
Handling instruction description code. Valid values include:
|
– | – |
HAN010-010 |
||||||
| instructionIdentifier | string | Identification code defined by a user or organization maintained code list, ie, GS1. Codes for this data element are provided by attribute agencyCode. | – | – | HAN010-020 | ||||||
| agencyCode | string | Code identifying the global or national agency responsible for the message format. | – | – | HAN010-030 | ||||||
| description | string | Description of the handling movement status code. | – | – | – | ||||||
| itemTemperature | array | Temperature setting required for goods items. | – | – | GID-TMP | ||||||
| temperatureType | string |
Type of temperature follow while shipment. Valid values:
|
– | – |
TMP010 =
|
||||||
| temperatureSetpoint | number | Temperature value setting expressed in degrees | – | – | TMP020-010 | ||||||
| temperatureScale | string |
Temperature unit of measure. Valid values includes:
|
– | – |
TMP020-020=
|
||||||
| humidityPercent | integer | Percent in integer format , example: 50% required, in 50. | – | – | – | ||||||
| description | string | Descriptive information about environment required for item. | – | – | – | ||||||
| itemTemperatureRange | array | Temperature range setting details required to be maintained during throughout transport for goods items. | – | – | GID-RNG | ||||||
| rangeType | string |
Type of range. Valid values:
|
– | – |
RNG010 =
|
||||||
| minimumValue | number | Shipment minimum allowable temperature | – | – | RNG020-020 | ||||||
| maximumValue | number | Shipment maximum allowable temperature | – | – | RNG020-030 | ||||||
| unitOfMeasure | string |
Temperature unit of measure. Valid values includes:
|
– | – |
RNG020-010 =
|
||||||
| description | string | Descriptive information about environment required for goods item. | – | – | – | ||||||
| locationDetails | Location or country details related to item in transport, such as country of origin, destination. | – | – | GID-LOC | |||||||
| portOrTerminalFunctionCode | string |
Port or Terminal function codes. Valid values include:
|
– | – |
LOC010 |
||||||
| oceanShipmentLocationIdentifier | string | Identifies the cargo's specific location. | – | – | LOC020-010 | ||||||
| locationCodeListIdentifier | Agency codes and its referenced code list to interpret the carrier code correctly. | – | – | – | |||||||
| codeListIdentifier | string | Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly. | – | – | LOC020-020 | ||||||
| agencyCode | string | Specifies the organization or responsible agency code that maintains or governs the referenced code list. | – | – | LOC020-030 | ||||||
| portName | string | Name of the port | – | – | LOC020-040 | ||||||
| countryCode | string | Country code | – | – | LOC030-010 (LOC030-020 = 162 (Country)) | ||||||
| terminalName | string | Terminal Name | – | – | – | ||||||
| state | string | State code | – | – | LOC040-010 (LOC040-020 = 169 (Country- sub entity)) | ||||||
| shipmentMeasurements | array | Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. | – | – | segment MEA in GID loop | ||||||
| measurementType | string |
Code identifying a measurement type for a measurement value. The valid values includes |
– | – |
MEA010 = AAE (MEASUREMENT) |
||||||
| measurementValue | string | The value of the measurement. | – | – | MEA030-020 | ||||||
| unitOfMeasure | string |
Unit of measure for the measurement type and value recorded. Valid values includes:
|
– | – |
MEA030-010 =
|
||||||
| measuredType | string |
Code identifying a measured type for a measured value. Valid values include:
|
– | – |
MEA020-010 =
|
||||||
| shipmentDimensions | array | Dimensions of freight. | – | – | GID-DIM | ||||||
| dimensionsType | string |
Type of dimensions recorded for freight. Valid values include:
|
– | – | – | ||||||
| dimensionsValue | Number | Volume for item in inches | – |
L401
|
|
||||||
| unitOfMeasure | string |
Dimension unit of measure for parent packaging.
|
– |
L404 =
|
DIM020-010 |
||||||
| dangerousGoodsInformation | array | Describes the details of the dangerous goods in the booking/shipment. This group will be populated only when "isDangerous" is true. | – | H1 Loop | GID-DGS Loop | ||||||
| shipmentDerivedRisk | string | It describes the risks involved while shipping dangerous goods. It can be more specific based on UN code. | – | H102 | DGS030-010 | ||||||
| shipmentDerivedSubRisk | string | It describes the sub-risks involved while shipping dangerous goods. It can be more specific based on UN code. | – | H106 | – | ||||||
| shipmentFlashPoint | string | Temperature value indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” | – | H107 | DGS040-010 | ||||||
| isLimitedQuantity | boolean |
Check point, if the dangerous goods quantity is limited in the shipment.
|
– | – | – | ||||||
| isMarinePollutant | boolean |
Check point, if the dangerous goods are pollutant into water.
|
– | – | – | ||||||
| packagingGroup | string | Dangerous goods packaging group | – | H109 | DGS050 | ||||||
| designatedDangerousGoodsName | string | The UN proper shipping name derived from the mandatory UN code. If supplied, this value shall correspond to the proper shipping name stored for the provided UN code. | – | – | DGS Loop-FTX040-010 (when FTX030-010 = PSN and FTX010 = AAD) | ||||||
| designatedTechnicalName | string | Designated technical name for carrier identity. | – | – | DGS Loop-FTX040-010 (when FTX030-010 = TN and FTX010 = AAD) | ||||||
| designatedTechnicalNationalName | string | Designated technical name for carrier and international identity. | – | – | – | ||||||
| minTemperatureValue | Number | It describes from temperature | – | – | – | ||||||
| maxTemperatureValue | Number | It describes to temperature | – | – | – | ||||||
| temperatureScale | string |
Temperature unit of measure. Valid values:
|
– |
H108 =
|
DGS040-020=
|
||||||
| dangerousGoodsType | string |
There are different types of goods which are shipped globally. Multiple organizations has their own usage. Widely used codes are:
|
– |
H103 =
|
DGS010 =
|
||||||
| dangerousGoodsIdentifier | Number String | Dangerous goods identifier. | – | H101 | DGS020 -010 | ||||||
| additionalDangerousGoodsIdentifier | String | Additional Dangerous goods identifier. | – | – | DGS140-010 | ||||||
| dangerousGoodsPackagedQuantity | Number | Packaged quantity of dangerous goods | – | – | – | ||||||
| hazardousGoodsPackageType | string |
Package type containing these dangerous goods. Possible values are:
|
– | – | DGS120 | ||||||
| netQuantityUnit | string | Net quantity unit of the dangerous goods. | – | – | – | ||||||
| grossQuantityUnit | string | Gross quantity unit of the dangerous goods. | – | – | – | ||||||
| isEmpty | boolean |
To check if package is empty.
|
– | – | – | ||||||
| dangerousGoodsItemQuantity | array | Dangerous Goods item quantity related information to identify quantity. | – | – | – | ||||||
| dangerousGoodsQuantityType | string |
Type of quantity recorded. Valid value:
|
– | – | – | ||||||
| dangerousGoodsQuantityValue | Number | Quantity of product at line item level. | – | LH102 | – | ||||||
| dangerousGoodsQuantityUOM | string | Quantity unit of measure in master data for dangerous goods. | – | LH101 | – | ||||||
| contactInformation | array | Dangerous goods contact information. | – | – | CTA | ||||||
| contactType | string |
Contact type. Valid values include:
|
– | – |
CTA010 =
|
||||||
| contactName | string | Contact name. | – | H105(Can contain email, name, phone number) | CTA020-020 | ||||||
| contactTitle | string | Title of contact | – | – | – | ||||||
| contactPhone | string | Contact phone number. | – | H105 | COM010-010 where COM010-020 = "TE" | ||||||
| contactEmail | string | Contact email address. | – | H105 | COM010-010 where COM010-020 = "EM" | ||||||
| freeTextNote | array | Free-form hazardous material descriptive data in addition to the information provided in the H1 segment. | – | H2 | FTX | ||||||
| textReferenceCode | string | Text reference or subject code. | – | – | FTX010-010 | ||||||
| textFunctionCode | string | Text function code. | – | – | FTX030-010 | ||||||
| language | string | Language of free text. | – | – | FTX050 | ||||||
| textFormatCode | string | Format code for free text. | – | – | FTX060 | ||||||
| freeText | string, array | Free test string. | – | H201,H202 | FTX040-010 | ||||||
| shipmentMeasurements | array | Specifies dangerous goods physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights. | – | – | Segment MEA in GID/DGS loop | ||||||
| measurementType | string |
Code identifying a measurement type for a measurement value. The valid values includes: |
– | – |
MEA010 = AAE (MEASUREMENT) |
||||||
| measurementValue | string | The value of the measurement. | – | – | MEA030-020 | ||||||
| unitOfMeasure | string |
Unit of measure for the measurement type and value recorded. Valid values includes:
|
– | – |
MEA030-010 =
|
||||||
| measuredType | string |
Code identifying a measured type for a measured value. Valid values include:
|
– | – |
MEA020-010 =
|
||||||
| ladingItemRateCharges | array | Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements. | – | Under LX loop: Segment: L1 (Line item number of L501, L001, L101 and LX01 should match for every loop of LX) | – | ||||||
| lineItemNumber | string | Sequential line number for freight invoice item. | – | L101 | – | ||||||
| freightRatesChargesIdentifier | string | Identification of a charge by code and/or by name. Describes about freight and other charges, it can be combination of freight costs, type and charges description. | – | – | – | ||||||
| freightRate | number | Rate that applies to the specific commodity. | – | L102 | – | ||||||
| freightRateType | string |
Qualifiers to extend charges or interpret or calculate value. Valid values are:
|
– |
L103 =
|
– | ||||||
| totalCharges | number | Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency. | – | L104 (implied 2 decimal points) | – | ||||||
| advancePayment | number | Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency. | – | L105 (implied 2 decimal points) | – | ||||||
| prepaidAmount | number | Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency. | – | L106 (implied 2 decimal points) | – | ||||||
| rateCombinationPointCode | string |
The code denoting the connecting station for a joint rate obtained by combining two or more published rates which are used for the calculation of transportation charges. Valid values are:
|
– | – | |||||||
| specialChargeCode | string |
Type of special charge or allowance allowed. Valid values include:
|
– |
L108 =
|
– | ||||||
| rateClassCode | string |
Identifies specific & designated class of goods. Note: For international air shipments, see IATA Resolution 600k. Valid values include:
|
– |
L109 =
|
– | ||||||
| chargeEntitlementParty | string |
To describe the types of party involved. Valid values:
|
– |
L110 =
|
– | ||||||
| chargePaymentMethod | string |
Payment method for freight invoice charges. Valid values:
|
– |
L111 =
|
– | ||||||
| description | string | Identification of special charge; this data element is used whenever an applicable code cannot be found under rate handling code. | – | L112 | – | ||||||
| billedQuantityType | string |
Type of billed quantity recorded. Valid values include:
|
– |
L118 =
|
– | ||||||
| billedQuantityValue | number | Quantity of product in delivery. | – | L117 | – | ||||||
| freightRatePercent | number | Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%). | – | L119 | – | ||||||
| currencyCode | string | Billed Currency Code. | – | L120 | – | ||||||
| rateOrTariffClassDescription | string | Free form description of an applicable rate or tariff class. | – | – | – | ||||||
| ladingItemDetails | array | Lading line item in terms of description, packaging, and marks and numbers. | – | L5 | – | ||||||
| lineItemNumber | number | Sequential line number for a lading item. | – | L501 | – | ||||||
| description | string | Description of an item as required for rating and billing purposes. | – | L502 | – | ||||||
| commodityCode | string | Describes about a commodity or group of commodities. | – | L503 | – | ||||||
| commoditySystemType | string |
Describes the commodity coding system used for Commodity Code. Valid values included:
|
– |
L504=
|
– | ||||||
| packagingFormatMaterialType | string |
Code identifying type of material used. Valid values included :
|
– |
L505 =
|
– | ||||||
| packagingIdentifierType | string | Packaging identifier type. Pass thru mapping for X12. | – | L507 | L | ||||||
| packagingIdentifier | string | Packaging identifier value defined by the packaging type. | – | L506 | – | ||||||
| freeTextNote | array | Ship to party company identifiers and address information. | – | K1 | FTX | ||||||
| textReferenceCode | string | Text reference or subject code. | – | – | FTX010-010 | ||||||
| textFunctionCode | string | Text function code. | – | – | FTX030-010 | ||||||
| language | string | Language of free text. | – | – | FTX050 | ||||||
| textFormatCode | string | Format code for free text. | – | – | FTX060 | ||||||
| freeText | string, array | Free test string. | – | K101, K102 | FTX040-010, FTX040-020 | ||||||
| transactionReferenceIdentifierList | array | List of documents and transactions at the header level of the message (Do not have sample data, kept this based on 315 sample data). | – | – | – | ||||||
| b2bTransactionIdentifierType | string | Transaction reference type for X12 segments L11 and EDIFACT RFF for general reference data that is not a transaction document identifier. | – | – | – | ||||||
| b2bTransactionIdentifierValue | string | Transaction reference identifier value defined by enum in transactionReferenceType defined by transaction reference type. | – | – | – | ||||||
| transactionDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | ||||||
| epochTransactionDate | string | Transaction reference date and time, if time available, in epoch date format | – | – | – | ||||||
| lineItemNumber | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | ||||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.(Do not have sample data, kept this based on 315 sample data). |
– | – | – | ||||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include:
|
– | – | – | ||||||
| transactionReferenceIdentifier | string | Transaction reference identifier value. | – | – | – | ||||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | – | – | ||||||
| transactionReferenceDate | string | Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | ||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | ||||||
| mpcDates | array | Dates relevant to shipments events at port, does not have any X12 or EDIFACT related segment, kept as place holder. | – | – | – | ||||||
| dateType | string |
Date type related to shipment events at port] in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS. Valid values include:
|
– | – | – | ||||||
| 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. Each string date recorded will have an epoch date format generated by a java exit. | – | – | – | ||||||
| timeZone | string | Time zone for referenced dates. | – | – | – | ||||||
| freeTextNote | array | Ship to party company identifiers and address information. | – | – | FTX | ||||||
| textReferenceCode | string | Text reference or subject code. | – | – | FTX030-010 | ||||||
| textFunctionCode | string | Text function code. | – | – | FTX020 | ||||||
| language | string | Language of free text. | – | – | FTX050 | ||||||
| textFormatCode | string | Format code for free text. | – | – | FTX060 | ||||||
| freeText | string | Free test string. | – | – | FTX040-010 | ||||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. | – | – | – | ||||||
| name | string | Name of mapped field. | – | – | – | ||||||
| value | string | Value in named field. | – | – | – | ||||||
| canonicalShipmentBookingConfirmationEventDetails | array | To report events occurred during ocean, rail, air shipments. | – | – | – | ||||||
| shipmentEventType | string |
Code to specify type of the ocean shipment event. Valid values include:
|
– |
V901 -
|
– | ||||||
| eventName | string | Event descriptive information | – | V902 | – | ||||||
| transportEventTimeStamp | string | Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | V903 & V904 | – | ||||||
| epochTransportEventTimeStamp | integer | Event date and time in epoch format. | – | – | – | ||||||
| timeZone | string | Time zone code. | – | V913 | – | ||||||
| city | string | Event city. | – | V905 | – | ||||||
| state | string | State code. | – | V906 | – | ||||||
| countryCode | string | Event Country code. | – | V907 | – | ||||||
| equipmentTypeTemperatures | Equipment type and its required temperatures. | – | – | – | |||||||
| equipmentType | string |
Type of equipment used in delivery. Valid values:
|
– | – | – | ||||||
| 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. | – | – | – | ||||||
| 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. | – | – | – | ||||||
| name | string | Name of mapped field. | – | – | – | ||||||
| value | string | Value in named field. | – | – | – | ||||||
Tag end


