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 request canonical guidelines

The Ocean Shipment Booking Request, also known as a Reservation Request, is an electronic transaction used to initiate the process of securing transportation space with an ocean carrier, freight forwarder, or inter-modal provider. It serves as the digital equivalent of a booking form, allowing shippers and their logistics partners to request vessel or transport space for upcoming shipments. This transaction belongs to the ANSI ASC X12 EDI standard and is widely implemented across the maritime and intermodal logistics industry, particularly for containerized freight 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. – – –
  canonicalShipmentBookingRequestHeader – Header details for the canonical booking request message canonical. – B1 BGM
    processingFunctionTypeCode string

Processing function, transaction set purpose code.

Valid values include:

  • CREATE

  • CHANGE

  • CANCEL

  • ORIGINAL

  • REPLACE

  • STATUS

  • CONFIRM

– -

BGM030 =

  • 8 (STATUS) or

  • 9 (ORIGINAL)

  • 1 (CANCEL)

  • 6 (CONFIRM)

    carrierCode string Shipping carrier alpha code (SCAC) – B101 (if version is 4040 or less optional, other wise mandatory) Y103 RFF02 when RFF01 = AAZ
    shipmentBookingStatus string

Code specifying status of the booking request.

Valid values include:

  • CONFIRMED - Booking request accepted

  • CONDITIONAL - Conditionally accepted

  • ALTERNATIVEOFFER - Counter proposal made by carrier with different options

  • CANCELLED - Reservation canceled

  • REJECTED - Reservation declined before its confirmation

  • RECEIVED - New request received

 –

B104

BGM040

    isPartialLoad boolean

Code specifying partial load allowed.

Valid values:

  • True - Partial load allowed

  • False - Partial load not allowed.

 – B105 = Y (true) Or N (false) –
    bookingDeclineReasonCode string

Code specifying reason behind booking cancel by carrier or customer.

Valid values include:

  • CAPACITYTYPE - Carrier cannot accept because the type of requested space/capacity isn’t offered

  • CAPACITY - Carrier offers that capacity type, but it’s currently full/ unavailable

  • EQUIPMENTTYPE - The requested equipment type isn’t supported.

  • EQUIPMENT - The equipment is unavailable

 –

B106

–
    shipmentChargePaymentMethodType string

Payment terms for transportation charges.

Valid values:

  • COLLECT

  • PREPAIDSELLER

  • SELLER

  • THIRDPARTYPAY

  • ADVANCECOLLECT

  • ADVANCEPREPAID

  • BUYER

  • BUYERSELLERDEFINED

–

B107 =

  • CC (COLLECT) or

  • PA (ADVANCEPREPAID) or

  • PO (PREPAIDONLY) or

  • PP (PREPAIDSELLER) or

  • PS (SELLER) or

  • TP (THIRDPARTYPAY) or

  • CA (ADVANCECOLLECT) or

  • BP (BUYER) or

  • DF(BUYERSELLERDEFINED)

–
    companyLocationContactInformation array Contact information for party business or location. – G61 CTA
      contactType string

Contact type.

Valid values include:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

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

  • EMERGENCY - Emergency contact for dangerous goods

  • SENDER - Message sender contact

 –

G6101 =

  • IC (INFORMATION) or

  • FW (FORWARDER)

CTA010 =

  • IC (INFORMATION) or

  • OC (ORDERCONTACT)

  • CW (CONFIRMEDWITH)

  • HE (EMERGENCY)

  • MS (SENDER)
      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"
    shipmentBookingAuthorization array Contact information for party business or location. – Y6 –
      shipmentBookingAuthorityCode string

Code indicates about the personal authorized for shipment booking.

Valid values include:

  • BILLINGCLERK - Billing Clerk

  • RATECLERK - Rate Clerk

  • CARRIER - Carrier

  • FORWARDER - Freight Forwarder

  • LENDER - Lending Official

  • SHIPPER - Shipper

  • PROPOSER - The authority authorizing the submission of a proposal

 –

Y601 =

  • BC (BILLINGCLERK) or

  • RC (RATECLERK) or

  • CA (CARRIER) or

  • FN (FORWARDER) or

  • LO (LENDER) or

  • PP (PROPOSER) or

  • SH (SHIPPER)

 –
      shipmentBookingAuthorityName string Name or code of authority for authorizing action or reservation. – Y602 –
      shipmentBookingAuthorizationDate string Shipment Booking Authorization date from port in format YYYYMMDD. – Y603 –
    cargoBookingPriorityDetails   Contact information for party business or location. – Y7 –
      isShipmentOnPriority boolean

Code specifying if shipment to be prioritized or not,

valid values:

  • True - Yes, it is priority

  • False - No, not required to be prioritized

 – Y702 = 1 (true) Or 0 (false) –
      shipmentPriorityLevelType string Code specifying the level of priority for shipment. 1 indicates highest priority leads up to 9 being lowest priority. – Y703 & Y701 –
      shipperAssignedPortCallFileNumber Number It is a type of reference number assigned by a shipper, while booking a shipment. – Y704 –
      shipmentRequiredDate string Expected shipment Required date from port in format YYYYMMDD. – Y705 –
    spaceReservationRequestInformation   Contact information for party business or location. – Y1 –
      estimatedShipmentSailingDate string Estimated shipment Sailing Date from port in format YYYYMMDD. – Y101 –
      dateValue string

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

–

Y102, when dateType =

  • PROMISEDDELIVERY or

  • ESTIMATEDARRIVAL

 –
      transportMethod string

Transport method type.

Valid values include:

Valid values include:

  • TRUCK - Truck

  • RAIL - Shipped by train

  • SEA - By sea

  • AIR - By air

  • LTL - Less than truckload

  • AIREXPRESS - Air express

  • CONTAINERSEA - Container by ship

 –

Y104

–
      partnerEntityType string

Explains the type of the partner entity involved in this business transaction.

Valid values include:

  • SUPPLIER - Supplier

  • CUSTOMER - Buyer

  • MANUFACTURER - Manufacturer

  • CARRIER - Carrier

  • FREIGHTFORWARDER - Freight forwarder

 –

Y105

–
      city string City Name. – Y106 –
      state string State or Province Code. – Y107 –
      servicesTariffCode string

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

Valid values include:

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

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

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

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

 –

Y108 =

  • BB (BARGETOBARGE) or

  • BD (BARGETODOOR) or

  • BM (BARGETOMOTOR) or

  • BR (BARGETORAIL)

–
      dateType string

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

Valid values:

  • ESTIMATEDDEPARTURE

  • ESTIMATEDSAILING

  • BOOKINGAUTHORIZATION

  • SHIPMENTREQUIRED

–

Y109 =

  • 371 (ESTIMATEDARRIVAL) or

  • 069 (PROMISEDDELIVERY)

 –
    containerBookingRequestInformation array Container booking details consisting of container type, services, equipment specifications and its temperature details. – Segment Y2 –
      numberOfContainers Number Number of shipping containers. – Y201 –
      containerType string Code indicating type of container equipment requested. – Y202 –
      transportServiceType string

Code specifying extent of transportation service requested.

Valid values include:

  • AIRPORTTOAIRPORT - Requested transport services from airport to airport

  • BULKBREAK - Requested transport services for bulk break

  • DOORTODOOR - Requested transport services from door to door

  • DOORTOAIRPORT - Requested transport services from door to airport

 –

Y203 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

–
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

 – – –
      equimentTypeISOCode string Type of equipment used in delivery, Standard ISO code. – Y204 –
      transportMethod string

Transport method type.

Valid values include:

  • TRUCK - Truck

  • RAIL - Shipped by train

  • SEA - By sea

  • AIR - By air

  • LTL - Less than truckload

  • AIREXPRESS - Air express

  • CONTAINERSEA - Container by ship

 –

Y205

–
      interModalServices string Identifying the Inter-modal Service Plan. – Y206 –
      carrierCode string Carrier code for whom containers will be released. – Y207 –
      containerTermsIdentifier string Code indicating origin and destination of transportation and type of container. – Y208 –
      containerTermsType string Code indicating container terms reference. – Y209 –
      numberOfStopOffPoints Number Total number of stop-offs specified for a shipment. – Y210 –
      equipmentTypeTemperature - Equipment type and its required temperatures. – Y2 / W09 –
        equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

  • REFRIGERATED

–

W0901 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK) or

  • CZ (REFRIGERATED)

EQD010 =

  • AK (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TE (TRAILER)
        minTemperature number Equipment minimum allowable temperature. – W0902 –
        temperatureScale string

Temperature unit of measure.

Valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 –

W0903 =

  • CE (CELSIUS) Or

  • FA (FAHRENHEIT)

  • KV(KELVIN)

TMP020-020=

  • CEL (CELSIUS) Or

  • FAH (FAHRENHEIT) Or

  • KEL (KELVIN)
        maxTemperature number Equipment maximum allowable temperature. – W0904 –
        description string Descriptive information about environment required in refrigerated container when other then normal air required. – W906 –
        ventSetting string

To specifying equipment vent adjustment code.

Valid values:

  • OPEN25PERCENT - Vent 25% Open

  • OPEN50PERCENT - Vent 50% Open

  • OPEN75PERCENT - Vent 75% Open

  • OPEN100PERCENT - Vent 100% Open

  • OPEN10PERCENT - Vent 10% Open

  • CLOSED - Vent should be in closed position.

  • CARRIERSET - Carrier to set based on commodity type.

 –

W0907 =

  • A (OPEN25PERCENT) Or

  • B (OPEN50PERCENT) Or

  • C (OPEN75PERCENT) Or

  • D (OPEN100PERCENT) Or

  • F (OPEN10PERCENT) Or

  • E (CLOSED) Or

  • Z (CARRIERSET)

 –
        humidityPercent integer Percent in integer format , example: 50% required, in 50. – W908 –
        temperatureType string

Type of temperature follow while shipment.

Valid values:

  • STORAGE - Storage temperature

  • TRANSPORT - Transport temperature

  • CARGO - Cargo operation temperature

  • EMERGENCY - Transport emergency temperature

  • TRANSPORTCONTROL - Transport control temperature

  • TEMPERATURECORDED - Recorded temperature

 – –

TMP010 =

  • 1 (STORAGE) Or

  • 2 (TRANSPORT) Or

  • 3 (CARGO) Or

  • 4 (EMERGENCY) Or

  • 5 (TRANSPORTCONTROL) Or

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

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 – –

RMG010 =

  • 5 (TEMPERATURE) or

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

  • OCEANSHIPMENTBOOKINGREQUEST (Required) - Transaction unique identifier

  • CONSIGNEEORDERIDENTIFIER - Conginees order number

  • PURCHASEORDER - Purchase Order Number

  • BOL - Bill of Lading Number

  • SUPPLIERORDER - Vendor order number

  • MASTERBOL - Master BOL

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

–

N901 =

  • BM (BOL) Or

  • CT (CONTRACT) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • SI (SHIPMENT) Or

  • MB (MASTERBOL) Or

  • AG (AGENTSHIPMENT) Or

  • CN (CARRIERREFERENCE) Or

BGM010-010 = 335 (OCEANSHIPMENTBOOKINGREQUEST)

RFF010-010 =

  • BM (BOL) Or

  • ON (PURCHASEORDER) Or

  • SN (SEALNUMBER) Or

  • CG (CONSIGNEEORDER) Or
      b2bTransactionIdentifierValue string Transaction reference identifier value. –

B102 when b2bTransactionIdentifierType =SHIPMENT

N902 for remaining qualifiers in b2bTransactionIdentifierType

  • BGM020 when b2bTransactionIdentifierType = OCEANSHIPMENTBOOKINGREQUEST

  • BGM020-010 when b2bTransactionIdentifierType = SHIPMENT

  • RFF010-020 for remaining qualifiers in b2bTransactionIdentifierType
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. –

B103 (Date)b2bTransactionIdentifierType =OCEANSHIPMENTBOOKINGREQUEST

N904+N905 for remaining qualifiers in b2bTransactionIdentifierType

ST-DTM010-020

when ST-DTM010-010 = 137 (Document Date)

when b2bTransactionIdentifierType =OCEANSHIPMENTBOOKINGREQUEST
      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. – – –
      b2bTransactionIdentifierTypeName string B2B Transaction Identifier Type Name. – – –
      timeZone string Time Zone. – – –
    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:

  • BOOKINGIDENTIFIER - Booking Number

  • PACKINGLIST - Packing List Number

  • PURCHASEOPTIONS - Purchase Option Agreement

  • DELIVERYTICKET - Delivery Ticket Number

  • HARMONIZED - Harmonized Code System (USA)

  • TARIFFIDENTIFIER - Tariff Number

 –

N901 =

  • PK (PACKINGLISTIDENTIFIER) or

  • PK (PURCHASEOPTIONS) or

  • DJ (DELIVERYTICKETIDENTIFIER) or

  • HS (HARMONIZED) or

  • TS (TARIFFIDENTIFIER)

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

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

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

Valid values:

  • ESTIMATEDDEPARTURE

  • ESTIMATEDSAILING

  • BOOKINGAUTHORIZATION

  • SHIPMENTREQUIRED

– –

DTM010-010 =

  • 137 (DOCUMENT) Or

  • 003 (INVOICE) Or

  • 132 (ESTIMATEDARRIVAL) Or

  • 178 (ACTUALARRIVAL)

      dateValue string Date defined by referenced date type in date format YYYY-MM-DD. – – DTM010-020
      epochDateValue integer

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

– – –
      dateTimePeriodFormat string

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

Valid values include:

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

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

 – –

DTM010-030

      timeZone string Time zone for referenced dates. – – –
      eventTimeType string Event Time Type. – – –
    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:

  • ORIGINAL - Original carrier

  • FIRST - First carrier after original

  • SECOND - Second carrier after original

  • THIRD - Third carrier after original

  • FOURTH - Fourth carrier after original

  • FIFTH - Fifth carrier after original

 –

R2A01

–
      carrierPreferenceCode string Sender preference code. – R2A02 –
      transportMethod string

Transport method type.

Valid values include:

  • TRUCK - Truck

  • RAIL - Shipped by train

  • SEA - By sea

  • AIR - By air

  • LTL - Less than truckload

  • AIREXPRESS - Air express

  • CONTAINERSEA - Container by ship

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

  • AIRPORTTOAIRPORT - Requested transport services from airport to airport

  • BULKBREAK - Requested transport services for bulk break

  • DOORTODOOR - Requested transport services from door to door

  • DOORTOAIRPORT - Requested transport services from door to airport

 –

R2A07 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

–
      description string Routing description. – R2A09 –
    shipmentServiceRequirements array Identifies information about services, conditions, contract and priority requirements for the shipment. – – segment TSR
      contractCarriageConditionCode string Contract and carriage condition code identifying the conditions of the transportation contract and carriage. – – TSR010-010
      serviceRequirementCode string Code to identify a service (which may constitute an additional component to a basic contract). – – TSR020-010
      shipmentPriority string

To indicate the priority of requested transport service.

Valid values are:

  • EXPRESS - Express service

  • HIGHSPEED - High Speed service

  • NORMAL - Normal service

  • POSTSERVICE - Post service

 – –

TSR030-010 =

  • 1 (EXPRESS) or

  • 2 (HIGHSPEED) or

  • 3 (NORMAL) or

  • 4 (POSTSERVICE)
      shipmentCargoType string It describes classification of a type of cargo. – – TSR040-010
    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:

  • ORIGINAL - Original carrier

  • FIRST - First carrier after original

  • SECOND - Second carrier after original

  • THIRD - Third carrier after original

  • FOURTH - Fourth carrier after original

  • FIFTH - Fifth carrier after original

 – –

TDT010 =

  • 3 (ATARRIVAL) or

  • 11 (ATBORDER) or

  • 12 (ATDEPARTURE) or

  • 13 (ATDESTINATION) or

  • 15 (FOURTH) or

  • 16 (FIFTH) or

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

Transport method type.

Valid values include:

  • TRUCK - Truck

  • RAIL - Shipped by train

  • SEA - By sea

  • AIR - By air

  • LTL - Less than truckload

  • AIREXPRESS - Air express

  • CONTAINERSEA - Container by ship

 – –

TDT030-010

      carrierCode string Shipping carrier alpha code (SCAC). – – TDT050-010
      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
      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
      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
        agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT050-030
      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
        agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT080-030
      transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. – – TDT-RFF
        transactionReferenceType string

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

The valid values include:

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

 – – RFF010-010 = VON (VOYAGEIDENTIFIER)
        transactionReferenceIdentifier string Transaction reference identifier value. – – 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:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of loading

  • PORTOFDISCHARGE - Port of discharge

  • TRANSSHIPMENT - Transshipment port

  • CONSOLIDATIONPOINT - Re-consolidation point

  • DECONSOLIDATIONPOINT - De-consolidation point

  • FINALDESTINATION - Final destination

 –

R401 =

  • O (ORIGIN) Or

  • L (PORTOFLOADING) Or

  • D (PORTOFDISCHARGE) Or

  • T (TRANSSHIPMENT) Or

  • B (CONSOLIDATIONPOINT) Or

  • C (DECONSOLIDATIONPOINT) Or

  • N (FINALDESTINATION)

LOC010

          oceanShipmentLocationCode string

Code indicating type of location code.

Valid values include:

  • CITY - City code

  • DOMESTICPORTS - Domestic U.S. ports (Schedule D)

  • INTERNATIONALPORTS - Foreign ports (Schedule K), and international

  • UNLOCODE - United Nations Location Code

 –

R402 =

  • CI (CITY) Or

  • D (DOMESTICPORTS) Or

  • K (INTERNATIONALPORTS) Or

  • UN (UNLOCODE)

–
          oceanShipmentLocationIdentifier string Identifies the cargo's specific location. – – LOC020-010
          portName string Name of the port. – – LOC020-040
          countryCode string Country code. – – LOC030-010 (LOC030-020 = 162 (Country))
          terminalName string Terminal Name. – – –
          pierIdentifier string Identifying number of the pier. – – LOC040-010 (LOC040-020 = 169 (Country- sub entity))
          state string State code. – – –
          longitudeCoordinate string Longitude Coordinate. – – –
          latitudeCoordinate string Latitude Coordinate. – – –
          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. – – TDT050-020
            agencyCode string Specifies the organization or responsible agency code that maintains or governs the referenced code list. – – TDT050-030
        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:

  • ESTIMATED - Estimated

  • ACTUAL - Actual

  • ESTIMATEDDEPARTURE - Estimated Departure Date

  • ACTUALDEPARTURE - Actual Departure date

  • ESTIMATEDARRIVAL - Estimated Arrival date

  • ACTUALARRIVAL - Actual arrival date

  • CUSTOMSCLEARANCE - Customs Clearance date

  • VESSELLOADED - Loaded on vessel date

  • CUSTOMSENTRY - Customs entry date

  • PACKED - Date packed

 –

DTM01 =

  • 139 (ESTIMATED) Or

  • 140 (ACTUAL) Or

  • 369 (ESTIMATEDDEPARTURE) Or

  • 370 (ACTUALDEPARTURE) Or

  • 371 (ESTIMATEDARRIVAL) Or

  • 372 (ACTUALARRIVAL) Or

  • 058 (CUSTOMSCLEARANCE) Or

  • 161 (VESSELLOADED) Or

  • 813 (CUSTOMSENTRY) Or

  • 510 (PACKED)

DTM010-010

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

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

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

 – DTM05

DTM010-030

          timeZone - Time zone for referenced dates. – DTM04 –
    partnerBusinessInformation array Partner Entity group location identifiers and address information. – N1 NAD
      partnerEntityType string

Explains the type of the partner entity involved in this business transaction.

Valid values include:

  • SUPPLIER - Supplier

  • CUSTOMER - Buyer

  • MANUFACTURER - Manufacturer

  • CARRIER - Carrier

  • FREIGHTFORWARDER - Freight forwarder

 –

N101

NAD010

      businessName string Business name for partner or location. – N102 NAD030-010
      additionalBusinessName string Additional Business name for partner or location. – – –
      companyLocationPartnerName string Additional Location of same Business partner. – – –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean – – –
        companyIdentifierType string Company identifier type for business partner –

  • N103 = 1 (DUNS) or

  • N103 = 9 (DUNS4) or

  • N103 = 11 (DEA) or

  • N103 = 21 (HIN) or

  • N103 = 91 (COMPANYID) or

  • N103 = 92 (COMPANYSITEID) or

  • N103 = UL (GLN)

  • N103 = 93 (TRANSACTION_SET_SENDER) or

  • N103 = 94 (TRANSACTION_SET_RECEIVER) or

  • N103 = FA (FACILITY_IDENTIFIER) or

  • N103 = 20 (STANDARD_POINT_LOCATION_CODE) or

  • N103 = ZZ (CUSTOM)

  • NAD020-030 =16 (DUNS))

  • NAD020-030 = 164(DEA)

  • NAD020-030 = 237(HIN)

  • NAD020-030 = 91(COMPANYID)

  • NAD020-030 = 92(COMPANYSITEID)

  • NAD020-030 = 9(GLN)
        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:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

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

  • EMERGENCYDANGEROUS - Emergency dangerous goods contact

  • SENDER - Message sender contact

 –

G6101 =

  • IC (INFORMATION) or

  • FW (FORWARDER)

CTA010 =

  • IC (INFORMATION) or

  • OC (ORDERCONTACT)

  • CW (CONFIRMEDWITH)

  • HE (EMERGENCYDANGEROUS)

  • MS (SENDER)
        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 –
    equipmentTypeTemperature - Equipment type and its required temperatures. – W09 –
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

  • REFRIGERATED

–

W0901 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK) or

  • CZ (REFRIGERATED)

 –
      temperatureType string

Type of temperature follow while shipment.

Valid values:

  • STORAGE - Storage temperature

  • TRANSPORT - Transport temperature

  • CARGO - Cargo operation temperature

  • EMERGENCY - Transport emergency temperature

  • TRANSPORTCONTROL - Transport control temperature

  • TEMPERATURECORDED - Recorded temperature

 – – –
      temperatureSetpoint number Temperature value setting expressed in degrees – – –
      temperatureScale string

Temperature unit of measure.

Valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 –

W0903 =

  • CE (CELSIUS) Or

  • FA (FAHRENHEIT)

  • KV(KELVIN)

 –
      rangeType string

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

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

Temperature unit of measure.

Valid values includes:

  • CE - degree Celsius

  • FA - Fahrenheit

 – – –
      ventSetting string

To specifying equipment vent adjustment code.

Valid values:

  • OPEN25PERCENT - Vent 25% Open

  • OPEN50PERCENT - Vent 50% Open

  • OPEN75PERCENT - Vent 75% Open

  • OPEN100PERCENT - Vent 100% Open

  • OPEN10PERCENT - Vent 10% Open

  • CLOSED - Vent should be in closed position.

  • CARRIERSET - Carrier to set based on commodity type.

 –

W0907 =

  • A (OPEN25PERCENT) Or

  • B (OPEN50PERCENT) Or

  • C (OPEN75PERCENT) Or

  • D (OPEN100PERCENT) Or

  • F (OPEN10PERCENT) Or

  • E (CLOSED) Or

  • Z (CARRIERSET)

 –
      description string Descriptive information about environment required in refrigerated container when other then normal air required. – W906 –
      humidityPercent integer Percent in integer format , example: 50% required, in 50. – W908 –
    specialHandlingInformation array Special handling instructions for shipment. All parameters to be understood in the form of different codes used by industry, (typeDef created as part of X12 210). – Segment H3 –
      handlingCode string

Code specifying special transportation handling instructions.

Valid Values included:

  • CARRIER

  • DANGEROUS

  • DOMESTIC

  • EXPEDITE

 –

H301 =

  • EP (EXPEDITE) or

  • DM (DOMESTIC) or

  • DA (DANGEROUS) or

  • CH (CARRIER)

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

Code indicating to which traffic a tariff applies.

Valid values are:

  • INTERSTATE

  • INTRASTATE

  • REGIONAL

  • RECIPROCAL

  • INTERNATIONAL

–

H305 =

  • N (INTERSTATE) or

  • S (INTRASTATE) or

  • R (REGIONAL) or

  • I (INTERNATIONAL) or

  • D (RECIPROCAL)

 –
    additionalEquipmentSpecification array Describes additional attributes / properties for an equipment – segment EA –
      equipmentSpecificPropertyCode string

Additional properties related to equipment required while booking a shipment.

Valid values:

  • ATMOSPHERE - Atmosphere controlled

  • CLIPON - Clip On

  • NOTREQUIRED - Not required

  • PRECOOLED - Precooled

  • DRYREFRIGERATED - Refrigerator used as dry

  • SLUNG - Under the slung

  • PRESETTEMPERATURE - Pre-set temperature

  • DOORHEIGHT - Door height equipment

  • DOORWIDTH - Door width equipment

  • YEAROFMANUFACTURE - Year of manufacture

  • MOISTURE - Moisture Content Requirement

 –

EA01 =

  • ATM (ATMOSPHERE) or

  • CO (CLIPON) or

  • NR (NOTREQUIRED) or

  • PCO (PRECOOLED) or

  • RAD (DRYREFRIGERATED) or

  • US (SLUNG) or

  • PSE (PRESETTEMPERATURE) or

  • DHT (DOORHEIGHT) or

  • DWI (DOORWIDTH) or

  • YEA (YEAROFMANUFACTURE) or

  • MCP (MOISTURE)

 –
      unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit.

 – EA020-010 –
      equipmentQuantity number Total quantity of equipment. – EA03 –
    vesselBookingRequestDetails array Vessel booking request information along with transportation details such as dates, quantity , weight and volume. – Segment V1 –
      carrierSequenceCode string

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

Valid values include:

  • ORIGINAL - Original carrier

  • PRECARRIAGE - Pre-carriage transport

  • ONCARRIAGE - On carriage transport

 – – –
      vesselIdentifier string Vessel Identifier. – V101 –
      vesselName string Name of ship as documented in "Lloyd's Register of Ships". – V102 –
      countryCode string Ship/Vessel registered country code. – V103 –
      voyageIdentifier string Voyage identifier on which the cargo travels. – V104 –
      carrierCode string Shipping carrier alpha code (SCAC). – V105 –
      vesselCodeType string

Vessel code type.

Valid values :

  • USBUREAU - U.S. Bureau of Census

  • SHIPSRADIO - Ship's Radio Call Signal

  • LLOYD - Lloyd's Register of Shipping

  • MUTUALLYDEFINED - Mutually defined number

 –

V108 =

  • B (USCENSUS) Or

  • C (SHIPSRADIOSIGNAL) Or

  • L (LLOYD) Or

  • Z (MUTUALLYDEFINED)

 –
  canonicalShipmentBookingRequestItemDetails array Details for the canonical shipment booking request message. – LX Loop (Mandatory) –
    lineItemNumber string transaction set line number. – LX01 (Mandatory) –
    equipmentDetails   Shipment equipment details. – N7 –
      equipmentPrefix string Prefix or alphabetic part of an equipment unit's identifying number. – N701 –
      equipmentIdentifier string Sequencing or serial part of an equipment unit's identifying number. – N702 –
      carrierCode string Carrier code for shipper. – N712 –
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

–

N711 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK)

 –
      equipmentTypeISOCode string Equipment type ISO code. – – –
      checkDigitIdentifier number Equipment check digit number, (Container check digit number). – N718 –
      weightUnitType string

Type of weight recorded.

Valid values include:

  • METRICTON - Metric ton

  • GRAMS - Grams

  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

 –

N717 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

–
      weightType string

Type of weight recorded in shipment.

Valid values include:

  • GROSSWEIGHT - Gross weight

  • NETWEIGHT - Net Weight

  • SHIPPER - Shipper's weight

  • TARE - Tare weight

 –

N704

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

Tare Qualifier Code.

  • ACTUAL - Actual tare

  • MARKED - Marked tare

 –

N716 =

  • A (ACTUAL) Or

  • M (MARKED)

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

Type of volume recorded.

Valid values include:

  • BARGE - Volume of barge

  • CONTAINER - Volume of container

  • CUBICCENTIMETERS - Cubic centimeters

  • CUBICDECIMETERS - Cubic decimeters

 –

N709

–
      volumeValue Number Vessel volume for type. – N708 –
      equipmentDimensions array Dimensions of freight. – Segment N7 –
        dimensionsType string

Type of dimensions recorded for freight.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

– – –
        dimensionsValue Number Volume for item in inches. –

  • N715 where dimensionsType = LENGTH

  • N720 where dimensionsType = HEIGHT

  • N721 where dimensionsType = WIDHT

 –
        unitOfMeasure string Dimension unit of measure for parent packaging. – – –
      itemQuantity array Equipment quantity. – – –
        quantityType string

Type of quantity recorded.

Valid values:

  • No sample data available.

  • Use java call out

 – – –
        quantityValue number Quantity of product in shipment – – –
        unitOfMeasure string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit

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

  • CARRIER - Carrier applied seal number

  • SHIPPER - Shipper applied seal number

  • CUSTOMS - Customs department applied seal number

  • TERMINALOPERATOR - Terminal operator applied seal number

 – – –
    equipmentTypeTemperature - Equipment type and its required temperatures. – LX - W09 –
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

  • REFRIGERATED

–

W0901 =

  • AP (AIRCRAFT) or

  • CN (CONTAINER) or

  • RR (RAILCAR) or

  • TL (TRAILER) or

  • VT (SHIP) or

  • TO (TRUCK) or

  • CZ (REFRIGERATED)

 –
      temperatureType string

Type of temperature follow while shipment.

Valid values:

  • STORAGE - Storage temperature

  • TRANSPORT - Transport temperature

  • CARGO - Cargo operation temperature

  • EMERGENCY - Transport emergency temperature

  • TRANSPORTCONTROL - Transport control temperature

  • TEMPERATURECORDED - Recorded temperature

 – – –
      temperatureSetpoint number Temperature value setting expressed in degrees. – – –
      temperatureScale string

Temperature unit of measure.

Valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 –

W0903 =

  • CE (CELSIUS) Or

  • FA (FAHRENHEIT)

  • KV(KELVIN)

 –
      rangeType string

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

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

Temperature unit of measure.

Valid values includes:

  • CE - degree Celsius

  • FA - Fahrenheit

 – – –
      ventSetting string

To specifying equipment vent adjustment code.

Valid values:

  • OPEN25PERCENT - Vent 25% Open

  • OPEN50PERCENT - Vent 50% Open

  • OPEN75PERCENT - Vent 75% Open

  • OPEN100PERCENT - Vent 100% Open

  • OPEN10PERCENT - Vent 10% Open

  • CLOSED - Vent should be in closed position.

  • CARRIERSET - Carrier to set based on commodity type

 –

W0907 =

  • A (OPEN25PERCENT) Or

  • B (OPEN50PERCENT) Or

  • C (OPEN75PERCENT) Or

  • D (OPEN100PERCENT) Or

  • F (OPEN10PERCENT) Or

  • E (CLOSED) Or Z (CARRIERSET)

 –
      description string Descriptive information about environment required in refrigerated container when other then normal air required. – W906 –
      humidityPercent integer Percent in integer format , example: 50% required, in 50. – W908 –
    shipmentBookingRequestItemDetails - Each shipment booking request item details such as quantity, measurement , packing and other details. – LX- L0 loop GID
      shipmentBookingItemMeasurementServiceDetails - Item details to specify quantity, weight, volume, and type of service for a line item including applicable quantities. – Segment: L0 –
        lineItemNumber string Sequential line number for freight invoice item. – L001 GID010
        billedQuantityType string

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

Valid values include:

  • BARRELS - Barrels

  • BOX - Box

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

  • POUND - Common weight unit in ocean freight billing.

  • KILOGRAM - Metric weight unit used in international shipping.

  • LITER - Liter

 –

L003 =

  • BA (BARRELS) Or

  • BX (BOX) Or

  • EA (EACH) Or

  • LB (POUND) Or

  • KG (KILOGRAM) Or

  • LR (LITER)

–
        billedQuantityValue string Numeric value representing the quantity or amount on which the rate or item pricing is based, corresponding to the specified pricing basis type. – L002 –
        packagingFormatCode string

Packing form of lading quantity.

Valid values include:

  • CONTAINER - Containers

  • BARREL - Barrels

 –

L009

GID020-020

        ladingQuantity number Number of handling units of the line item 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:

  • METRICTON - Metric ton

  • GRAMS - Grams

  • KILOGRAMS - Kilograms

  • POUNDS - Pounds

  • OUNCES - Ounces

 –

L011 =

  • E (METRICTON) or

  • G (GRAMS) or

  • K (KILOGRAMS) or

  • L (POUNDS) or

  • M (MEASUREMENTTON) or

  • O (OUNCES) or

  • S (SHORTTON) or

  • T (LONGTON)

–
        transportServiceType string

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

Valid values are:

  • AIRPORTTOAIRPORT - Requested transport services from airport to airport

  • BULKBREAK - Requested transport services for bulk break

  • DOORTODOOR - Requested transport services from door to door

  • DOORTOAIRPORT - Requested transport services from door to airport

 –

L012 =

  • AA (AIRPORTTOAIRPORT) or

  • BB (BULKBREAK) or

  • DD (DOORTODOOR) or

  • DA (DOORTOAIRPORT)

–
        weightType string

Type of weight recorded.

Valid values include:

  • GROSSWEIGHT

  • NETWEIGHT

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

Type of weight recorded.

The valid values include TOTAL.

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

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

  • TRUE - Yes

  • FALSE - No

 –

L015 =

  • Y (TRUE) or

  • N (FALSE)

 –
        packageVerificationFormatCode string

Packing form of counting required quantity.

Valid values include:

  • BOX - Boxes

  • CARTON - Cartons

  • PIECES - Pieces

 –

L014

Note: Data element will be mapped, only when L015 is YES, and L013 is present.

 –
        packageVerificationQuantity number Total number of boxes, cartons, or pieces contained on a pallet, skid, or slip sheet for the line item. – L013 –
      specialHandlingInformation array Special handling instructions for shipment. All parameters to be understood in the form of different codes used by industry, (typeDef created as part of X12 210). – – GID-HAN
        handlingCode string

Code specifying special transportation handling instructions.

Valid Values included:

  • CARRIER

  • DANGEROUS

  • DOMESTIC

  • EXPEDITE

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

Code indicating to which traffic a tariff applies.

Valid values are:

  • INTERSTATE

  • INTRASTATE

  • REGIONAL

  • RECIPROCAL

  • INTERNATIONAL

– – –
      itemTemperature array Temperature setting required for goods items. – – GID-TMP
        temperatureType string

Type of temperature follow while shipment.

Valid values:

  • STORAGE - Storage temperature

  • TRANSPORT - Transport temperature

  • CARGO - Cargo operation temperature

  • EMERGENCY - Transport emergency temperature

  • TRANSPORTCONTROL - Transport control temperature

  • TEMPERATURECORDED - Recorded temperature

 – –

TMP010 =

  • 1 (STORAGE) Or

  • 2 (TRANSPORT) Or

  • 3 (CARGO) Or

  • 4 (EMERGENCY) Or

  • 5 (TRANSPORTCONTROL) Or

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

Temperature unit of measure.

Valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 – –

TMP020-020=

  • CEL (CELSIUS) Or

  • FAH (FAHRENHEIT) Or

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

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 – –

RNG010 =

  • 5 (TEMPERATURE) or

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

  • CE - Degree Celsius

  • FA - Fahrenheit

 – –

RNG020-010 =

  • CEL (CE) Or

  • FAH (FA)
        description string Descriptive information about environment required for goods item. – – –
      shipmentBookingRequestlocationDetails array 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:

  • ORIGIN - Origin

  • PORTOFLOADING - Port of Loading

  • PORTOFDISCHARGE - Port of Discharge

  • FINALDESTINATION - Final Destination

 – –

LOC010

        oceanShipmentLocationIdentifier string Identifies the cargo's specific location. – – LOC020-010
        portName string Name of the port. – – LOC020-040
        countryCode string Country code. – – LOC030-010 (LOC030-020 = 162 (Country))
        terminalName string Terminal Name. – – –
        state string State code. – – LOC040-010 (LOC040-020 = 169 (Country- sub entity))
      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 MEASUREMENT - Measurement.

 – –

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:

  • CUBICFEET - Cubic feet

  • KILOGRAM - Kilogram

  • POUND - Pounds

  • CUBICMETER - Cubic meters

  • PACKS - No of packs

 – –

MEA030-010 =

  • FTQ (CUBICFEET)

  • KGM (KILOGRAM) Or

  • LBR (POUND) Or

  • MTQ (CUBICMETER) Or

  • NMP (PACKS)
        measuredType string

Code identifying a measured type for a measured value.

Valid values include:

  • SHIPPEDQUANTITY - Shipped quantity

  • GROSSVOLUME - Gross volume

  • EQUIPMENTGROSSWEIGHT - Transport equipment gross weight

  • GROSSWEIGHT - Weight (mass) of goods including packing but excluding the carrier's equipment.

 – –

MEA020-010 =

  • SQ (SHIPPEDQUANTITY) Or

  • AAW (GROSSVOLUME) Or

  • AET (EQUIPMENTGROSSWEIGHT)

  • G (GROSSWEIGHT)
      dangerousGoodsInformation array Describes the details of the dangerous goods in the booking/shipment. This group will be populated only when "isDangerous" is true. – Segment H1 & H2 (LX Loop) GID-DGS Loop
        shipmentDerivedRisk string It describes the risks involved while shipping dangerous goods. It can be more specific based on UN code. – – –
        shipmentDerivedSubRisk string It describes the sub-risks involved while shipping dangerous goods. It can be more specific based on UN code. – – –
        shipmentFlashPoint string Temperature value indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.” – H107 DGS040 -010
        isLimitedQuantity boolean

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

  • True - 1 - Yes Limited

  • False - 0 - NA

 – – –
        isMarinePollutant boolean

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

  • True - 1 - Yes Pollutant

  • False - 0 - No

 – – –
        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. – H104 –
        designatedTechnicalName string Designated technical name for carrier identity. – – –
        designatedTechnicalNationalName string Designated technical name for carrier and international identity. – – –
        minTemperatureValue Number It describes from temperature. – – –
        maxTemperatureValue Number It describes to temperature. – – –
        dangerousGoodsType string

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

Widely used codes are:

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

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

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

 –

H103 =

  • I (IMDG) or

  • A (ADR) or

  • T (IATA)

DGS010 =

  • IMD (IMDG) or

  • ADR (ADR) or

  • ICA (IATA)
        dangerousGoodsIdentifier string Dangerous goods identifier. – H101 DGS020 -010
        additionalDangerousGoodsIdentifier String Additional Dangerous goods identifier. – – DGS020 -020
        dangerousGoodsClassCode string It specifies the kind of hazard can be generated by a material. – H102 –
        emergencyContactDetails string Phone number and name of person or department to contact in case of emergency. – H105 DGS060
        dangerousGoodsPackagedQuantity Number Packaged quantity of dangerous goods. – – –
        hazardousGoodsPackageType string

Package type containing these dangerous goods.

Possible values are:

  • BAG - Bag

  • BOX - Carton / Box

  • CONTAINER - Intermediate Bulk Container

  • COMPOSITE - Composite Packaging

  • GAUGE - Light Gauge Metal Packaging

  • BOTTLES - Bundle of Bottles

  • PRESSUREDRUM - Pressure Drum

  • STEELBOTTLE - Steel Bottle

  • DRUM - Drum

  • CAN - Jerry Can

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

To check if package is empty.

  • True - 1 - Yes

  • False - 0 - No

 – – –
        hazardousMaterialIndex String The United Nations page number as required for the international transport of hazardous materials. – H106 DGS030 -010
        unitOfMeasure string Dimension unit of measure for parent packaging. – H108 –
        additionalDangerousGoodsInformation array Additional Dangerous Goods information to be considered while specifying shipment instructions. – Segment H2 under LX - L0 - H1 loop –
          additionalDangerousGoodsDescription String Material name, special instructions, and phone number if any. – H201 –
          additionalDangerousGoodsClassification String Free-form description of hazardous material classification or division or label requirements. – H202 –
        dangerousGoodsItemQuantity array Dangerous Goods item quantity related information to identify quantity, UOM and value. – – –
          dangerousGoodsQuantityType string

Type of quantity recorded.

Valid value:

  • NET

  • GROSS

  • UNITS

– – –
          dangerousGoodsQuantityValue Number Quantity of product at line item level. – – –
          dangerousGoodsQuantityUOM string Quantity unit of measure in master data for dangerous goods. – – –
      shipmentDimensions array Dimensions of freight. – LX - L4 GID-DIM
        dimensionsType string

Type of dimensions recorded for freight.

Valid values include:

  • LENGTH

  • WIDTH

  • HEIGHT

– – –
        dimensionsValue Number Volume for item in inches. –

  • L401, when dimensionsType = LENGTH

  • L402, when dimensionsType = WIDTH

  • L403, when dimensionsType = HEIGHT

  • DIM020-020, when dimensionsType = LENGTH

  • DIM020-030, when dimensionsType = WIDTH

  • DIM020-040, when dimensionsType = HEIGHT
        shipmentDimensionsUnitType string

Dimensions unit for shipment to be booked.

Valid Values are:

  • INCHES - Inches

  • FEET - Feet

  • METER - Meters

  • CENTIMETER - Centimeters

 –

L404 =

  • N (INCHES) or

  • C (CENTIMETER) or

  • X (METER) or

  • E(FEET)

 DIM020-010
        dimensionsQuantity number Quantity of dimensions in shipment booking. – L405 –
      shipmentBookingItemDetails array Lading line item in terms of description, packaging, and marks and numbers. – L5 –
        lineItemNumber number Sequential line number for a lading item. – L501 –
        description string Description of an item as required for rating and billing purposes. – L502 –
        commodityCode string Describes about a commodity or group of commodities. – L503 –
        commoditySystemType string

Describes the commodity coding system used for Commodity Code.

Valid values included:

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

  • NDC - National Drung Code

  • FREIGHT - Canadian Freight

  • MOTORFREIGHT - Motor Freight Classification

  • BULK - Bulk Codes

  • QUOTA - Quota Category

  • TRADE - Standard International Trade Classification

  • TRANSPORTATION - Standard Transportation Commodity Code

  • MUTUALLYDEFINED - Mutually defined

 –

L504=

  • 2 (DUNS) or

  • 5 (NDC) or

  • C (FREIGHT) or

  • N (MOTORFREIGHT) or

  • P (BULK) or

  • Q (QUOTA) or

  • S (TRADE) or

  • T (TRANSPORTATION) or

  • Z (MUTUALLYDEFINED)

 –
        packagingFormatMaterialType string

Code identifying type of material used.

Valid values included :

  • ALUMINUM - Aluminum.

  • GLASS - Glass

  • PLASTIC - Plastic.

  • PLASTICINJECTION - A plastic formed injection

 –

L505 =

  • 01 (ALUMINUM) Or

  • 43 (GLASS) Or

  • 79 (PLASTIC) Or

  • 78 (PLASTICINJECTION)

–
        packagingIdentifierType string Packaging identifier type. Pass thru mapping for X12. – L507 –
        packagingIdentifier string Packaging identifier value defined by the packaging type. – L506 –
      shipmentBookingItemsRateCharges array Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements. – Under LX loop: Segment: L1 (Line item number of L501, L001, L101 and LX01 should match for every loop of LX)  
        lineItemNumber string Sequential line number for freight invoice item. – L101 TCC010-060
        freightRatesChargesIdentifier string Identification of a charge by code and/or by name. Describes about freight and other charges, it can be combination of freight costs, type and charges description. – – TCC010-010
        freightRate number Rate that applies to the specific commodity. – L102 –
        freightRateType string

Qualifiers to extend charges or interpret or calculate value.

Valid values are:

  • UNIT - Per Unit

  • CAR - Per Car

  • POUND - Per Pound

  • PERCENTAGE - Percentage

  • CHARGES - Charges based on mentioned percentage

  • MILES - Per Miles

  • MINIMUM - Minimum Charge

  • FLAT - Flat rate

  • PERHUNDRED - Per Hundred (of Basic Unit )

 –

L103 =

  • PU (UNIT) or

  • PC (CAR) or

  • PW (PERCENTAGE) or

  • CR (CHARGES) or

  • PM (MILES) or

  • MN (MINIMUM) or

  • PH (PERHUNDRED) or

  • FR (FLAT) or

  • LB (POUND)

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

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

Valid values are:

  • RAIL - Rail

  • AIR - Air

  • MOTOR - Motor

  • R260 - Association of American Railroads Accounting Rule 260

 – – –
        specialChargeCode string

Type of special charge or allowance allowed.

Valid values include:

  • DISCOUNT - Discount

  • SPECIALDISCOUNT - Special Discount

  • CUSTOMSENTRY - Customs Entry

  • CUSTOMSCHARGE - Customs Charge

 –

L108 =

  • DSC (DISCOUNT) or

  • 295 (SPECIALDISCOUNT) or

  • CSE (CUSTOMSENTRY) or

  • CUS (CUSTOMSCHARGE)

–
        rateClassCode string

Identifies specific & designated class of goods;

Note: For international air shipments, see IATA Resolution 600k

Valid values include:

  • CONTRACT - Contract rate

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

  • MINIMUM - Minimum

  • QUOTED - Quoted rate

  • SENDER - Sender rate

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

  • EXCEPTION - Exception rating

 –

L109 =

  • CTR (CONTRACT) or

  • E (EXCESSWEIGHT) or

  • M (MINIMUM) or

  • QUO (QUOTED) or

  • T (SENDER) or

  • X (CONTAINER) or Y (EXCEPTION)

TCC020-010 =

  • B (BASIC) or

  • C (COMMODITY) or

  • G (EXPORT) or

  • H (SUBSIDY) or

  • K (KILOGRAM) or

  • M (MINIMUM)
        chargeEntitlementParty string

To describe the types of party involved.

Valid values:

  • SHIPPER

  • CONSIGNEE

  • ISSUINGCARRIER

  • DESTINATIONCARRIER

–

L110 =

  • S (SHIPPER) or

  • C (CONSIGNEE) or

  • I (ISSUINGCARRIER) or

  • D (DESTINATIONCARRIER)

 –
        chargePaymentMethod string

Payment method for freight invoice charges.

Valid values:

  • PREPAIDCASH

  • PREPAIDCREDIT

  • COLLECT

  • COLLECTCASH

  • COLLECTCREDIT

  • PREPAID

  • THIRDPARTYPAY

–

L111 =

  • A (PREPAIDCASH) or

  • B (PREPAIDCREDIT) or

  • C (COLLECTCASH) or

  • D (COLLECTCREDIT) or

  • E (COLLECT) or

  • P (PREPAID)

TCC010-050 =

  • C (COLLECT) or

  • P (PREPAID) or

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

Type of billed quantity recorded.

Valid values include:

  • KILOMETERS - Kilometers

  • MILES - Miles

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

  • EACH - Each

  • POUND - Pound

  • MILEAGE - Mileage

  • LOAD - Load

  • TRAIN - Train

  • CONTAINER - Container

  • UNIT - Unit

 –

L118 =

  • DK (KILOMETERS) or

  • DM (MILES) or

  • EA (EACH) or

  • DR (DRIVERS) or

  • LB (POUND) or

  • MR (MILEAGE) or

  • NL (LOAD) or

  • NN (TRAIN) or

  • NR (CONTAINER) or

  • NU (UNIT)

 –
        billedQuantityValue number Quantity of product in delivery. – L117 –
        freightRatePercent number Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%). – L119 –
        currencyCode string Billed Currency Code. – L120 –
        rateOrTariffClassDescription string Free form description of an applicable rate or tariff class. – – TCC020-040
        itemQuantity array Shipment quantity, chargeable quantity that applies charges. – – QTY
          quantityType string

Type of quantity recorded.

Valid values include.

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

  • SHIPPED - Shipped quantity

 – –

QTY010-010

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

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit

 – –

QTY010-030

      freeTextNote array Ship to party company identifiers and address information. – Segment K1 FTX
        textReferenceCode string Text reference or subject code. – – FTX010-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 – K101, K102 Each is 30 characters. Mapping to canonical, concatenate K1 and K2. Mapping from canonical split into 2 fields. 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. – – –
    transactionReferenceIdentifierList array List of documents and transactions at the header level of the message (Do not have sample data, kept this based on 315 sample data) – – group 23 - RFF
      b2bTransactionIdentifierType string

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

Valid values include:

  • SHIPMENT - Shipper's identifier for the shipment

  • DELIVERY - Delivery order number

  • BOL - Bill of Lading Number

  • PURCHASEORDER - Purchase Order Number

  • SUPPLIERORDER - Vendor order number

  • INVOICE - Seller invoice number

  • MASTERBOL - Master BOL

  • SEALNUMBER - Seal number

  • AGENTSHIPMENT - Agent shipment number

  • CARRIERREFERENCE - Carrier reference number

  • CONSIGNEEORDERIDENTIFIER - Conginees order number

  • PRICEQUOTEIDENTIFIER - Price quote number

 – – –
      b2bTransactionIdentifierValue string Transaction reference identifier value. – – –
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionDate string Transaction reference date and time, if time available, in epoch date format. – – –
      lineItemNumber integer Transaction reference date and time in EPOCH date time format. – – –
    transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.(Do not have sample data, kept this based on 315 sample data). – – group 23 - RFF
      transactionReferenceType string

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

Valid values include:

  • FORWARDERREFERENCE - Freight forwarder reference identifier

  • CUSTOM - Mutually defined reference number

  • OCEANCONTAINERIDENTIFIER - Ocean container number

  • TRANSACTIONTYPE - Transaction type

 – –

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

  • SRN (CARRIERASSIGNEDSHIPPERIDENTIFIER) Or

  • SD (SALESDEPARTMENT)
      transactionReferenceIdentifier string Transaction reference identifier value. – – RFF010-020
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02) – – –
      transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
    mpcDates array Dates relevant to shipments events at port, does not have any X12 or EDIFACT related segment, kept as place holder – – –
      dateType string

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

Valid values include:

  • ESTIMATED - Estimated

  • ACTUAL - Actual

  • ESTIMATEDDEPARTURE - Estimated Departure Date

  • ACTUALDEPARTURE - Actual Departure date

  • ESTIMATEDARRIVAL - Estimated Arrival date

  • ACTUALARRIVAL - Actual arrival date

  • CUSTOMSCLEARANCE - Customs Clearance date

  • VESSELLOADED - Loaded on vessel date

  • CUSTOMSENTRY - Customs entry date

  • PACKED - Date packed

 – – –
      dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. – – –
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. 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. – Segment K1 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 – K101, K102 Each is 30 characters. Mapping to canonical, concatenate K1 and K2. Mapping from canonical split into 2 fields. 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. – – –
  canonicalShipmentBookingRequestEventDetails array To report events occurred during ocean, rail, air shipments. – V9 –
    shipmentEventType string

Code to specify type of the ocean shipment event.

Valid values include:

  • ANTICIPATEDPICKUP - Anticipated Pickup

  • VESSELARRIVAL - Vessel Arrival

  • VESSELDEPARTURE - Vessel Departure

  • UNLOADEDFROMVESSEL - Unloaded From Vessel

  • LOADEDONVESSEL - Actually Loaded on Vessel

  • FINALDESTINATIONACTUALARRIVALDATE - Actual Arrival Date at Final Destination

–

V901 =

  • APU (Anticipated Pickup) Or

  • VAR (Vessel Arrival) Or

  • VDP (Vessel Departure) Or

  • UFV (Unloaded From Vessel) Or

  • ALV (Actually Loaded on Vessel) Or

  • ARD (Actual Arrival Date at Final Destination)

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

Reason indicating why a shipment status code was transmitted.

Valid values included:

  • CONTAINERDELAY - Import Container Delay

  • INCORRECTADDRESS - Incorrect Address

  • CONSIGNEEREFUSED - Refused by Consignee

  • DAMAGEDDELIVERYNOTCOMPLETED - Damaged - Delivery Not Completed

 –

V908 =

  • 052 (CONTAINERDELAY) Or

  • A03 (INCORRECTADDRESS) Or

  • A07 (CONSIGNEEREFUSED) Or

  • A10 (DAMAGEDDELIVERYNOTCOMPLETED) Or

–
    longitudeCoordinate string Longitude coordination. – – –
    latitudeCoordinate string Latitude coordination. – – –
    directionIndicator string Coordination direction. – – –
    equipmentTypeTemperatures - Equipment type and its required temperatures. – – –
      equipmentType string

Type of equipment used in delivery.

Valid values:

  • CONTAINER

  • RAILCAR

  • TRAILER

  • SHIP

  • AIRCRAFT

  • TRUCK

 – – –
      temperatureType string

Type of temperature follow while shipment.

Valid values:

  • STORAGE - Storage temperature

  • TRANSPORT - Transport temperature

  • CARGO - Cargo operation temperature

  • EMERGENCY - Transport emergency temperature

  • TRANSPORTCONTROL - Transport control temperature

  • TEMPERATURECORDED - Recorded temperature

 – – –
      transportEventTimeStamp string Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      temperatureSetpoint number Temperature value setting expressed in degrees. – – –
      temperatureScale string

Temperature unit of measure.

Valid values:

  • CELSIUS - Degree, Celsius

  • FAHRENHEIT - Degree, Fahrenheit

  • KELVIN - Degree Celsius per kelvin

 – – –
      rangeType string

Type of range.

Valid values:

  • TEMPERATURE - Item temperature range

  • TRANSPORTTEMPERATURE - Transport temperature range

 – – –
      minTemperature number Equipment minimum allowable temperature. – – –
      maxTemperature number Equipment maximum allowable temperature. – – –
      ventSetting string

To specifying equipment vent adjustment code.

Valid values:

  • OPEN25PERCENT - Vent 25% Open

  • OPEN50PERCENT - Vent 50% Open

  • OPEN75PERCENT - Vent 75% Open

  • OPEN100PERCENT - Vent 100% Open

  • OPEN10PERCENT - Vent 10% Open

  • CLOSED - Vent should be in closed position.

  • CARRIERSET - Carrier to set based on commodity type

 – – –
      description string Descriptive information about environment required in refrigerated container when other then normal air required. – – –
      humidityPercent number Percent in integer format , example: 50% required, in 50. – – –
      supplyTemperature number The temperature of the air coming into the container. – – –
      returnTemperature number The temperature of the air leaving the container. – – –
      co2Setpoint number The designated CO2 atmosphere level for transporting your cargo. – – –
      co2Reading number The CO2 atmosphere level. – – –
      o2Setpoint number The designated O2 atmosphere level for transporting your cargo. – – –
      o2Reading number The O2 atmosphere level. – – –
      relativeHumidity number The relative humidity. – – –
      humiditySetpoint number The designated humidity level for transporting your cargo. – – –
      pulpLocation1Temperature number One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. – – –
      pulpLocation2Temperature number One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. – – –
      pulpLocation3Temperature number One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container. – – –
  customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. – – –
    name string Name of mapped field. – – –
    value string Value in named field. – – –

Tag end