Ocean bill of lading canonical guidelines

Canonical Element	Type Definition	Description	IDoc mapping	X12 mapping	EDIFACT mapping
data	–	Object type/root element.	–	–	–
	controlFileHeader	–	Canonical control file header to store data for control segments of IDocs and TL XML transactions, and EDI envelopes for X12 and EDIFACT.	–	–	–
	canonicalOceanBillOfLadingHeader	–	Payload for Ocean Freight Invoice canonical.	–	Segment B3 and B2A	–
		freightInvoiceShipmentType	string	Relationship of the shipment with respect to other shipments provided to the carrier at the same time. Valid values include: `SEAWAYBILL` - Document issued by an ocean carrier covering cargo shipped on a vessel owned by that carrier. `SINGLESHIPMENT` - Bill of Lading for Individual Shipment	–	B301 = 2 (SEAWAYBILL) or B (SINGLESHIPMENT) or	BGM01-010 = 710 (SEAWAYBILL) or 705 (SINGLESHIPMENT) or
		shipmentChargePaymentMethodType	string	Method of payment for delivery. Valid values include: `COLLECT` = Collect `BUYER` = Paid by buyer `ADVANCECOLLECT` - Advance Collect `BUYERSELLERDEFINED` - Defined by buyer and seller `ADVANCEPREPAID` - Advance prepaid `PREPAIDONLY` - Prepaid only `PREPAIDSELLER` - prepaid by seller `SELLER` - Paid by seller `THIRDPARTYPAY` - Third Party Pay	–	B304 = CC (COLLECT) or PA (ADVANCEPREPAID) or PO (PREPAIDONLY) or PP (PREPAIDSELLER) or PS (SELLER) or TP (THIRDPARTYPAY) or CA (ADVANCECOLLECT) or	–
		netAmountDue	Number	Total charges to be paid by the receiver expressed in the standard monetary denomination for specified currency.	–	B307	–
		carrierCode	string	Carrier code for shipper.	–	B311	–
		codeListResponsibleAgencyType	string	Specifies the organization or responsible agency code that maintains or governs the referenced code list.	–	–	–
		weightUnitType	string	Type of weight recorded. Valid values include: `KILOGRAMS` - Kilograms `POUNDS` - Pounds `OUNCES` - Ounces `GRAMS` - Grams	–	B305 = K (KILOGRAMS) or G (GRAMS) or E (METRICTON)	–
		servicesTariffCode	string	Types of services rendered and respective charges(As per contract) billed by the carrier. Valid values include: `BARGETOBARGE` - Rate for shipments for barge-to-barge carrier terminal service `BARGETODOOR` - Rate for shipments for barge-to-door service `BARGETOMOTOR` - Rate for shipments for barge-to-motorservice `BARGETORAIL` - Rate for shipments for barge-to-rail service	–	B313 = BB (BARGETOBARGE) or BD (BARGETODOOR) or BM (BARGETOMOTOR) or BR (BARGETORAIL)	–
		transportServiceType	string	Code specifying extent of transportation movement (operational my be differ from contract). Valid values include: `FCLTOFCL` - Full container load to Full container load, The shipper delivers a full container `FCLTOLCL` - A full container from the origin is de-consolidated at the destination `LCLTOLCL` - Less than Container Load to Less than Container Load, `LCLTOFCL` - Multiple shippers partial loads are consolidated at origin	–	–	–
		b2bTransactionIdentifierType	string	Referenced document type. Valid values include `BOL` - Bill of Lading Number.	–	L1102 = BM (BOL)	–
		b2bTransactionIdentifierValue	string	Reference identifier value.	–	L1101 when b2bTransactionIdentifierType =BOL	–
		localCurrency	string	Local currency code.	–	–	–
		processingFunctionTypeCode	string	Ocean Freight Invoice processing function code. Valid values include: `ORIGINAL` `CREATE` `CHANGE` `CONFIRM` `CANCEL`	–	B2A = 00 (ORIGINAL) or 01 (CANCEL) or 04 (CHANGE)	BGM030 = 1 (CANCEL) or 2 (CREATE) or 3 (DELETE) or 4 (CHANGE) or 5 (REPLACE) or 6 (CONFIRM) or 9 (ORIGINAL)
		documentStatus	string	Transport document lifecycle‐based status for a Bill of Lading document (Draft, Approved, Issued, Surrendered, Voided, etc. Valid values include: `DRAFT` - The Transport Document is currently a Draft `APPROVED` - The Transport Document has been Approved by consumer `ISSUED` - The Transport Document has been Issued by provider `PENDINGSURRENDERFORAMENDMENT` - The Transport Document has a pending Surrender for Amendment `SURRENDEREDFORAMENDMENT` - The Transport Document is Surrendered for Amendment `PENDINGSURRENDERFORDELIVERY` - The Transport Document has a pending Surrender for Delivery `SURRENDEREDFORDELIVERY` - The Transport Document is Surrendered for Delivery `VOIDED` - The Transport Document has been Voided	–	–	–
		documentStatusAgency	string	An agency that maintains given document status code.	–	–	–
		isElectronicDocument	boolean	Indicator whether the transport document is electronically transferred. Valid values: `TRUE` `FALSE`	–	–	–
		isToOrder	boolean	Indicates whether the B/L is issued to order or not. Valid values: `TRUE` `FALSE` Note: isToOrder must be false if freightInvoiceShipmentType= SEAWAYBILL	–	–	–
		isBOLShippedOnBoard	boolean	Specifies whether the Transport Document is a received for shipment, or shipped on board. Valid values: `TRUE` - Transport document shipped on board `FALSE` - Transport document received	–	–	–
		isCargoInsuranceProvidedByCarrier	boolean	Indicates whether cargo insurance for the shipment is arranged and provided by the carrier (transport operator), rather than by the shipper, consignee, or a third party.	–	–	–
		policyIdentifier	string	Insurance policy number.	–	–	–
		policyIssuingCompany	string	Name of insurance company issuing the policy.	–	–	–
		documentAuthentication		The first or primary signature that authenticates this exchanged document.	–	–	–
			authenticationIdentifier	string	Unique identifier assigned to the document authentication or signature event.	–	–	–
			authenticationDate	string	Date and time at which the document was authenticated or signed. Uses the same structure and rules as issueDateTime.	–	–	–
			epochAuthenticationDate	integer	Date and time at which the document was authenticated in epoch format.	–	–	–
			dateTimePeriodFormat	string	Code specifying representation of date or time or format presented in date value. Valid vlaues include: `CCYYMMDD` - Date format century year month day, 2 characters each `CCYYMMDDHHMM` - Date format century year month day hour minutes, 2 characters each	–	–	–
			authenticationStatement	string	Textual statement representing the declaration, certification, or wording associated with the document authentication.	–	–	–
		documentIssuedQuantity	array	The requested number of copies/ Originals of the Transport Document to be issued by the carrier including / not including charges	–	–	–
			issuedQuantityType	string	Type of quantity required. Valid values: - `COPYWITHCHARGES` - The requested number of copies of the Transport Document to be issued by the carrier including charges. `COPYWITHOUTCHARGES` - The requested number of copies of the Transport Document to be issued by the carrier NOT including charges. `ORIGINALWITHCHARGES` - The requested number of originals of the Transport Document to be issued by the carrier including charges. `ORIGINALWITHOUTCHARGES` - The requested number of originals of the Transport Document to be issued by the carrier NOT including charges	–	–	–
			quantityValue	string	Quantity of copies or originals issued.	–	–	–
		transactionReferenceIdentifiers	array	Transaction references for deliveries at header level.	–	Segment B3 and N9	–
			b2bTransactionIdentifierType	string	Referenced document type. .Valid values include: `OCEANBILLOFLADING` - (required) Internal transaction identifier `SHIPMENT` - Assigned to the shipment by the shipper `BOL` - Bill of Lading Number `COMBINEDSHIPMENT` - Combined shipment identifier `CONTRACT` - Contract number `SHIPPINGINSTRUCTION` - Shipping instruction identifier .	–	N901 = BM (BOL) Or PO (PURCHASEORDER) or CT (CONTRACT) or CR (CUSTOMERREFERENCE) or SI (SHIPMENT) CB (COMBINEDSHIPMENT)	RFF01-010 = CT (CONTRACT) Or BC (CUSTOMERCONTRACT) Or BM (BOL) or ON (PURCHASEORDER) Or VC (SUPPLIERCONTRACT) Or CR (CUSTOMERREFERENCE) or SI (SHIPMENT) Only one occurrence of BOL should be generated, either from BGM or from RFF.
			b2bTransactionIdentifierValue	string	Reference identifier value for invoice and shipment identified by transactionReferenceIdentifierType	–	B302 when b2bTransactionIdentifierType = OCEANBILLOFLADING (required) B303 when b2bTransactionIdentifierType = SHIPMENT N902 when b2bTransactionIdentifierType = INVOICE or BOL or PURCHASEODER or MASTERBOL or CONSIGNEEORDER or CONTRACT or CUSTOMERREFERENCE or PRICEQUOTEIDENTIFIER or COMBINEDSHIPMENT or SHIPMENT or VAT	BGM020-010 when b2bTransactionIdentifierType = OCEANBILLOFLADING (required) or BOL RFF01-020 when b2bTransactionIdentifierType = SHIPMENT or BOL or CONTRACT or CUSTOMERCONTRACT or DOCUMENT or BOL or MASTERBOL or DELIVERY or PURCHASEORDER or RELEASE or SUPPLIERCONTRACT or SUPPLIERORDER or CUSTOMERREFERENCE or SHIPPERSSHIPMENTIDENTIFIER
			lineItemNumber	string	Line item number in transaction reference. Line item level only.	–	–	–
			transactionDate	string	Date transaction created.	–	B306 when b2bTransactionIdentifierType = OCEANBILLOFLADING	DTM01-020 with DTM01-010 as 137 and DTM01-030 as 102 (Format: CCYYMMDD) when b2bTransactionIdentifierType = OCEANBILLOFLADING
			epochTransactionDate	integer	Date transaction created in epoch integer date format.	–	–	–
		transactionReferenceInformation	array	Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments L11 and N9 for information other than transaction documents.	–	N9 segment	–
			transactionReferenceType	string	Transaction reference type for X12 segments L11 and N9 for general reference data that is not a transaction document identifier. Valid values include: `BOOKINGIDENTIFIER`: Booking Number `FORWARDERREFERENCE` - Forwarder's/Agent's Reference Number `MUTUALLYDEFINED` - Mutually Defined `LETTEROFCREDIT` - Letter of credit `VEHICLEIDENTIFICATION` - Vehicle identification number (VIN) `VEHICLENUMBER` - Motor vehicle identification number	–	N901 = BN (BOOKINGIDENTIFIER) or FN (FORWARDERREFERENCE) or ZZ (MUTUALLYDEFINED)	RFF01-010 = LC (LETTEROFCREDIT) Or EX (EXPORTLICENSE) Or AHL (CREDITORSREFERENCE) BN (BOOKINGIDENTIFIER) FF (FORWARDERREFERENCE) VT (VEHICLENUMBER) AKG (VEHICLEIDENTIFICATION)
			transactionReferenceIdentifier	string	Transaction reference identifier value.	–	N902 when b2bTransactionIdentifierType = BOOKINGIDENTIFIER or FORWARDERREFERENCE or CUSTOM	RFF01-020 when transactionReferenceType = LETTEROFCREDIT or EXPORTLICENSE or CREDITORSREFERENCE
			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 for referenced document	–	–	RFF Loop/ DTM Loop
				dateType	string	Date type at header level for Application Advices in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values include: - Dates relevent to reference information.	–	–	DTM010-010 = 137 (DOCUMENT)
				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 specifiying 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.	–	–	–
		mpcDates	array	Invoice dates at header level.	–	–	–
			dateType	string	referenced date type. Valid values include: `SHIPPED` `ESTIMATED` `ACTUAL` `DELIVERY` `DOCUMENT` `SAILING` `BOL`	–	B310 = 139 (ESTIMATED) Or 140 (ACTUAL) 005 (SAILING)	DTM01-010 = 11 (CANCELBY) Or 11 (SHIPPED) 95 (BOL) 342 (LOADING) 137 (DOCUMENT) populate this 137 instance only if it has not populated from transactionDate
			dateValue	string	Date defined by referenced date type.	–	B309, B312 (When dateType = SAILING)	DTM01-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.	–	–	–
		mpcCurrency	array	Currency codes for freight invoice.	–	Segment C3	Segment CUX
			currencyCode	string	Currency code for pricing in freight invoice.	–	C301	CUX010-020 when CUX010-010 = 1 or 2 or 5 and CUX010-030 = 4
			exchangeRateCurrencyCode	string	Currency code for currency exchange.	–	–	–
			exchangeRate	number	Exchange rate for conversion from currencyCode to currencyCodeExchange	–	–	CUX030
			validityDate	string	Validity date for exchange rate.	–	–	–
			epochValidityDate	integer	Validity date for exchange rate generated in epoch integer date format.	–	–	–
			currencyEntityCode	string	Currency entity code.	–	–	–
		contactInformation	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 whome 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 FC (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"
		customsReferenceInformation	array	Additional identifiers for specific needs, for example required by national agency such as customs.	–	–	–
			customsReferenceType	string	Customs and/or excise purposes required by the relevant authorities for the import, export, or transit of the goods. For Example listed below. Pass through Type - Country - Description UCR -NL - Unique Consignment Reference CUS -NL - Customs Union and Statistics ACID - EG - Advance Cargo Information Declaration in Egypt	–	–	–
			customsReferenceValue	string	The value of the customsReference type.	–	–	–
			codeListIdentifier	string	Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.	–	–	–
			codeListResponsibleAgencyType	string	Specifies the organization or responsible agency code that maintains or governs the referenced code list.	–	–	–
			countryCode	string	The 2 characters for the country code using ISO 3166-1 alpha-2.	–	–	–
		transportServiceRequirements	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.	–	–	–
			servicesTariffCode	string	Types of services rendered 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	–	–	TSR010-010
			serviceRequirementCode	string	Code to identify a service (which may constitute an additional component to a basic contract). Valid values: `2` - Full Load `3` - Less than full loads	–	–	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
		vesselDetails	array	Vessel identifier information along with transportation details such as dates, quantity, weight and volume.	–	Segment V1	–
			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 `SHIPSRADIOSIGNAL` - 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)	–
		locations	array	Port or terminal details related to cargo movement.	–	R4 Loop	Segment group: 01 : LOC (Part of Header)
			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` - Reconsolidation 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	–	–	–
				oceanShipmentLocationIdentifier	string	Identifies the cargo's specific location.	–	R403	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 location or port or place.	–	R404	LOC020-040
				countryCode	string	Country code.	–	R405	LOC030-010 (LOC030-020 = 162 (Country))
				terminalName	string	Terminal Name.	–	R406	–
				state	string	State code.	–	R408	LOC040-010 (LOC040-020 = 169 (Country- sub entity))
			mpcDates	array	Dates relevant to location events, provision given to map to EDIFACT data.	–	DTM	LOC-DTM
				dateType	string	Date type related to shipment events at port] in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS. Valid values include: `ESTIMATED` - Estimated `ACTUAL` = Actual `ESTIMATEDDEPARTURE` - Estimated Departure Date `ACTUALDEPARTURE` - Actual Departure date `ESTIMATEDARRIVAL` - Estimated Arrival date `ACTUALARRIVAL` - Actual arrival date `CUSTOMSCLEARANCE` - Customs Clearance date `VESSELLOADED` - Loaded on vessel date `CUSTOMSENTRY` - Customs entry date `PACKED` - Date packed	–	DTM01 = 139 (ESTIMATED) Or 140 (ACTUAL) Or 369 (ESTIMATEDDEPARTURE) Or 370 (ACTUALDEPARTURE) Or 371 (ESTIMATEDARRIVAL) Or 372 (ACTUALARRIVAL) Or 058 (CUSTOMSCLEARANCE) Or 161 (VESSELLOADED) Or 813 (CUSTOMSENTRY) Or 510 (PACKED)	DTM010-010
				dateValue	string	Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.	–	DTM02 & DTM03	DTM010-020
				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.	–	DTM04	–
		containerDetails	array	Describes container information and transportation services used for ocean freight.	–	Segment Y2	–
			numberOfContainers	number	Number of shipping containers.	–	Y201	–
			freightContainerType	string	Type of container for requested equipment on vessel. Valid values are: `CONTAINERS` - Containers only `CONTAINERSWITHCHASIS` - Containers with chasis `SHIPPERPROVIDED` - Shippers to provided `CHASIS` - Chasis only	–	Y202 = R (CONTAINERS) or C (CONTAINERSWITHCHASIS) or S (SHIPPERPROVIDED) or W (CHASIS)	–
			transportServiceType	string	Types of transport service requested and respective charges billed by the carrier. Valid values are: `AIRPORTTOAIRPORT` - Rate for requested transport services from airport to airport `BULKBREAK` - Rate for requested transport services for bulk break `DOORTODOOR` - Rate for requested transport services from door to door `DOORTOAIRPORT` - Rate for requested transport services from door to airport	–	Y203 = AA (AIRPORTTOAIRPORT) or BB (BULKBREAK) or DD (DOORTODOOR) or DA (DOORTOAIRPORT)	–
			equipmentTypeISOCode	string	Equipment type ISO code.	–	Y204	–
			equipmentIdentifier	string	Sequencing or serial part of an equipment unit's identifying number.	–	–	–
			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	–
			carrierCode	string	Shipping carrier alpha code (SCAC).	–	Y207	–
		carrierSequenceInformation	array	Carrier sequence information for shipment. Records cit and state or province location for each carrier used for shipment.	–	Segment R2	–
			carrierCode	string	Shipping carrier alpha code (SCAC).	–	R201	–
			carrierSequenceCode	string	Code identifying sequence of carriers in shipment, beginning with the original carrier. Valid values include: `ORIGINAL` - Original carrier `FIRST` - First carrier after original `SECOND` - Second carrier after original `THIRD` - Third carrier after original `FOURTH` - Fourth carrier after original `FIFTH` - Fifth carrier after original	–	R202 = 0 (ORIGINAL) or 1 (FIRST) or 2 (SECOND) or 3 (THIRD) or 4 (FOURTH) or 5 (FIFTH)	–
			transportMethod	string	Transport method type. Valid values include: `TRUCK` - Truck `RAIL` - Shipped by train `SEA` - By sea `AIR` - By air `LTL` - Less than truckload `AIREXPRESS` - Air express `CONTAINERSEA` -Container by ship	–	R206	–
			city	string	City name for the shipment's current carrier sequence.	–	R203	–
			state	state	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 are: `AIRPORTTOAIRPORT` - Rate for requested transport services from airport to airport `BULKBREAK` - Rate for requested transport services for bulk break `DOORTODOOR` - Rate for requested transport services from door to door `DOORTOAIRPORT` - Rate for requested transport services from door to airport	–	R212 = AA (AIRPORTTOAIRPORT) or BB (BULKBREAK) or DD (DOORTODOOR) or DA (DOORTOAIRPORT)	–
			description	string	Route descriptive information.	–	R213	–
		specialHandlingInformation	array	Special handling instructions for shipment. All parameters to be understood in the form of different codes used by industry,	–	Segment H3	–
			handlingCode	string	Code specifying special transportation handling instructions. Valid Values are: `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)	–
		consignmentTemperatureRange	array	Temperature range setting details required to be maintained during throughout transport for goods items.	–	–	–
			rangeType	string	Type of range. Valid values: `TEMPERATURE` - Item temperature range `TRANSPORTTEMPERATURE` - Transport temperature range	–	–	–
			minimumValue	number	Shipment minimum allowable Temperature.	–	–	–
			maximumValue	number	Shipment maximum allowable temperature.	–	–	–
			unitOfMeasure	string	Temperature unit of measure. Valid values: `CE` - Celsius `FA` - Fahrenheit	–	–	–
			description	string	Descriptive information about environment required for goods item.	–	–	–
		marksAndNumbers	array	Lading item in terms of description, quantity, packaging, and marks and numbers.	–	Segment: L5 at header	–
			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)	–
			ladingPackageType	string	Describes the type of packaging; Part 1: Packaging Form, Part 2: Packaging Material; if the Data Element is used, then Part 1 is always required. Valid values are : `STANDARD` `CASE` `CARTON` `PALLET` `RACK` `UNIT` `TRUCK`	–	L505 = 90 (STANDARD) or CAS (CASE) or CTN (CARTON) or PLT (PALLET) or RCK (RACK) or UNT (UNIT) or TRU (TRUCK)	–
		termsOfPayment	array	Terms of payment looping group.	–	–	–
			termsOfPaymentKey	string	Terms of payment.	–	–	–
			termsOfPaymentTypeCode	string	Code identifying type of payment terms. Valid values: `BASIC` `DEFERRED` `DISCOUNTNOTAPPLICABLE` `ENDOFMONTH` `EXTENDED` `FIXEDDATE` `MIXED` `PREVIOUSLYAGREED` `PROXIMO` `SELLER`	–	–	–
			termsOfPaymentDateBasis	string	Code identifying the beginning of the terms period. Valid values: `DELIVERYDATE` - Delivery date `EFFECTIVEDATE` - Effective date `INVOICEDATE` - Invoice date `INVOICERECEIPTDATE` - Invoice receipt date `PURCHASEORDERDATE` - Purchase order date. `SHIPDATE` - Shipping date	–	–	–
			numberOfDays	string	Terms of payment: number of days.	–	–	–
			discountDueNumberOfDays	number	Terms Discount Days Due. Number of days in the terms discount period by which payment is due if terms discount is earned.	–	–	–
			termsOfPaymentPercent	string	Terms of payment: percentage.	–	–	–
			invoicePayablePercent	string	Percentage of invoice payable.	–	–	–
			discountDueDate	string	Discount due date in string date format YYYY-MM-DD.	–	–	–
			epochDiscountDueDate	integer	Discount due date in epoch integer date format.	–	–	–
			paymentDueDate	string	Due date for payment.	–	–	–
			paymentDeferredToDate	string	Date deferred payment or percent of invoice payable is due.	–	–	–
			epochPaymentDueDate	integer	Due date for payment generated in epoch integer date format.	–	–	–
			epochPaymentDeferredToDate	integer	Date deferred payment or percent of invoice payable is due generated in epoch integer date format.	–	–	–
			paymentDeferredDueAmount	string	Deferred amount due for payment.	–	–	–
			description	string	Terms of payment description.	–	–	–
			totalTermDiscountAmount	integer	Terms of payment discount amount. Total amount of terms discount.	–	–	–
			dayOfMonth	integer	The numeric value of the day of the month between 1 and the maximum day of the month being referenced.	–	–	–
		creditsAndCharges	array	Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others.	–	–	CPI
			creditChargeKeyType	string	Key identifies credit or charges as discounts or additional charges. Valid values include: `ALLOWANCE` `CHARGE` `PROMOTION`	–	–	–
			creditChargeType	string	Code representing type of credit or charge: Valid values include `FREIGHT` - Basic Freight.	–	–	CPI010-010
			creditChargeAmount	string	Total amount for the payment.	–	–	–
			qualifyingAmount	string	Amount qualifying for cash discount, allowance, promotion, service or charge.	–	–	–
			creditChargePercentRate	string	Percentage rate for cash discount, allowance, promotion, service or charge.	–	–	–
			percentRateBasisTypeCode	string	Code indicating basis that allowance or charge percent is calculated.	–	–	–
			creditChargeCurrencyCode	string	Currency code for credit or charge.	–	–	–
			creditChargeHandlingCode		Method of handling for discount or charge. Valid values include: `COLLECT` - Collect `PREPAID` - Prepaid	–	–	CPI020-010 = CC (COLLECT) Or PP (PREPAID)
			chargePaymentMethod	string	Payment method for freight invoice charges. Valid values include: `COLLECT` `PREPAID` `THIRDPARTYPAY`	–	–	CPI030 = C (COLLECT) Or P (PREPAID) Or B (THIRDPARTYPAY)
			description	string	Description of credit or charge.	–	–	–
			unitPriceAmount	string	Unit price amount.	–	–	–
			unitPriceBasisQuantity	string	Quantity basis for the unit price.	–	–	–
			itemQuantity	string	Item quantity.	–	–	–
			unitOfMeasure	string	Base unit of measure or UOM for quantity of item in pack. Quantity UOMs include: `CA` - Case `CP` - Crate	–	–	–
			baseValue	string	–	–	–	–
			creditChargeConditionType	string	Credit charge condition type.	–	–	–
		deliveryTerms	array	Terms of delivery, transport or inco terms looping group.	–	–	Segment Group: 14 (TOD) at header
			description	string	Description for inco term.	–	–	TOD040, TOD050
			deliveryTermsConditionCode	string	Delivery Terms condition code.	–	–	TOD010
			shipmentChargePaymentMethodType	string	Method of payment for delivery. Valid values inlcude: `ADVANCECOLLECT` `ADVANCEPREPAID` `BUYER` `BUYERSELLERDEFINED` `COLLECT` `COLLECTDELIVERY`	–	–	TOD020 = CC (COLLECT) or CA (ADVANCECOLLECT) or PO (PREPAIDONLY)or WE (BUYER) or DF (BUYERSELLERDEFINED) or PA (ADVANCEPREPAID) or PP (PREPAIDSELLER) or TP (THIRDPARTYPAY)
			fobTransferLocation	string	Code specifying the type of location at which the risk of loss for the shipment transfers. Valid values: `CITY` `PLANT` `SHIPPINGDESTINATION` `SHIPPINGORIGIN`	–	–	–
			deliveryTermsCode	string	Delivery terms condition code. Valid values include: `INCO1` - INCOTERMS part 1 `INCO2` - INCOTERMS part 2	–	–	–
		freightRatesCharges	array	Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements this is to send , how the rates are calculated, Rate basis, Rate class, quantity basis along with total charges.	–	–	Segment Group: 06 (TCC ( segment:TCC & MOA) at header)
			lineItemNumber	string	Sequential line number for freight invoice item.	–	–	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 (implicit decimal)	Rate that applies to the specific commodity.	–	–	–
			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 )	–	–	–
			freightInvoiceChargeType	string	Code representing type of freight charges. Valid values `FREIGHTDUE` - Freight charge.	–	–	MOA010-010 = 64 (FREIGHTDUE)
			totalCharges	number	Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency.	–	–	MOA010-020
			currencyCode	string	Currency code for the pricing amount.	–	–	MOA010-030
			currencyUsageType	string	Describes the type of currency based on usage. Valid values are: `CUSTOMS` - Customs valuation currency `INVOICE` - Invoicing currency `ACCOUNT` - Account currency `TARGET` - Destination or target currency `ORDER` - Purchase order currency `PRICING` - Pricing currency `TAX` - Tax currency	–	–	MOA010-040 = 1 (CUSTOMS) or 4 (INVOICE) or 5 (ACCOUNT) or 7 (TARGET) or 9 (ORDER) or 10 (PRICING) or 18 (TAX)
			advancePayment	number	Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.	–	–	–
			prepaidAmount	number	Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.	–	–	–
			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	–	–	–
			rateClassCode	string	Identifies specific & designated class of goods; Note: For international air shipments. Valid values include: `CONTRACT` - Contract rate `EXCESSWEIGHT` - Weight in Excess of Pivot Weight and Applicable Rate `MINIMUM` - Minimum `QUOTED` - Quoted rate `SENDER` - Sender rate `CONTAINER` - IATA Container or Unit Load Device (ULD) `EXCEPTION` - Exception rating `BASIC` - Basic rate `COMMODITY` - Specific commodity rate `EXPORT` -Export Subsidy Rate `SUBSIDY` - Subsidy Rate `KILOGRAM` - Rate per kilogram	–	–	–
			chargeEntitlementParty	string	To describe the types of party involved. Valid values: `SHIPPER` `CONSIGNEE` `ISSUINGCARRIER` `DESTINATIONCARRIER`	–	–	–
			chargePaymentMethod	string	Payment method for freight invoice charges. Valid values: `PREPAIDCASH` `PREPAIDCREDIT` `COLLECT` `COLLECTCASH` `COLLECTCREDIT` `PREPAID` `THIRDPARTYPAY`	–	–	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.	–	–	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 `KILOGRAM` - Kilograms `HUNDREDPOUND` - 100 pounds `PALLET` - Pallet `STOPS` - Stops `DAYS` - Days `HOURS` - Hours `TONS` - Tons	–	–	–
			billedQuantityValue	number	Quantity of product in delivery.	–	–	–
			freightRatePercent	number	Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%).	–	–	–
			currencyCode	string	Billed Currency Code.	–	–	–
			companyIdentifierType	string	Company identifier type for business partner. Valid values include: `GLN` `DUNS` `DUNS4` `COMPANYID` `COMPANYSITEID`	–	–	–
			companyIdentifierValue	string	Company identifier value for business partner	–	–	–
			rateOrTariffClassDescription	string	Free form description of an applicable rate or tariff class.	–	–	–
			codeListIdentifier	string	Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.	–	–	TDT010-020
			agencyCode	string	Specifies the organization or responsible agency code that maintains or governs the referenced code list.	–	–	TDT010-030
			pricingInformation	array	Pricing information for product.	–	–	TCC/PRI loop
				pricingType	string	Pricing type for price sales catalog. Valid values include `UNIT` - Per Unit	–	–	PRI010-030 = PE(UNIT) PRI010-010 = "CAL" (Cal price)
				pricingAmount	number	Unit price for pricing type.	–	–	PRI010-020
				currencyCode	string	Currency code for the pricing amount.	–	–
				pricingTypeQuantity	number	Quantity for pricing type.	–	–	PRI010-050
				unitPriceBasisQuantity	string	Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12.	–	–	–
				unitOfMeasure	string	Unit of measure used for pricing at the price conditions line item details level.	–	–	PRI010-060
				priceChangeCode	string	Code indicating of action to be taken when sub line item price changes, EDIFACT Pass through, possible values: `A` - Added to the baseline item unit price `I` - Included in the baseline item unit price `S` - Subtracted from the baseline item unit price	–	–	PRI020
			itemQuantity	array	Quantity details pertain to charges	–	–	TCC- QTY Loop
				quantityType	string	Type of quantity recorded. Valid values include `CHARGEABLEWEIGHT` - Chargeable weight quantity from the total consignment quantity.	–	–	QTY01
				quantityValue	number	Quantity of product in shipment	–	–	QTY02
				unitOfMeasure	string	Unit or Basis for Measurement Code. Unit of entry UOM's include: `UN` - Unit `PC` - Piece	–	–	–
		transportStageLocationDetails	array	Transport details such as mode of transport, means of transport, its conveyance reference number and the identification of the means of transport. Stage by stage transport details.	–	–	Segment Group: 8 (TDT)
			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 accommodate)	–	–	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
			carrierCodeIdentifier	–	Agency codes and its referenced code list to interpret the carrier code correctly.	–	–	–
				agencyCode	string	Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.	–	–	TDT050-020
				codeListIdentifier	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.	–	–	–
				agencyCode	string	Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.	–	–	TDT080-020
				codeListIdentifier	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 `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.	–	–	–
			mpcDates	array	Dates relevant to location events, provision given to map to EDIFACT data.	–	–	TDT-DTM
				dateType	string	Date type related to shipment events at port] in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS. Valid values include `LOADING` - On board date.	–	–	DTM010-010
				dateValue	string	Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.	–	–	DTM010-020
				epochDateValue	integer	Date defined by referenced date type generated in epoch integer date format.	–	–	–
				dateTimePeriodFormat	string	Code specifiying 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	–	–	–	–	–
			cargoMovementPortDetails	array	Stage/ Sequence wise carrier assigned movement details.	–	–	TDT-LOC Loop - group5
				portOrTerminalDetails	–	–	–	–	LOC
					portOrTerminalFunctionCode	string	Port or Terminal function codes., Valid values include: `ORIGIN` - Origin `PORTOFLOADING` - Port of Loading `PORTOFDISCHARGE` - Port of Discharge `TRANSSHIPMENT` - Transshipment Port `CONSOLIDATIONPOINT` - Reconsolidation Point `DECONSOLIDATIONPOINT` - De-Consolidation Point `FINALDESTINATION` - Final Destination	–	–	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	–	–	–
					locationCodeListIdentifier	–	Agency codes and its referenced code list to interpret the carrier code correctly.	–	–	–
						codeListIdentifier	string	Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.	–	–	LOC020-020
						agencyCode	string	Specifies the organization or responsible agency code that maintains or governs the referenced code list.	–	–	LOC020-030
					oceanShipmentLocationIdentifier	string	Identifies the cargo's specific location.	–	–	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	–	–	–
				mpcDates	array	Dates relevant to location events, provision given to map to EDIFACT data	–	–	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	–	–	DTM010-010
					dateValue	string	Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.	–	–	DTM010-020
					epochDateValue	integer	Date defined by referenced date type generated in epoch integer date format.	–	–	–
					dateTimePeriodFormat	string	Code specifying representation of date or time or format presented in date value, Valid values include: `CCYYMMDD` - Date format century year month day, 2 characters each `CCYYMMDDHHMM` - Date format century year month day hour minutes, 2 characters each	–	–	DTM010-030
					timeZone	–	–	–	–	–
		partnerBusinessInformation	array	Party company identifiers and address information.	–	N1 Loop	NAD Loop
			businessPartyInformation		Business Parties identifiers and address information.	–	N1	–
				partnerEntityType	string	Denotes type of the entity involved in this business transaction. Valid values include: `SENDER` - Message sender `RECEIVER` - Message receiver	–	N101	NAD01
				businessName	string	Business name for partner or location.	–	N102	NAD040-010
				additionalBusinessName	string	Additional Business name for partner or location.	–	N201	–
				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 EDIFACT supported codes: DUNS = 16 DEA = 164 HIN = 21 COMPANYID = 91 COMPANYSITEID = 92
					companyIdentifierValue	string	Company identifier value for business partner.	–	N104	NAD020-010
					alternateCompanyLocationIdentifierValue	string	Alternate company location identifier value.	–	–	–
				address	–	Party address information.	–	N3, N4,	–
					address1	string	Main street address.	–	N301	NAD050-010
					address2	string	Supplemental street address.	–	N302	NAD050-020
					city	string	City	–	N401	NAD060
					district	string	District	–	–	–
					state	string	State or region code	–	N402	NAD070-010
					postalCode	string	Postal code	–	N403	NAD080
					country	string	Country code	–	N404	NAD090
					telephone	string	Telephone number	–	–	–
					fax	string	Fax number	–	–	–
					url	string	Website URL	–	–	–
					buildingNumber	string	Building number	–	–	–
					plantNumber	string	Plant number	–	–	–
					floorNumber	string	Floor number in building.	–	–	–
					lscAddressIdentifier	string	LSC address identifier.	–	–	–
					village	string	Village name	–	–	–
					houseNumber	string	House number	–	–	–
					township	string	Township	–	–	–
					premisesCode	string	Premises code	–	–	–
				companyLocationContactInformation	–	–	–	N1-PER	CTA
					contactType	string	Contact type. Valid values include: `INFORMATION` - Information contact `PRIMARY` - Primary contact `RESPONSIBLE` - Responsible person	–	PER01 = IC (INFORMATION)	CTA010 = IC (INFORMATION)
					contactName	string	Contact name.	–	PER02	CTA020-020
					contactTitle	string	Title of contact.	–	–	–
					contactPhone	string	Contact phone number.	–	PER04 where PER03 = "TE"	COM010-010 where COM010-020 = "TE"
					contactEmail	string	Contact email address.	–	PER06 where PER05 = "EM"	COM010-010 where COM010-020 = "EM"
				mpcAdditionalAddressInformation	–	Additional address information that is not included in addressTypeDefinition.	–	–	–
					externalERPUserName	string	External ERP system user name for user who generated message.	–	–	–
					organizationCode	string	Code for organization responsible for generating the message.	–	–	–
					organizationDescription	string	Description of the organization responsible for generating the message.	–	–	–
					groupCode	string	Code identifying group responsible for generating the message.	–	–	–
					language	string	Language key for message.	–	–	–
					languageCode	string	ISO language code for message.	–	–	–
					referenceIdentifier	string	Partner reference identifier.	–	–	–
					orderType	string	Order Type.	–	–	–
					address3	string	Additional address information that is not included in addressTypeDefinition.	–	N202	–
					address4	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	–
			transactionReferenceIdentifierList	array	Transaction references for deliveries at header level.	–	–	Segment RFF
				b2bTransactionIdentifierType	string	Referenced document type. Valid values include `FREIGHTCONTRACT` - Transport Contract Number.	–	–	RFF01-010 = AAS (FREIGHTCONTRACT)
				b2bTransactionIdentifierValue	string	Reference identifier value for invoice and shipment.	–	–	RFF01-020 when b2bTransactionIdentifierType = FREIGHTCONTRACT
				lineItemNumber	string	Line item number in transaction reference. Line item level only.	–	–	–
				transactionDate	string	Date transaction created.	–	–	–
				epochTransactionDate	integer	Date transaction created in epoch integer date 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.	–	–	Segment 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: `FREIGHTCONTRACTREFERENCE` - Freight Contract reference number `VAT` - VAT registration Number	–	–	RFF01-010 = AHI (FREIGHTCONTRACTREFERENCE) Or VA (VAT)
				transactionReferenceIdentifier	string	Transaction reference identifier value.	–	–	RFF01-020 when transactionReferenceType = FREIGHTCONTRACTREFERENCE or VAT
				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.	–	–	–
		exportLicense	array	Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.	–	–	–
			isRequired	boolean	Information provided by the shipper to indicate whether an Export License or permit is required for this shipment/commodity/destination Valid values: `True` - Required `False` - Not required	–	–	–
			licenseNumber	string	License number assigned by authority.	–	–	–
			licenseIssuingAgency	string	License number given authority or agency code.	–	–	–
			licenseTypeCode	string	License control/type, code.	–	–	–
			licenseCountry	string	Issuing country code.	–	–	–
			IssueDate	string	License issued date.	–	–	–
			epochIssueDate	integer	License issued date in epoch format.	–	–	–
			expirationDate	string	License expiry date.	–	–	–
			epochExpirationDate	integer	License expiry date in epoch format.	–	–	–
			exportClassificationCode	string	Export classification code ECCN code.	–	–	–
		importLicense	array	Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.	–	–	–
			isRequired	boolean	Information provided by the shipper to indicate whether an Export License or permit is required for this shipment/commodity/destination Valid values: `True` - Required `False` - Not required	–	–	–
			licenseNumber	string	License number assigned by authority.	–	–	–
			licenseIssuingAgency	string	License number given authority or agency code.	–	–	–
			licenseTypeCode	string	License control/type, code.	–	–	–
			licenseCountry	string	Issuing country code.	–	–	–
			IssueDate	string	License issued date.	–	–	–
			epochIssueDate	integer	License issued date in epoch format.	–	–	–
			expirationDate	string	License expiry date.	–	–	–
			epochExpirationDate	integer	License expiry date in epoch format.	–	–	–
			exportClassificationCode	string	Export classification code ECCN code.	–	–	–
		certificationClause	array	Defines standardized certifications or contractual clauses associated with a shipment, capturing both the coded clause and its descriptive text for inclusion in transport documents like the Bill of Lading.	–	Segment C8 Loop under ST	–
			lineItemNumber	string	transaction set line number	–	–	–
			certificationOrClauseCode	string	Coded certification/condition applied Valid values include: `SHORTSHIPPED` - Cargo Short‑Shipped `EMERGENCYSTATEMENT` - Instructions for accident handling (spill, fire, DG). `IMOCERTIFICATION` - Confirms cargo meets maritime safety rules. `CERTIFICATIONSTATEMENT` - General compliance confirmation. `NOEXPORTDECLARATION` - No Shipper’s Export Declaration Required `CUSTOM` - Custom / Mutually Defined Clause	–	C802 = 08 (SHORTSHIPPED) Or 29 (EMERGENCYSTATEMENT) Or 30 (IMOCERTIFICATION) Or 38 (CERTIFICATIONSTATEMENT) Or 20 (NOEXPORTDECLARATION) Or CC (CUSTOM)	–
			description	string	Free‑form clause or descriptive text supporting the code.	–	C803	–
			certificationClauseDescription	array	Stores additional free‑form continuation texts associated with a certification or contractual clause.	–	Segment C8C under ST- C8 loop	–
				description	string	Clause free form text description	–	C8C01 / C802 / C803	–
		freeTextNote	array	Free text, instructions, notes, descriptions and other free text elements	–	Segment K1	Segment FTX
			textReferenceCode	string	Text reference or subject code. Example values for EDIFACT: `AAA` - Goods item description `AAB` - Payment term `AAD` - Dangerous goods technical name `AAK` - Price conditions `AAR` - Delivery terms `AAS` - Bill of lading remarks `DAR` - Damage remarks `COI` - Order Information `CUR` - Customer remarks `DIN` - Delivery instruction `INV` - Invoice instruction `BLC` - Bill of lading clause	–	–	FTX010
			textFunctionCode	string	Text function code.	–	–	FTX020
			language	string	Language key for message.	–	–	–
			languageCode	string	ISO language code for message.	–	–	–
			textFormatCode	string	Format code for free text.	–	–	–
			freeText	string	Free text array.	–	K101, K102 Each is 30 characters. Mapping to canonical, concatenate K1 and K2. Mapping from canonical split into 2 fields.	FTX040-010, FTX040-20, FTX040-030, FTX040-040
		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.	–	–	–
	canonicalOceanBillOfLadingLineItemDetails	array	Ocean Bill of lading line items details.	–	LX Loop starts	–
		lineItemNumber	string	transaction set line number.	–	LX01 (Mandatory)	Incremental number
		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.	–	–	EQD020-020
				agencyCode	string	Specifies the organization or agency code that maintains or governs the referenced code list.	–	–	EQD020-030
			carrierCode	string	Carrier code for shipper.	–	N712	–
			equipmentType	string	Type of equipment used in delivery. Valid values: `CONTAINER` `RAILCAR` `TRAILER` `SHIP` `AIRCRAFT` `TRUCK`	–	N711 = AP (AIRCRAFT) or CN (CONTAINER) or RR (RAILCAR) or TL (TRAILER) or VT (SHIP) or TO (TRUCK)	EQD010 = AK (AIRCRAFT) or CN (CONTAINER) or RR (RAILCAR) or TE (TRAILER)
			equipmentTypeISOCode	string	Equipment type ISO code	–	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 : `SHIPPER` - Shipper supplied `CARRIER` - Carrier supplied `CONSOLIDATOR` - Consolidator supplied `DECONSOLIDATOR` - De-consolidator supplied `THIRDPARTY` - Third party supplied `FORWARDER` - Forwarder supplied from a leasing company `FORWARDERRAILWAYS` - Forwarder supplied from railways pool	–	–	EQD040 = 1 (SHIPPER) Or 2 (CARRIER) Or 3 (CONSOLIDATOR) Or 4 (DECONSOLIDATOR) Or 5 (THIRDPARTY) Or 6 (FORWARDER) Or 7 (FORWARDERRAILWAYS)
			isNONReefer	boolean	Place holder to note a Reefer Container should be treated as a DRY container and non operational. Valid values: `True` - Dry container `False` - (Default) Reefer container	–	–	–
			equipmentLoadIndicator	string	Indicate the extent of equipment utilize for this consignment. Valid values: `EMPTY` - Equipment is empty `FULL` - Equipment is full `MORETHANONEQUARTER` - More than one quarter volume available `MORETHANHALF` - More than half volume available `MORETHANTHREEQUARTER` - More than three quarters volume available `NOVOLUME` - No volume available `FULLMIXED` - Full, mixed consignment `FULLSINGLE` - Full, single consignment	–	–	EQD060 = 4 (EMPTY) Or 5 (FULL) Or 1 (MORETHANONEQUARTER) Or 2 (MORETHANHALF) Or 3 (MORETHANTHREEQUARTER) Or 6 (NOVOLUME) Or 7 (FULLMIXED) Or 8 (FULLSINGLE)
			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	–
			transportServiceType	string	Types of transport service requested which may differ from contract conditions. Valid values are: `AIRPORTTOAIRPORT` - Rate for requested transport services from airport to airport `BULKBREAK` - Rate for requested transport services for bulk break `DOORTODOOR` - Rate for requested transport services from door to door `DOORTOAIRPORT` - Rate for requested transport services from door to airport `FCLTOFCL` - Container fully loaded `LCLTOLCL` - Container partially loaded, The shipper delivers partial cargo `FCLTOLCL` - A full container from the origin is deconsolidated at the destination `LCLTOFCL` - Multiple shippers partial loads are consolidated at origin, then the container is delivered intact to a single consignee at destination.	–	N719 = AA (AIRPORTTOAIRPORT) or BB (BULKBREAK) or DD (DOORTODOOR) or DA (DOORTOAIRPORT)	TMD010-010
			serviceTypeDescription	string	Free form description of movement or extended service carrying	–	–	TMD010-020
			serviceProvidedParty	string	Equipment haulage arrangements done by. Valid values includes: `CARRIER` - Carrier `MERCHANT` - Haulage arranged by merchant (shipper, consignee, or their agent).	–	–	TMD030 = 1 (CARRIER) Or 2 (MERCHANT)
			equipmentDimensions	array	Dimensions of equipment / transportable unit	–	Segment N7	EQD-DIM
				dimensionType	string	Type of dimensions recorded for cargo / transportable unit. Valid values include: `LENGTH` `WIDTH` `HEIGHT` `OFFSTANDARDLEFT` - The dimension in the width that the cargo exceeds the standard width at the left side of an equipment `OFFSTANDARDRIGHT` - The dimension in the width that the cargo exceeds the standard width at the right side of an equipment `OFFSTANDARDBACK`- The dimension in the length that the cargo exceeds the standard length at the back of an equipment `OFFSTANDARDFRONT` - The dimension in the length that the cargo exceeds the standard length at the front of an equipment.	–	–	–
				dimensionValue	Number	Volume for item in inches or centimeters.	–	N715where dimensionsType = LENGTH N720 where dimensionsType = HEIGHT N721 where dimensionsType = WIDHT	DIM020-020, when dimensionsType = LENGTH DIM020-030, when dimensionsType = WIDTH DIM020-040, when dimensionsType = HEIGHT
				unitOfMeasure	string	Dimension unit of measure for parent packaging.	–	–	DIM020-010
			itemQuantity	array	Equipment quantity.	–	N7-QTY	EQD - EQN
				quantityType	string	Type of quantity recorded. Valid values: Valid values include `SHIPPED` - Shipped quantity.	–	QTY01 = 39 (SHIPPED)	–
				quantityValue	number	Quantity of product in shipment.	–	QTY02	EQN010-010, when EQN010-020 = 2
				unitOfMeasure	string	Unit or Basis for Measurement Code. Unit of entry UOM's include: `UN` - Unit `PC` - Piece	–	QTY03-01 = PC (PC)	–
			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. 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. `NETWEIGHT` - Net weight `NETVOLUME` - Net volume `RADIOACTIVITY` - Radio activity `MUTUALLYDEFINED` - Custom measurement type	–	–	MEA020-010 = SQ (SHIPPEDQUANTITY) Or AAW (GROSSVOLUME) Or AET (EQUIPMENTGROSSWEIGH) Or G (GROSSWEIGHT) Or AAF (NETWEIGHT) Or AAX (NETVOLUME) Or AEO (RADIOACTIVITY) Or ZZZ (MUTUALLYDEFINED)
			equipmentSealNumbers	array	Shipment carrying equipments seal numbers.		segment loop LX-N7-M701	–
				sealNumber	string	Applied seal number for shipment carrying equipment.	–	M701	SEL010
				sealAppliedEntityType	string	Seal applied entity type code, it could be an organization or location or an individual. Valid values are: `CARRIER` - Carriers `ENDCUSTOMER` - End customer `SHIPPER` - Shipper `CUSTOMS` - Customs `UNKNOWN` - Unknown	–	M705 = CA (CARRIER) or LW (ENDCUSTOMER) or SH (SHIPPER)	SEL020-010 = CA (CARRIER) or CU (CUSTOMS) or SH (SHIPPER) AB (UNKNOWN)
			equipmentTypeTemperatures		Equipment type and its required temperatures.	–	W09	–
				equipmentType	string	Type of equipment used in delivery. Valid values: `CONTAINER` `RAILCAR` `TRAILER` `SHIP` `AIRCRAFT` `TRUCK`	–	W0901 = AP (AIRCRAFT) or CN (CONTAINER) or RR (RAILCAR) or TL (TRAILER) or VT (SHIP) or TO (TRUCK)	EQD010 = AK (AIRCRAFT) or CN (CONTAINER) or RR (RAILCAR) or TE (TRAILER)
				temperatureType	string	Type of temperature follow while shipment. Valid values: `STORAGE` - Storage temperature `TRANSPORT` - Transport temperature `CARGO` - Cargo operation temperature `EMERGENCY` - Transport emergency temperature `TRANSPORTCONTROL` - Transport control temperature `RECORDEDTEMPERATURE` - Recorded temperature	–	–	TMP010 = 1 (STORAGE) Or 2 (TRANSPORT) Or 3 (CARGO) Or 4 (EMERGENCY) Or 5 (TRANSPORTCONTROL) Or 7 (RECORDEDTEMPERATURE)
				temperatureSetpoint	number	Temperature value setting expressed in degrees.	–	–	TMP020-010
				temperatureScale	string	Temperature unit of measure. Valid values: `CELSIUS` - Degree, Celsius `FAHRENHEIT` - Degree, Fahrenheit `KELVIN` - Degree Celsius per kelvin	–	W0903 = CE (CELSIUS) Or FA (FAHRENHEIT) KV(KELVIN)	TMP020-020= CEL (CELSIUS) Or FAH (FAHRENHEIT) Or KEL (KELVIN)
				rangeType	string	Type of range. Valid values: `TEMPERATURE` - Item temperature range `TRANSPORTTEMPERATURE` - Transport temperature range	–	–	RNG010 = 5 (TEMPERATURE) or 12 (TRANSPORTTEMPERATURE)
				minTemperature	number	Equipment minimum allowable temperature.	–	W0902	RNG020-020
				maxTemperature	number	Equipment maximum allowable temperature.	–	W0904	RNG020-030
				unitOfMeasure	string	Temperature unit of measure. valid values includes: `CE` - Degree Celsius `FA` - Fahrenheit	–	–	RNG020-010 = CEL (CE) Or FAH (FA) KEL (KV)
				isVentilationOpen	boolean	Place holder to update ventilation status. Valid values: `True` - Open `False` - Closed	–	–	–
				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	–
				isDrainholesOpen	boolean	Is drain holes open on the container status. Valid values: `True` - Open `False` - Closed	–	–	–
				isBulbMode	boolean	Is special container setting for handling flower bulbs active. Valid values: `True` - Open `False` - Closed	–	–	–
				humidityPercent	integer	Percent in integer format , example: 50% required, in 50.	–	W908	–
				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	–	–	–
			shippingEquipmentRateCharges	array	Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements	–	Segment: N7 - L1 Loop	Segment TCC and MOA (Segment Group: 28 (CNI))
				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.	–	L101	TCC010-010
				freightRate	number (implicit decimal)	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)	–
				freightInvoiceChargeType	string	Code representing type of freight charges. Valid values: `TOTAL` -Total amount `TAX` - Tax amount `DECLARED` - Total declared `CHARGEDUE` - Total charge due `FREIGHTDUE` - Total freight due `PAYMENT` - Total payment amount `SERVICE` - Total service charge `SALESTAX` - Sales tax `UNITPRICE` - Unit Price `TRANSFER` - Transfer Amount `CUSTOMS` - Customs duty paid	–	–	MOA010-010 = 128 (TOTAL) or 162 (CUSTOMS) or 146 (UNITPRICE) or 124 (TAX) or 134 (DECLARED) or 130 (CHARGEDUE) or 135 (FREIGHTDUE) or 139 (PAYMENT) or 140 (SERVICE) or 120 (SALESTAX) or 143 (TRANSFER)
				totalCharges	number	Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency.	–	L104	MOA010-020, as per freightInvoiceChargeType
				currencyCode	string	Currency code for the pricing amount.	–	–	MOA010-030
				currencyUsageType	string	Describes the type of currency based on usage. Valid values are: `CUSTOMS` - Customs valuation currency `INVOICE` - Invoicing currency `ACCOUNT` - Account currency `TARGET` - Destination or target currency `ORDER` - Purchase order currency `PRICING` - Pricing currency `TAX` - Tax currency	–	–	MOA010-040 = 1 (CUSTOMS) or 4 (INVOICE) or 5 (ACCOUNT) or 7 (TARGET) or 9 (ORDER) or 10 (PRICING) or 18 (TAX)
				advancePayment	number	Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.	–	L105	–
				prepaidAmount	number	Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.	–	L106	–
				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	–	L107 = FSAC (RAIL) or IATA (AIR) or R260 (R260) or SPLC (MOTOR)	–
				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. Valid values include: `CONTRACT` - Contract rate `EXCESSWEIGHT` - Weight in Excess of Pivot Weight and Applicable Rate `MINIMUM` - Minimum `QUOTED` - Quoted rate `SENDER` - Sender rate `CONTAINER` - IATA Container or Unit Load Device (ULD) `EXCEPTION` - Exception rating `BASIC` - Basic rate `COMMODITY` - Specific commodity rate `EXPORT` -Export Subsidy Rate `SUBSIDY` - Subsidy Rate `KILOGRAM` - Rate per kilogram	–	–	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	Special Charge Description	–	L112	TCC010-040
				billedQuantityType	string	Code identifying the type of quantity or value on which the rate or item pricing is based. Valid values include: `KILOMETERS` - Kilometers `MILES` - Miles `DRIVERS` - Identifies a billable unit expressed as persons operating equipment `EACH` - Each `POUND` - Pound `KILOGRAM` - Kilograms `HUNDREDPOUND` - 100 pounds `PALLET` - Pallet `STOPS` - Stops `DAYS` - Days `HOURS` - Hours `TONS` - Tons	–	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 BX (BOX) or NU (UNIT) or BL (BOL) or FR (FLAT) or KG (KILOGRAM) or LC (HUNDREDPOUND) or PL (PALLET) or SP (STOPS) or TD (DAYS) or TH (HOURS) or TN (TONS)	–
				billedQuantityValue	number	Quantity of product in delivery - Basis for rating (miles, value, volume, etc.).	–	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	–
				companyIdentifierType	string	Company identifier type for business partner. Valid values include: `GLN` `DUNS` `DUNS4` `COMPANYID` `COMPANYSITEID`	–	–	–
				companyIdentifierValue	string	Company identifier value for business partner.	–	–	–
				rateOrTariffClassDescription	string	Free form description of an applicable rate or tariff class.	–	–	TCC020-040
				codeListIdentifier	string	Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.	–	–	TDT010-020
				agencyCode	string	Specifies the organization or responsible agency code that maintains or governs the referenced code list.	–	–	TDT010-030
				freightInvoiceCurrency	array	Currency codes for freight charge.	–	Segment C3	TCC- CUX
					currencyCode	string	Currency code for specifying monetary unit.	–	C301	CUX010-020
					exchangeRateCurrencyCode	string	Currency code for currency exchange.	–	–	–
					exchangeRate	number	Exchange rate for conversion from currencyCode to currencyCodeExchange.	–	–	–
					validityDate	string	Validity date for exchange rate.	–	–	–
					epochValidityDate	integer	Validity date for exchange rate generated in epoch integer date format.	–	–	–
					currenctyEntityCode	string	Currency entity code.	–	–	–
				pricingInformation	array	Pricing information for product.	–	–	TCC/PRI
					pricingType	string	Pricing type for price sales catalog. Valid values include `UNIT` - Per Unit.	–	–	PRI010-030 = PE(UNIT) PRI010-010 = "CAL" (Cal price)
					pricingAmount	number	Unit price for pricing type.	–	–	PRI010-020
					currencyCode	string	Currency code for the pricing amount.	–	–	–
					pricingTypeQuantity	number	Quantity for pricing type.	–	–	PRI010-050
					unitPriceBasisQuantity	string	Quantity basis of unit price, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12.	–	–	–
					unitOfMeasure	string	Unit of measure used for pricing at the price conditions line item details level.	–	–	PRI010-060
				itemQuantity	array	Quantity details pertain to charges.	–	–	TCC- QTY
					quantityType	string	Type of quantity recorded. Valid values include `CHARGEABLEWEIGHT` - Chargeable weight quantity from the total consignment quantity.	–	–	QTY01
					quantityValue	number	Quantity of product in shipment.	–	–	QTY02
					unitOfMeasure	string	Unit or Basis for Measurement Code. Unit of entry UOM's include: `UN` - Unit `PC` - Piece	–	–	–
			exportLicense	array	Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.	–	Segment X1 under LX - N7 loop	–
				licenseNumber	string	License number assigned by authority.	–	X102	–
				licenseIssuingAgency	string	License number given authority or agency code.	–	X101	–
				licenseTypeCode	string	License control/type, code.	–	X106	–
				licenseCountry	string	Issuing country code.	–	X107	–
				IssueDate	string	License issued date.	–	–	–
				epochIssueDate	integer	License issued date in epoch format.	–	–	–
				expirationDate	string	License expiry date.	–	X104	–
				epochExpirationDate	integer	License expiry date in epoch format.	–	–	–
				exportClassificationCode	string	Export clasification code ECCN code.	–	X116	–
			importLicense	array	Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.	–	Segment X2 under LX - N7 loop	–
				licenseNumber	string	License number assigned by authority.	–	X201	–
				licenseIssuingAgency	string	License number given authority or agency code.	–	–	–
				licenseTypeCode	string	License control/type, code.	–	–	–
				licenseCountry	string	Issuing country code.	–	–	–
				IssueDate	string	License issued date.	–	X202	–
				epochIssueDate	integer	License issued date in epoch format.	–	–	–
				expirationDate	string	License expiry date.	–	X203	–
				epochExpirationDate	integer	License expiry date in epoch format.	–	–	–

data

–

Object type/root element.

–

controlFileHeader

–

Canonical control file header to store data for control segments of IDocs and TL XML transactions, and EDI envelopes for X12 and EDIFACT.

–

canonicalOceanBillOfLadingHeader

–

Payload for Ocean Freight Invoice canonical.

–

Segment B3 and B2A

–

freightInvoiceShipmentType

string

Relationship of the shipment with respect to other shipments provided to the carrier at the same time.

Valid values include:

SEAWAYBILL - Document issued by an ocean carrier covering cargo shipped on a vessel owned by that carrier.
SINGLESHIPMENT - Bill of Lading for Individual Shipment

–

B301 =

2 (SEAWAYBILL) or
B (SINGLESHIPMENT) or

BGM01-010 =

710 (SEAWAYBILL) or
705 (SINGLESHIPMENT) or

shipmentChargePaymentMethodType

string

Method of payment for delivery.

Valid values include:

COLLECT = Collect
BUYER = Paid by buyer
ADVANCECOLLECT - Advance Collect
BUYERSELLERDEFINED - Defined by buyer and seller
ADVANCEPREPAID - Advance prepaid
PREPAIDONLY - Prepaid only
PREPAIDSELLER - prepaid by seller
SELLER - Paid by seller
THIRDPARTYPAY - Third Party Pay

–

B304 =

CC (COLLECT) or
PA (ADVANCEPREPAID) or
PO (PREPAIDONLY) or
PP (PREPAIDSELLER) or
PS (SELLER) or
TP (THIRDPARTYPAY) or
CA (ADVANCECOLLECT) or

–

netAmountDue

Number

Total charges to be paid by the receiver expressed in the standard monetary denomination for specified currency.

–

B307

–

carrierCode

string

Carrier code for shipper.

–

B311

–

codeListResponsibleAgencyType

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

weightUnitType

string

Type of weight recorded.

Valid values include:

KILOGRAMS - Kilograms
POUNDS - Pounds
OUNCES - Ounces
GRAMS - Grams

–

B305 =

K (KILOGRAMS) or
G (GRAMS) or
E (METRICTON)

–

servicesTariffCode

string

Types of services rendered and respective charges(As per contract) billed by the carrier.

Valid values include:

BARGETOBARGE - Rate for shipments for barge-to-barge carrier terminal service
BARGETODOOR - Rate for shipments for barge-to-door service
BARGETOMOTOR - Rate for shipments for barge-to-motorservice
BARGETORAIL - Rate for shipments for barge-to-rail service

–

B313 =

BB (BARGETOBARGE) or
BD (BARGETODOOR) or
BM (BARGETOMOTOR) or
BR (BARGETORAIL)

–

transportServiceType

string

Code specifying extent of transportation movement (operational my be differ from contract).

Valid values include:

FCLTOFCL - Full container load to Full container load, The shipper delivers a full container
FCLTOLCL - A full container from the origin is de-consolidated at the destination
LCLTOLCL - Less than Container Load to Less than Container Load,
LCLTOFCL - Multiple shippers partial loads are consolidated at origin

–

b2bTransactionIdentifierType

string

Referenced document type.

Valid values include BOL - Bill of Lading Number.

–

L1102 = BM (BOL)

–

b2bTransactionIdentifierValue

string

Reference identifier value.

–

L1101 when b2bTransactionIdentifierType =BOL

–

localCurrency

string

Local currency code.

–

processingFunctionTypeCode

string

Ocean Freight Invoice processing function code.

Valid values include:

ORIGINAL
CREATE
CHANGE
CONFIRM
CANCEL

–

B2A =

00 (ORIGINAL) or
01 (CANCEL) or
04 (CHANGE)

BGM030 = 1 (CANCEL) or 2 (CREATE) or 3 (DELETE) or 4 (CHANGE) or 5 (REPLACE) or 6 (CONFIRM) or 9 (ORIGINAL)

documentStatus

string

Transport document lifecycle‐based status for a Bill of Lading document (Draft, Approved, Issued, Surrendered, Voided, etc.

Valid values include:

DRAFT - The Transport Document is currently a Draft
APPROVED - The Transport Document has been Approved by consumer
ISSUED - The Transport Document has been Issued by provider
PENDINGSURRENDERFORAMENDMENT - The Transport Document has a pending Surrender for Amendment
SURRENDEREDFORAMENDMENT - The Transport Document is Surrendered for Amendment
PENDINGSURRENDERFORDELIVERY - The Transport Document has a pending Surrender for Delivery
SURRENDEREDFORDELIVERY - The Transport Document is Surrendered for Delivery
VOIDED - The Transport Document has been Voided

–

documentStatusAgency

string

An agency that maintains given document status code.

–

isElectronicDocument

boolean

Indicator whether the transport document is electronically transferred.

Valid values:

TRUE
FALSE

–

isToOrder

boolean

Indicates whether the B/L is issued to order or not.

Valid values:

TRUE
FALSE

Note: isToOrder must be false if freightInvoiceShipmentType= SEAWAYBILL

–

isBOLShippedOnBoard

boolean

Specifies whether the Transport Document is a received for shipment, or shipped on board.

Valid values:

TRUE - Transport document shipped on board
FALSE - Transport document received

–

isCargoInsuranceProvidedByCarrier

boolean

Indicates whether cargo insurance for the shipment is arranged and provided by the carrier (transport operator), rather than by the shipper, consignee, or a third party.

–

policyIdentifier

string

Insurance policy number.

–

policyIssuingCompany

string

Name of insurance company issuing the policy.

–

documentAuthentication

The first or primary signature that authenticates this exchanged document.

–

authenticationIdentifier

string

Unique identifier assigned to the document authentication or signature event.

–

authenticationDate

string

Date and time at which the document was authenticated or signed. Uses the same structure and rules as issueDateTime.

–

epochAuthenticationDate

integer

Date and time at which the document was authenticated in epoch format.

–

dateTimePeriodFormat

string

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

Valid vlaues include:

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

–

authenticationStatement

string

Textual statement representing the declaration, certification, or wording associated with the document authentication.

–

documentIssuedQuantity

array

The requested number of copies/ Originals of the Transport Document to be issued by the carrier including / not including charges

–

issuedQuantityType

string

Type of quantity required.

Valid values: -

COPYWITHCHARGES - The requested number of copies of the Transport Document to be issued by the carrier including charges.
COPYWITHOUTCHARGES - The requested number of copies of the Transport Document to be issued by the carrier NOT including charges.
ORIGINALWITHCHARGES - The requested number of originals of the Transport Document to be issued by the carrier including charges.
ORIGINALWITHOUTCHARGES - The requested number of originals of the Transport Document to be issued by the carrier NOT including charges

–

quantityValue

string

Quantity of copies or originals issued.

–

transactionReferenceIdentifiers

array

Transaction references for deliveries at header level.

–

Segment B3 and N9

–

b2bTransactionIdentifierType

string

Referenced document type. .Valid values include:

OCEANBILLOFLADING - (required) Internal transaction identifier
SHIPMENT - Assigned to the shipment by the shipper
BOL - Bill of Lading Number
COMBINEDSHIPMENT - Combined shipment identifier
CONTRACT - Contract number
SHIPPINGINSTRUCTION - Shipping instruction identifier .

–

N901 =

BM (BOL) Or
PO (PURCHASEORDER) or
CT (CONTRACT) or
CR (CUSTOMERREFERENCE) or
SI (SHIPMENT)
CB (COMBINEDSHIPMENT)

RFF01-010 =

CT (CONTRACT) Or
BC (CUSTOMERCONTRACT) Or
BM (BOL) or
ON (PURCHASEORDER) Or
VC (SUPPLIERCONTRACT) Or
CR (CUSTOMERREFERENCE) or
SI (SHIPMENT)

Only one occurrence of BOL should be generated, either from BGM or from RFF.

b2bTransactionIdentifierValue

string

Reference identifier value for invoice and shipment identified by transactionReferenceIdentifierType

–

B302 when b2bTransactionIdentifierType = OCEANBILLOFLADING (required) B303 when b2bTransactionIdentifierType = SHIPMENT N902 when b2bTransactionIdentifierType = INVOICE or

BOL or
PURCHASEODER or
MASTERBOL or
CONSIGNEEORDER or
CONTRACT or
CUSTOMERREFERENCE or
PRICEQUOTEIDENTIFIER or
COMBINEDSHIPMENT or
SHIPMENT or
VAT

BGM020-010 when b2bTransactionIdentifierType = OCEANBILLOFLADING (required) or BOL RFF01-020 when b2bTransactionIdentifierType =

SHIPMENT or
BOL or
CONTRACT or
CUSTOMERCONTRACT or
DOCUMENT or
BOL or
MASTERBOL or
DELIVERY or
PURCHASEORDER or
RELEASE or
SUPPLIERCONTRACT or
SUPPLIERORDER or
CUSTOMERREFERENCE or
SHIPPERSSHIPMENTIDENTIFIER

lineItemNumber

string

Line item number in transaction reference. Line item level only.

–

transactionDate

string

Date transaction created.

–

B306 when b2bTransactionIdentifierType = OCEANBILLOFLADING

DTM01-020 with DTM01-010 as 137 and DTM01-030 as 102 (Format: CCYYMMDD) when b2bTransactionIdentifierType = OCEANBILLOFLADING

epochTransactionDate

integer

Date transaction created in epoch integer date format.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments L11 and N9 for information other than transaction documents.

–

N9 segment

–

transactionReferenceType

string

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

Valid values include:

BOOKINGIDENTIFIER: Booking Number
FORWARDERREFERENCE - Forwarder's/Agent's Reference Number
MUTUALLYDEFINED - Mutually Defined
LETTEROFCREDIT - Letter of credit
VEHICLEIDENTIFICATION - Vehicle identification number (VIN)
VEHICLENUMBER - Motor vehicle identification number

–

N901 =

BN (BOOKINGIDENTIFIER) or
FN (FORWARDERREFERENCE) or
ZZ (MUTUALLYDEFINED)

RFF01-010 = LC (LETTEROFCREDIT) Or EX (EXPORTLICENSE) Or AHL (CREDITORSREFERENCE) BN (BOOKINGIDENTIFIER) FF (FORWARDERREFERENCE) VT (VEHICLENUMBER) AKG (VEHICLEIDENTIFICATION)

transactionReferenceIdentifier

string

Transaction reference identifier value.

–

N902 when b2bTransactionIdentifierType =

BOOKINGIDENTIFIER or
FORWARDERREFERENCE or
CUSTOM

RFF01-020 when transactionReferenceType = LETTEROFCREDIT or EXPORTLICENSE or CREDITORSREFERENCE

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 for referenced document

–

RFF Loop/ DTM Loop

dateType

string

Date type at header level for Application Advices in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values include: - Dates relevent to reference information.

–

DTM010-010 = 137 (DOCUMENT)

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 specifiying 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.

–

mpcDates

array

Invoice dates at header level.

–

dateType

string

referenced date type.

Valid values include:

SHIPPED
ESTIMATED
ACTUAL
DELIVERY
DOCUMENT
SAILING
BOL

–

B310 =

139 (ESTIMATED) Or
140 (ACTUAL)
005 (SAILING)

DTM01-010 =

11 (CANCELBY) Or
11 (SHIPPED)
95 (BOL)
342 (LOADING)
137 (DOCUMENT) populate this 137 instance only if it has not populated from transactionDate

dateValue

string

Date defined by referenced date type.

–

B309, B312 (When dateType = SAILING)

DTM01-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.

–

mpcCurrency

array

Currency codes for freight invoice.

–

Segment C3

Segment CUX

currencyCode

string

Currency code for pricing in freight invoice.

–

C301

CUX010-020 when CUX010-010 =

1 or

2 or

5 and CUX010-030 = 4

exchangeRateCurrencyCode

string

Currency code for currency exchange.

–

exchangeRate

number

Exchange rate for conversion from currencyCode to currencyCodeExchange

–

CUX030

validityDate

string

Validity date for exchange rate.

–

epochValidityDate

integer

Validity date for exchange rate generated in epoch integer date format.

–

currencyEntityCode

string

Currency entity code.

–

contactInformation

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 whome 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
FC (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"

customsReferenceInformation

array

Additional identifiers for specific needs, for example required by national agency such as customs.

–

customsReferenceType

string

Customs and/or excise purposes required by the relevant authorities for the import, export, or transit of the goods.

For Example listed below. Pass through

Type - Country - Description

UCR -NL - Unique Consignment Reference
CUS -NL - Customs Union and Statistics
ACID - EG - Advance Cargo Information Declaration in Egypt

–

customsReferenceValue

string

The value of the customsReference type.

–

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

codeListResponsibleAgencyType

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

countryCode

string

The 2 characters for the country code using ISO 3166-1 alpha-2.

–

transportServiceRequirements

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.

–

servicesTariffCode

string

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

–

TSR010-010

serviceRequirementCode

string

Code to identify a service (which may constitute an additional component to a basic contract).

Valid values:

2 - Full Load
3 - Less than full loads

–

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

vesselDetails

array

Vessel identifier information along with transportation details such as dates, quantity, weight and volume.

–

Segment V1

–

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

–

locations

array

Port or terminal details related to cargo movement.

–

R4 Loop

Segment group: 01 : LOC (Part of Header)

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

–

oceanShipmentLocationIdentifier

string

Identifies the cargo's specific location.

–

R403

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 location or port or place.

–

R404

LOC020-040

countryCode

string

Country code.

–

R405

LOC030-010 (LOC030-020 = 162 (Country))

terminalName

string

Terminal Name.

–

R406

–

state

string

State code.

–

R408

LOC040-010 (LOC040-020 = 169 (Country- sub entity))

mpcDates

array

Dates relevant to location events, provision given to map to EDIFACT data.

–

DTM

LOC-DTM

dateType

string

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

Valid values include:

ESTIMATED - Estimated
ACTUAL = Actual
ESTIMATEDDEPARTURE - Estimated Departure Date
ACTUALDEPARTURE - Actual Departure date
ESTIMATEDARRIVAL - Estimated Arrival date
ACTUALARRIVAL - Actual arrival date
CUSTOMSCLEARANCE - Customs Clearance date
VESSELLOADED - Loaded on vessel date
CUSTOMSENTRY - Customs entry date
PACKED - Date packed

–

DTM01 =

139 (ESTIMATED) Or
140 (ACTUAL) Or
369 (ESTIMATEDDEPARTURE) Or
370 (ACTUALDEPARTURE) Or
371 (ESTIMATEDARRIVAL) Or
372 (ACTUALARRIVAL) Or
058 (CUSTOMSCLEARANCE) Or
161 (VESSELLOADED) Or
813 (CUSTOMSENTRY) Or
510 (PACKED)

DTM010-010

dateValue

string

Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.

–

DTM02 & DTM03

DTM010-020

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.

–

DTM04

–

containerDetails

array

Describes container information and transportation services used for ocean freight.

–

Segment Y2

–

numberOfContainers

number

Number of shipping containers.

–

Y201

–

freightContainerType

string

Type of container for requested equipment on vessel.

Valid values are:

CONTAINERS - Containers only
CONTAINERSWITHCHASIS - Containers with chasis
SHIPPERPROVIDED - Shippers to provided
CHASIS - Chasis only

–

Y202 =

R (CONTAINERS) or
C (CONTAINERSWITHCHASIS) or
S (SHIPPERPROVIDED) or
W (CHASIS)

–

transportServiceType

string

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

Valid values are:

AIRPORTTOAIRPORT - Rate for requested transport services from airport to airport
BULKBREAK - Rate for requested transport services for bulk break
DOORTODOOR - Rate for requested transport services from door to door
DOORTOAIRPORT - Rate for requested transport services from door to airport

–

Y203 =

AA (AIRPORTTOAIRPORT) or
BB (BULKBREAK) or
DD (DOORTODOOR) or
DA (DOORTOAIRPORT)

–

equipmentTypeISOCode

string

Equipment type ISO code.

–

Y204

–

equipmentIdentifier

string

Sequencing or serial part of an equipment unit's identifying number.

–

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

–

carrierCode

string

Shipping carrier alpha code (SCAC).

–

Y207

–

carrierSequenceInformation

array

Carrier sequence information for shipment. Records cit and state or province location for each carrier used for shipment.

–

Segment R2

–

carrierCode

string

Shipping carrier alpha code (SCAC).

–

R201

–

carrierSequenceCode

string

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

Valid values include:

ORIGINAL - Original carrier
FIRST - First carrier after original
SECOND - Second carrier after original
THIRD - Third carrier after original
FOURTH - Fourth carrier after original
FIFTH - Fifth carrier after original

–

R202 =

0 (ORIGINAL) or
1 (FIRST) or
2 (SECOND) or
3 (THIRD) or
4 (FOURTH) or
5 (FIFTH)

–

transportMethod

string

Transport method type.

Valid values include:

TRUCK - Truck
RAIL - Shipped by train
SEA - By sea
AIR - By air
LTL - Less than truckload
AIREXPRESS - Air express
CONTAINERSEA -Container by ship

–

R206

–

city

string

City name for the shipment's current carrier sequence.

–

R203

–

state

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

AIRPORTTOAIRPORT - Rate for requested transport services from airport to airport
BULKBREAK - Rate for requested transport services for bulk break
DOORTODOOR - Rate for requested transport services from door to door
DOORTOAIRPORT - Rate for requested transport services from door to airport

–

R212 =

AA (AIRPORTTOAIRPORT) or
BB (BULKBREAK) or
DD (DOORTODOOR) or
DA (DOORTOAIRPORT)

–

description

string

Route descriptive information.

–

R213

–

specialHandlingInformation

array

Special handling instructions for shipment. All parameters to be understood in the form of different codes used by industry,

–

Segment H3

–

handlingCode

string

Code specifying special transportation handling instructions.

Valid Values are:

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)

–

consignmentTemperatureRange

array

Temperature range setting details required to be maintained during throughout transport for goods items.

–

rangeType

string

Type of range.

Valid values:

TEMPERATURE - Item temperature range
TRANSPORTTEMPERATURE - Transport temperature range

–

minimumValue

number

Shipment minimum allowable Temperature.

–

maximumValue

number

Shipment maximum allowable temperature.

–

unitOfMeasure

string

Temperature unit of measure.

Valid values:

CE - Celsius
FA - Fahrenheit

–

description

string

Descriptive information about environment required for goods item.

–

marksAndNumbers

array

Lading item in terms of description, quantity, packaging, and marks and numbers.

–

Segment: L5 at header

–

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)

–

ladingPackageType

string

Describes the type of packaging; Part 1: Packaging Form, Part 2: Packaging Material; if the Data Element is used, then Part 1 is always required.

Valid values are :

STANDARD
CASE
CARTON
PALLET
RACK
UNIT
TRUCK

–

L505 =

90 (STANDARD) or
CAS (CASE) or
CTN (CARTON) or
PLT (PALLET) or
RCK (RACK) or
UNT (UNIT) or
TRU (TRUCK)

–

termsOfPayment

array

Terms of payment looping group.

–

termsOfPaymentKey

string

Terms of payment.

–

termsOfPaymentTypeCode

string

Code identifying type of payment terms.

Valid values:

BASIC
DEFERRED
DISCOUNTNOTAPPLICABLE
ENDOFMONTH
EXTENDED
FIXEDDATE
MIXED
PREVIOUSLYAGREED
PROXIMO
SELLER

–

termsOfPaymentDateBasis

string

Code identifying the beginning of the terms period.

Valid values:

DELIVERYDATE - Delivery date
EFFECTIVEDATE - Effective date
INVOICEDATE - Invoice date
INVOICERECEIPTDATE - Invoice receipt date
PURCHASEORDERDATE - Purchase order date.
SHIPDATE - Shipping date

–

numberOfDays

string

Terms of payment: number of days.

–

discountDueNumberOfDays

number

Terms Discount Days Due. Number of days in the terms discount period by which payment is due if terms discount is earned.

–

termsOfPaymentPercent

string

Terms of payment: percentage.

–

invoicePayablePercent

string

Percentage of invoice payable.

–

discountDueDate

string

Discount due date in string date format YYYY-MM-DD.

–

epochDiscountDueDate

integer

Discount due date in epoch integer date format.

–

paymentDueDate

string

Due date for payment.

–

paymentDeferredToDate

string

Date deferred payment or percent of invoice payable is due.

–

epochPaymentDueDate

integer

Due date for payment generated in epoch integer date format.

–

epochPaymentDeferredToDate

integer

Date deferred payment or percent of invoice payable is due generated in epoch integer date format.

–

paymentDeferredDueAmount

string

Deferred amount due for payment.

–

description

string

Terms of payment description.

–

totalTermDiscountAmount

integer

Terms of payment discount amount. Total amount of terms discount.

–

dayOfMonth

integer

The numeric value of the day of the month between 1 and the maximum day of the month being referenced.

–

creditsAndCharges

array

Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others.

–

CPI

creditChargeKeyType

string

Key identifies credit or charges as discounts or additional charges.

Valid values include:

ALLOWANCE
CHARGE
PROMOTION

–

creditChargeType

string

Code representing type of credit or charge:

Valid values include FREIGHT - Basic Freight.

–

CPI010-010

creditChargeAmount

string

Total amount for the payment.

–

qualifyingAmount

string

Amount qualifying for cash discount, allowance, promotion, service or charge.

–

creditChargePercentRate

string

Percentage rate for cash discount, allowance, promotion, service or charge.

–

percentRateBasisTypeCode

string

Code indicating basis that allowance or charge percent is calculated.

–

creditChargeCurrencyCode

string

Currency code for credit or charge.

–

creditChargeHandlingCode

Method of handling for discount or charge.

Valid values include:

COLLECT - Collect
PREPAID - Prepaid

–

CPI020-010 =

CC (COLLECT) Or
PP (PREPAID)

chargePaymentMethod

string

Payment method for freight invoice charges.

Valid values include:

COLLECT
PREPAID
THIRDPARTYPAY

–

CPI030 =

C (COLLECT) Or
P (PREPAID) Or
B (THIRDPARTYPAY)

description

string

Description of credit or charge.

–

unitPriceAmount

string

Unit price amount.

–

unitPriceBasisQuantity

string

Quantity basis for the unit price.

–

itemQuantity

string

Item quantity.

–

unitOfMeasure

string

Base unit of measure or UOM for quantity of item in pack.

Quantity UOMs include:

CA - Case
CP - Crate

–

baseValue

string

–

creditChargeConditionType

string

Credit charge condition type.

–

deliveryTerms

array

Terms of delivery, transport or inco terms looping group.

–

Segment Group: 14 (TOD) at header

description

string

Description for inco term.

–

TOD040, TOD050

deliveryTermsConditionCode

string

Delivery Terms condition code.

–

TOD010

shipmentChargePaymentMethodType

string

Method of payment for delivery.

Valid values inlcude:

ADVANCECOLLECT
ADVANCEPREPAID
BUYER
BUYERSELLERDEFINED
COLLECT
COLLECTDELIVERY

–

TOD020 =

CC (COLLECT) or
CA (ADVANCECOLLECT) or
PO (PREPAIDONLY)or
WE (BUYER) or
DF (BUYERSELLERDEFINED) or
PA (ADVANCEPREPAID) or
PP (PREPAIDSELLER) or
TP (THIRDPARTYPAY)

fobTransferLocation

string

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

Valid values:

CITY
PLANT
SHIPPINGDESTINATION
SHIPPINGORIGIN

–

deliveryTermsCode

string

Delivery terms condition code.

Valid values include:

INCO1 - INCOTERMS part 1
INCO2 - INCOTERMS part 2

–

freightRatesCharges

array

Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements this is to send , how the rates are calculated, Rate basis, Rate class, quantity basis along with total charges.

–

Segment Group: 06 (TCC ( segment:TCC & MOA) at header)

lineItemNumber

string

Sequential line number for freight invoice item.

–

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 (implicit decimal)

Rate that applies to the specific commodity.

–

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 )

–

freightInvoiceChargeType

string

Code representing type of freight charges.

Valid values FREIGHTDUE - Freight charge.

–

MOA010-010 = 64 (FREIGHTDUE)

totalCharges

number

Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency.

–

MOA010-020

currencyCode

string

Currency code for the pricing amount.

–

MOA010-030

currencyUsageType

string

Describes the type of currency based on usage.

Valid values are:

CUSTOMS - Customs valuation currency
INVOICE - Invoicing currency
ACCOUNT - Account currency
TARGET - Destination or target currency
ORDER - Purchase order currency
PRICING - Pricing currency
TAX - Tax currency

–

MOA010-040 =

1 (CUSTOMS) or
4 (INVOICE) or
5 (ACCOUNT) or
7 (TARGET) or
9 (ORDER) or
10 (PRICING) or
18 (TAX)

advancePayment

number

Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.

–

prepaidAmount

number

Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.

–

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

–

rateClassCode

string

Identifies specific & designated class of goods; Note: For international air shipments.

Valid values include:

CONTRACT - Contract rate
EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate
MINIMUM - Minimum
QUOTED - Quoted rate
SENDER - Sender rate
CONTAINER - IATA Container or Unit Load Device (ULD)
EXCEPTION - Exception rating
BASIC - Basic rate
COMMODITY - Specific commodity rate
EXPORT -Export Subsidy Rate
SUBSIDY - Subsidy Rate
KILOGRAM - Rate per kilogram

–

chargeEntitlementParty

string

To describe the types of party involved.

Valid values:

SHIPPER
CONSIGNEE
ISSUINGCARRIER
DESTINATIONCARRIER

–

chargePaymentMethod

string

Payment method for freight invoice charges.

Valid values:

PREPAIDCASH
PREPAIDCREDIT
COLLECT
COLLECTCASH
COLLECTCREDIT
PREPAID
THIRDPARTYPAY

–

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.

–

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
KILOGRAM - Kilograms
HUNDREDPOUND - 100 pounds
PALLET - Pallet
STOPS - Stops
DAYS - Days
HOURS - Hours
TONS - Tons

–

billedQuantityValue

number

Quantity of product in delivery.

–

freightRatePercent

number

Percentage expressed as a decimal (e.g., 0.0 through 1.0 represents 0% through 100%).

–

currencyCode

string

Billed Currency Code.

–

companyIdentifierType

string

Company identifier type for business partner.

Valid values include:

GLN
DUNS
DUNS4
COMPANYID
COMPANYSITEID

–

companyIdentifierValue

string

Company identifier value for business partner

–

rateOrTariffClassDescription

string

Free form description of an applicable rate or tariff class.

–

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

TDT010-020

agencyCode

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

TDT010-030

pricingInformation

array

Pricing information for product.

–

TCC/PRI loop

pricingType

string

Pricing type for price sales catalog.

Valid values include UNIT - Per Unit

–

PRI010-030 = PE(UNIT)

PRI010-010 = "CAL" (Cal price)

pricingAmount

number

Unit price for pricing type.

–

PRI010-020

currencyCode

string

Currency code for the pricing amount.

–

pricingTypeQuantity

number

Quantity for pricing type.

–

PRI010-050

unitPriceBasisQuantity

string

Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12.

–

unitOfMeasure

string

Unit of measure used for pricing at the price conditions line item details level.

–

PRI010-060

priceChangeCode

string

Code indicating of action to be taken when sub line item price changes, EDIFACT

Pass through, possible values:

A - Added to the baseline item unit price
I - Included in the baseline item unit price
S - Subtracted from the baseline item unit price

–

PRI020

itemQuantity

array

Quantity details pertain to charges

–

TCC- QTY Loop

quantityType

string

Type of quantity recorded.

Valid values include

CHARGEABLEWEIGHT - Chargeable weight quantity from the total consignment quantity.

–

QTY01

quantityValue

number

Quantity of product in shipment

–

QTY02

unitOfMeasure

string

Unit or Basis for Measurement Code.

Unit of entry UOM's include:

UN - Unit
PC - Piece

–

transportStageLocationDetails

array

Transport details such as mode of transport, means of transport, its conveyance reference number and the identification of the means of transport. Stage by stage transport details.

–

Segment Group: 8 (TDT)

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

–

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

carrierCodeIdentifier

–

Agency codes and its referenced code list to interpret the carrier code correctly.

–

agencyCode

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

TDT050-020

codeListIdentifier

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.

–

agencyCode

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

TDT080-020

codeListIdentifier

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

–

mpcDates

array

Dates relevant to location events, provision given to map to EDIFACT data.

–

TDT-DTM

dateType

string

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

Valid values include LOADING - On board date.

–

DTM010-010

dateValue

string

Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.

–

DTM010-020

epochDateValue

integer

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

–

dateTimePeriodFormat

string

Code specifiying 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

–

cargoMovementPortDetails

array

Stage/ Sequence wise carrier assigned movement details.

–

TDT-LOC Loop - group5

portOrTerminalDetails

–

LOC

portOrTerminalFunctionCode

string

Port or Terminal function codes.,

Valid values include:

ORIGIN - Origin
PORTOFLOADING - Port of Loading
PORTOFDISCHARGE - Port of Discharge
TRANSSHIPMENT - Transshipment Port
CONSOLIDATIONPOINT - Reconsolidation Point
DECONSOLIDATIONPOINT - De-Consolidation Point
FINALDESTINATION - Final Destination

–

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

–

locationCodeListIdentifier

–

Agency codes and its referenced code list to interpret the carrier code correctly.

–

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

LOC020-020

agencyCode

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

LOC020-030

oceanShipmentLocationIdentifier

string

Identifies the cargo's specific location.

–

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

–

mpcDates

array

Dates relevant to location events, provision given to map to EDIFACT data

–

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

–

DTM010-010

dateValue

string

Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.

–

DTM010-020

epochDateValue

integer

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

–

dateTimePeriodFormat

string

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

Valid values include:

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

–

DTM010-030

timeZone

–

partnerBusinessInformation

array

Party company identifiers and address information.

–

N1 Loop

NAD Loop

businessPartyInformation

Business Parties identifiers and address information.

–

N1

–

partnerEntityType

string

Denotes type of the entity involved in this business transaction.

Valid values include:

SENDER - Message sender
RECEIVER - Message receiver

–

N101

NAD01

businessName

string

Business name for partner or location.

–

N102

NAD040-010

additionalBusinessName

string

Additional Business name for partner or location.

–

N201

–

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 EDIFACT supported codes:

DUNS = 16
DEA = 164
HIN = 21
COMPANYID = 91
COMPANYSITEID = 92

companyIdentifierValue

string

Company identifier value for business partner.

–

N104

NAD020-010

alternateCompanyLocationIdentifierValue

string

Alternate company location identifier value.

–

address

–

Party address information.

–

N3, N4,

–

address1

string

Main street address.

–

N301

NAD050-010

address2

string

Supplemental street address.

–

N302

NAD050-020

city

string

City

–

N401

NAD060

district

string

District

–

state

string

State or region code

–

N402

NAD070-010

postalCode

string

Postal code

–

N403

NAD080

country

string

Country code

–

N404

NAD090

telephone

string

Telephone number

–

fax

string

Fax number

–

url

string

Website URL

–

buildingNumber

string

Building number

–

plantNumber

string

Plant number

–

floorNumber

string

Floor number in building.

–

lscAddressIdentifier

string

LSC address identifier.

–

village

string

Village name

–

houseNumber

string

House number

–

township

string

Township

–

premisesCode

string

Premises code

–

companyLocationContactInformation

–

N1-PER

CTA

contactType

string

Contact type.

Valid values include:

INFORMATION - Information contact
PRIMARY - Primary contact
RESPONSIBLE - Responsible person

–

PER01 = IC (INFORMATION)

CTA010 = IC (INFORMATION)

contactName

string

Contact name.

–

PER02

CTA020-020

contactTitle

string

Title of contact.

–

contactPhone

string

Contact phone number.

–

PER04 where PER03 = "TE"

COM010-010 where COM010-020 = "TE"

contactEmail

string

Contact email address.

–

PER06 where PER05 = "EM"

COM010-010 where COM010-020 = "EM"

mpcAdditionalAddressInformation

–

Additional address information that is not included in addressTypeDefinition.

–

externalERPUserName

string

External ERP system user name for user who generated message.

–

organizationCode

string

Code for organization responsible for generating the message.

–

organizationDescription

string

Description of the organization responsible for generating the message.

–

groupCode

string

Code identifying group responsible for generating the message.

–

language

string

Language key for message.

–

languageCode

string

ISO language code for message.

–

referenceIdentifier

string

Partner reference identifier.

–

orderType

string

Order Type.

–

address3

string

Additional address information that is not included in addressTypeDefinition.

–

N202

–

address4

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

–

transactionReferenceIdentifierList

array

Transaction references for deliveries at header level.

–

Segment RFF

b2bTransactionIdentifierType

string

Referenced document type.

Valid values include FREIGHTCONTRACT - Transport Contract Number.

–

RFF01-010 = AAS (FREIGHTCONTRACT)

b2bTransactionIdentifierValue

string

Reference identifier value for invoice and shipment.

–

RFF01-020 when b2bTransactionIdentifierType = FREIGHTCONTRACT

lineItemNumber

string

Line item number in transaction reference. Line item level only.

–

transactionDate

string

Date transaction created.

–

epochTransactionDate

integer

Date transaction created in epoch integer date 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.

–

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

FREIGHTCONTRACTREFERENCE - Freight Contract reference number
VAT - VAT registration Number

–

RFF01-010 =

AHI (FREIGHTCONTRACTREFERENCE) Or
VA (VAT)

transactionReferenceIdentifier

string

Transaction reference identifier value.

–

RFF01-020 when transactionReferenceType = FREIGHTCONTRACTREFERENCE or VAT

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.

–

exportLicense

array

Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.

–

isRequired

boolean

Information provided by the shipper to indicate whether an Export License or permit is required for this shipment/commodity/destination

Valid values:

True - Required
False - Not required

–

licenseNumber

string

License number assigned by authority.

–

licenseIssuingAgency

string

License number given authority or agency code.

–

licenseTypeCode

string

License control/type, code.

–

licenseCountry

string

Issuing country code.

–

IssueDate

string

License issued date.

–

epochIssueDate

integer

License issued date in epoch format.

–

expirationDate

string

License expiry date.

–

epochExpirationDate

integer

License expiry date in epoch format.

–

exportClassificationCode

string

Export classification code ECCN code.

–

importLicense

array

Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.

–

isRequired

boolean

Information provided by the shipper to indicate whether an Export License or permit is required for this shipment/commodity/destination

Valid values:

True - Required
False - Not required

–

licenseNumber

string

License number assigned by authority.

–

licenseIssuingAgency

string

License number given authority or agency code.

–

licenseTypeCode

string

License control/type, code.

–

licenseCountry

string

Issuing country code.

–

IssueDate

string

License issued date.

–

epochIssueDate

integer

License issued date in epoch format.

–

expirationDate

string

License expiry date.

–

epochExpirationDate

integer

License expiry date in epoch format.

–

exportClassificationCode

string

Export classification code ECCN code.

–

certificationClause

array

Defines standardized certifications or contractual clauses associated with a shipment, capturing both the coded clause and its descriptive text for inclusion in transport documents like the Bill of Lading.

–

Segment C8 Loop under ST

–

lineItemNumber

string

transaction set line number

–

certificationOrClauseCode

string

Coded certification/condition applied

Valid values include:

SHORTSHIPPED - Cargo Short‑Shipped
EMERGENCYSTATEMENT - Instructions for accident handling (spill, fire, DG).
IMOCERTIFICATION - Confirms cargo meets maritime safety rules.
CERTIFICATIONSTATEMENT - General compliance confirmation.
NOEXPORTDECLARATION - No Shipper’s Export Declaration Required
CUSTOM - Custom / Mutually Defined Clause

–

C802 =

08 (SHORTSHIPPED) Or
29 (EMERGENCYSTATEMENT) Or
30 (IMOCERTIFICATION) Or
38 (CERTIFICATIONSTATEMENT) Or
20 (NOEXPORTDECLARATION) Or
CC (CUSTOM)

–

description

string

Free‑form clause or descriptive text supporting the code.

–

C803

–

certificationClauseDescription

array

Stores additional free‑form continuation texts associated with a certification or contractual clause.

–

Segment C8C under ST- C8 loop

–

description

string

Clause free form text description

–

C8C01 / C802 / C803

–

freeTextNote

array

Free text, instructions, notes, descriptions and other free text elements

–

Segment K1

Segment FTX

textReferenceCode

string

Text reference or subject code.

Example values for EDIFACT:

AAA - Goods item description
AAB - Payment term
AAD - Dangerous goods technical name
AAK - Price conditions
AAR - Delivery terms
AAS - Bill of lading remarks
DAR - Damage remarks
COI - Order Information
CUR - Customer remarks
DIN - Delivery instruction
INV - Invoice instruction
BLC - Bill of lading clause

–

FTX010

textFunctionCode

string

Text function code.

–

FTX020

language

string

Language key for message.

–

languageCode

string

ISO language code for message.

–

textFormatCode

string

Format code for free text.

–

freeText

string

Free text array.

–

K101, K102 Each is 30 characters. Mapping to canonical, concatenate K1 and K2. Mapping from canonical split into 2 fields.

FTX040-010,
FTX040-20,
FTX040-030,
FTX040-040

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.

–

canonicalOceanBillOfLadingLineItemDetails

array

Ocean Bill of lading line items details.

–

LX Loop starts

–

lineItemNumber

string

transaction set line number.

–

LX01 (Mandatory)

Incremental number

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.

–

EQD020-020

agencyCode

string

Specifies the organization or agency code that maintains or governs the referenced code list.

–

EQD020-030

carrierCode

string

Carrier code for shipper.

–

N712

–

equipmentType

string

Type of equipment used in delivery.

Valid values:

CONTAINER
RAILCAR
TRAILER
SHIP
AIRCRAFT
TRUCK

–

N711 =

AP (AIRCRAFT) or
CN (CONTAINER) or
RR (RAILCAR) or
TL (TRAILER) or
VT (SHIP) or
TO (TRUCK)

EQD010 =

AK (AIRCRAFT) or
CN (CONTAINER) or
RR (RAILCAR) or
TE (TRAILER)

equipmentTypeISOCode

string

Equipment type ISO code

–

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 :

SHIPPER - Shipper supplied
CARRIER - Carrier supplied
CONSOLIDATOR - Consolidator supplied
DECONSOLIDATOR - De-consolidator supplied
THIRDPARTY - Third party supplied
FORWARDER - Forwarder supplied from a leasing company
FORWARDERRAILWAYS - Forwarder supplied from railways pool

–

EQD040 =

1 (SHIPPER) Or
2 (CARRIER) Or
3 (CONSOLIDATOR) Or
4 (DECONSOLIDATOR) Or
5 (THIRDPARTY) Or
6 (FORWARDER) Or
7 (FORWARDERRAILWAYS)

isNONReefer

boolean

Place holder to note a Reefer Container should be treated as a DRY container and non operational.

Valid values:

True - Dry container
False - (Default) Reefer container

–

equipmentLoadIndicator

string

Indicate the extent of equipment utilize for this consignment.

Valid values:

EMPTY - Equipment is empty
FULL - Equipment is full
MORETHANONEQUARTER - More than one quarter volume available
MORETHANHALF - More than half volume available
MORETHANTHREEQUARTER - More than three quarters volume available
NOVOLUME - No volume available
FULLMIXED - Full, mixed consignment
FULLSINGLE - Full, single consignment

–

EQD060 =

4 (EMPTY) Or
5 (FULL) Or
1 (MORETHANONEQUARTER) Or
2 (MORETHANHALF) Or
3 (MORETHANTHREEQUARTER) Or
6 (NOVOLUME) Or
7 (FULLMIXED) Or
8 (FULLSINGLE)

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

–

transportServiceType

string

Types of transport service requested which may differ from contract conditions.

Valid values are:

AIRPORTTOAIRPORT - Rate for requested transport services from airport to airport
BULKBREAK - Rate for requested transport services for bulk break
DOORTODOOR - Rate for requested transport services from door to door
DOORTOAIRPORT - Rate for requested transport services from door to airport
FCLTOFCL - Container fully loaded
LCLTOLCL - Container partially loaded, The shipper delivers partial cargo
FCLTOLCL - A full container from the origin is deconsolidated at the destination
LCLTOFCL - Multiple shippers partial loads are consolidated at origin, then the container is delivered intact to a single consignee at destination.

–

N719 =

AA (AIRPORTTOAIRPORT) or
BB (BULKBREAK) or
DD (DOORTODOOR) or
DA (DOORTOAIRPORT)

TMD010-010

serviceTypeDescription

string

Free form description of movement or extended service carrying

–

TMD010-020

serviceProvidedParty

string

Equipment haulage arrangements done by.

Valid values includes:

CARRIER - Carrier
MERCHANT - Haulage arranged by merchant (shipper, consignee, or their agent).

–

TMD030 =

1 (CARRIER) Or
2 (MERCHANT)

equipmentDimensions

array

Dimensions of equipment / transportable unit

–

Segment N7

EQD-DIM

dimensionType

string

Type of dimensions recorded for cargo / transportable unit.

Valid values include:

LENGTH
WIDTH
HEIGHT
OFFSTANDARDLEFT - The dimension in the width that the cargo exceeds the standard width at the left side of an equipment
OFFSTANDARDRIGHT - The dimension in the width that the cargo exceeds the standard width at the right side of an equipment
OFFSTANDARDBACK- The dimension in the length that the cargo exceeds the standard length at the back of an equipment
OFFSTANDARDFRONT - The dimension in the length that the cargo exceeds the standard length at the front of an equipment.

–

dimensionValue

Number

Volume for item in inches or centimeters.

–

N715where dimensionsType = LENGTH N720 where dimensionsType = HEIGHT N721 where dimensionsType = WIDHT

DIM020-020, when dimensionsType = LENGTH

DIM020-030, when dimensionsType = WIDTH

DIM020-040, when dimensionsType = HEIGHT

unitOfMeasure

string

Dimension unit of measure for parent packaging.

–

DIM020-010

itemQuantity

array

Equipment quantity.

–

N7-QTY

EQD - EQN

quantityType

string

Type of quantity recorded.

Valid values: Valid values include SHIPPED - Shipped quantity.

–

QTY01 = 39 (SHIPPED)

–

quantityValue

number

Quantity of product in shipment.

–

QTY02

EQN010-010, when EQN010-020 = 2

unitOfMeasure

string

Unit or Basis for Measurement Code.

Unit of entry UOM's include:

UN - Unit
PC - Piece

–

QTY03-01 = PC (PC)

–

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.

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.
NETWEIGHT - Net weight
NETVOLUME - Net volume
RADIOACTIVITY - Radio activity
MUTUALLYDEFINED - Custom measurement type

–

MEA020-010 =

SQ (SHIPPEDQUANTITY) Or
AAW (GROSSVOLUME) Or
AET (EQUIPMENTGROSSWEIGH) Or
G (GROSSWEIGHT) Or
AAF (NETWEIGHT) Or
AAX (NETVOLUME) Or
AEO (RADIOACTIVITY) Or
ZZZ (MUTUALLYDEFINED)

equipmentSealNumbers

array

Shipment carrying equipments seal numbers.

segment loop LX-N7-M701

–

sealNumber

string

Applied seal number for shipment carrying equipment.

–

M701

SEL010

sealAppliedEntityType

string

Seal applied entity type code, it could be an organization or location or an individual.

Valid values are:

CARRIER - Carriers
ENDCUSTOMER - End customer
SHIPPER - Shipper
CUSTOMS - Customs
UNKNOWN - Unknown

–

M705 =

CA (CARRIER) or
LW (ENDCUSTOMER) or
SH (SHIPPER)

SEL020-010 =

CA (CARRIER) or
CU (CUSTOMS) or
SH (SHIPPER)
AB (UNKNOWN)

equipmentTypeTemperatures

Equipment type and its required temperatures.

–

W09

–

equipmentType

string

Type of equipment used in delivery.

Valid values:

CONTAINER
RAILCAR
TRAILER
SHIP
AIRCRAFT
TRUCK

–

W0901 =

AP (AIRCRAFT) or
CN (CONTAINER) or
RR (RAILCAR) or
TL (TRAILER) or
VT (SHIP) or
TO (TRUCK)

EQD010 =

AK (AIRCRAFT) or
CN (CONTAINER) or
RR (RAILCAR) or
TE (TRAILER)

temperatureType

string

Type of temperature follow while shipment.

Valid values:

STORAGE - Storage temperature
TRANSPORT - Transport temperature
CARGO - Cargo operation temperature
EMERGENCY - Transport emergency temperature
TRANSPORTCONTROL - Transport control temperature
RECORDEDTEMPERATURE - Recorded temperature

–

TMP010 =

1 (STORAGE) Or
2 (TRANSPORT) Or
3 (CARGO) Or
4 (EMERGENCY) Or
5 (TRANSPORTCONTROL) Or
7 (RECORDEDTEMPERATURE)

temperatureSetpoint

number

Temperature value setting expressed in degrees.

–

TMP020-010

temperatureScale

string

Temperature unit of measure.

Valid values:

CELSIUS - Degree, Celsius
FAHRENHEIT - Degree, Fahrenheit
KELVIN - Degree Celsius per kelvin

–

W0903 =

CE (CELSIUS) Or
FA (FAHRENHEIT)
KV(KELVIN)

TMP020-020=

CEL (CELSIUS) Or
FAH (FAHRENHEIT) Or
KEL (KELVIN)

rangeType

string

Type of range.

Valid values:

TEMPERATURE - Item temperature range
TRANSPORTTEMPERATURE - Transport temperature range

–

RNG010 =

5 (TEMPERATURE) or
12 (TRANSPORTTEMPERATURE)

minTemperature

number

Equipment minimum allowable temperature.

–

W0902

RNG020-020

maxTemperature

number

Equipment maximum allowable temperature.

–

W0904

RNG020-030

unitOfMeasure

string

Temperature unit of measure.

valid values includes:

CE - Degree Celsius
FA - Fahrenheit

–

RNG020-010 =

CEL (CE) Or
FAH (FA)
KEL (KV)

isVentilationOpen

boolean

Place holder to update ventilation status.

Valid values:

True - Open
False - Closed

–

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

–

isDrainholesOpen

boolean

Is drain holes open on the container status.

Valid values:

True - Open
False - Closed

–

isBulbMode

boolean

Is special container setting for handling flower bulbs active.

Valid values:

True - Open
False - Closed

–

humidityPercent

integer

Percent in integer format , example: 50% required, in 50.

–

W908

–

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

–

shippingEquipmentRateCharges

array

Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements

–

Segment: N7 - L1 Loop

Segment TCC and MOA (Segment Group: 28 (CNI))

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.

–

L101

TCC010-010

freightRate

number (implicit decimal)

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)

–

freightInvoiceChargeType

string

Code representing type of freight charges.

Valid values:

TOTAL -Total amount
TAX - Tax amount
DECLARED - Total declared
CHARGEDUE - Total charge due
FREIGHTDUE - Total freight due
PAYMENT - Total payment amount
SERVICE - Total service charge
SALESTAX - Sales tax
UNITPRICE - Unit Price
TRANSFER - Transfer Amount
CUSTOMS - Customs duty paid

–

MOA010-010 =

128 (TOTAL) or
162 (CUSTOMS) or
146 (UNITPRICE) or
124 (TAX) or
134 (DECLARED) or
130 (CHARGEDUE) or
135 (FREIGHTDUE) or
139 (PAYMENT) or
140 (SERVICE) or
120 (SALESTAX) or
143 (TRANSFER)

totalCharges

number

Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency.

–

L104

MOA010-020, as per freightInvoiceChargeType

currencyCode

string

Currency code for the pricing amount.

–

MOA010-030

currencyUsageType

string

Describes the type of currency based on usage.

Valid values are:

CUSTOMS - Customs valuation currency
INVOICE - Invoicing currency
ACCOUNT - Account currency
TARGET - Destination or target currency
ORDER - Purchase order currency
PRICING - Pricing currency
TAX - Tax currency

–

MOA010-040 =

1 (CUSTOMS) or
4 (INVOICE) or
5 (ACCOUNT) or
7 (TARGET) or
9 (ORDER) or
10 (PRICING) or
18 (TAX)

advancePayment

number

Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.

–

L105

–

prepaidAmount

number

Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.

–

L106

–

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

–

L107 =

FSAC (RAIL) or
IATA (AIR) or
R260 (R260) or
SPLC (MOTOR)

–

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.

Valid values include:

CONTRACT - Contract rate
EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate
MINIMUM - Minimum
QUOTED - Quoted rate
SENDER - Sender rate
CONTAINER - IATA Container or Unit Load Device (ULD)
EXCEPTION - Exception rating
BASIC - Basic rate
COMMODITY - Specific commodity rate
EXPORT -Export Subsidy Rate
SUBSIDY - Subsidy Rate
KILOGRAM - Rate per kilogram

–

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

Special Charge Description

–

L112

TCC010-040

billedQuantityType

string

Code identifying the type of quantity or value on which the rate or item pricing is based.

Valid values include:

KILOMETERS - Kilometers
MILES - Miles
DRIVERS - Identifies a billable unit expressed as persons operating equipment
EACH - Each
POUND - Pound
KILOGRAM - Kilograms
HUNDREDPOUND - 100 pounds
PALLET - Pallet
STOPS - Stops
DAYS - Days
HOURS - Hours
TONS - Tons

–

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
BX (BOX) or
NU (UNIT) or
BL (BOL) or
FR (FLAT) or
KG (KILOGRAM) or
LC (HUNDREDPOUND) or
PL (PALLET) or
SP (STOPS) or
TD (DAYS) or
TH (HOURS) or
TN (TONS)

–

billedQuantityValue

number

Quantity of product in delivery - Basis for rating (miles, value, volume, etc.).

–

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

–

companyIdentifierType

string

Company identifier type for business partner.

Valid values include:

GLN
DUNS
DUNS4
COMPANYID
COMPANYSITEID

–

companyIdentifierValue

string

Company identifier value for business partner.

–

rateOrTariffClassDescription

string

Free form description of an applicable rate or tariff class.

–

TCC020-040

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

TDT010-020

agencyCode

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

TDT010-030

freightInvoiceCurrency

array

Currency codes for freight charge.

–

Segment C3

TCC- CUX

currencyCode

string

Currency code for specifying monetary unit.

–

C301

CUX010-020

exchangeRateCurrencyCode

string

Currency code for currency exchange.

–

exchangeRate

number

Exchange rate for conversion from currencyCode to currencyCodeExchange.

–

validityDate

string

Validity date for exchange rate.

–

epochValidityDate

integer

Validity date for exchange rate generated in epoch integer date format.

–

currenctyEntityCode

string

Currency entity code.

–

pricingInformation

array

Pricing information for product.

–

TCC/PRI

pricingType

string

Pricing type for price sales catalog.

Valid values include UNIT - Per Unit.

–

PRI010-030 = PE(UNIT)

PRI010-010 = "CAL" (Cal price)

pricingAmount

number

Unit price for pricing type.

–

PRI010-020

currencyCode

string

Currency code for the pricing amount.

–

pricingTypeQuantity

number

Quantity for pricing type.

–

PRI010-050

unitPriceBasisQuantity

string

Quantity basis of unit price, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12.

–

unitOfMeasure

string

Unit of measure used for pricing at the price conditions line item details level.

–

PRI010-060

itemQuantity

array

Quantity details pertain to charges.

–

TCC- QTY

quantityType

string

Type of quantity recorded.

Valid values include

CHARGEABLEWEIGHT - Chargeable weight quantity from the total consignment quantity.

–

QTY01

quantityValue

number

Quantity of product in shipment.

–

QTY02

unitOfMeasure

string

Unit or Basis for Measurement Code.

Unit of entry UOM's include:

UN - Unit
PC - Piece

–

exportLicense

array

Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.

–

Segment X1 under LX - N7 loop

–

licenseNumber

string

License number assigned by authority.

–

X102

–

licenseIssuingAgency

string

License number given authority or agency code.

–

X101

–

licenseTypeCode

string

License control/type, code.

–

X106

–

licenseCountry

string

Issuing country code.

–

X107

–

IssueDate

string

License issued date.

–

epochIssueDate

integer

License issued date in epoch format.

–

expirationDate

string

License expiry date.

–

X104

–

epochExpirationDate

integer

License expiry date in epoch format.

–

exportClassificationCode

string

Export clasification code ECCN code.

–

X116

–

importLicense

array

Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.

–

Segment X2 under LX - N7 loop

–

licenseNumber

string

License number assigned by authority.

–

X201

–

licenseIssuingAgency

string

License number given authority or agency code.

–

licenseTypeCode

string

License control/type, code.

–

licenseCountry

string

Issuing country code.

–

IssueDate

string

License issued date.

–

X202

–

epochIssueDate

integer

License issued date in epoch format.

–

expirationDate

string

License expiry date.

–

X203

–

epochExpirationDate

integer

License expiry date in epoch format.

–

exportClassificationCode

string

Export classification code ECCN code.

–

transactionReferenceIdentifierList

array

List of documents and transactions for equipment specification at line item level of the message.

–

Segment N9 under LX - N7 loop

–

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:

BOL - Bill of Lading
PURCHASEORDER - Purchase Order Number
SUPPLIERORDER - Vendor order number
MASTERBOL - Master BOL

–

N901 =

BM (BOL) Or
PO (PURCHASEORDER) Or
VN (SUPPLIERORDER) Or
MB (MASTERBOL)

–

b2bTransactionIdentifierValue

string

Transaction reference identifier value.

–

N902

–

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.

–

N904+N905

–

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

–

Segment N9 under LX - N7 loop

–

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 confirmation number
FORWARDERREFERENCE - Freight forwarder reference identifier
OCEANCONTAINERIDENTIFIER - Ocean container number
TRANSACTIONTYPE - Transaction type
CARRIERASSIGNEDSHIPPERIDENTIFIER - Carrier assigned shipment identifier.
PICKUPIDENTIFIER - Pickup reference number
LETTEROFCREDIT - Letter of credit number

–

N901 =

BN (BOOKINGIDENTIFIER)
FN (FORWARDERREFERENCE) Or
OC (OCEANCONTAINERIDENTIFIER) Or
8X (TRANSACTIONTYPE)

–

transactionReferenceIdentifier

string

Transaction reference identifier value.

–

N902 (for all other cases)

–

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.

–

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

customsReferenceInformation

array

Additional identifiers for specific needs, for example required by national agency such as customs.

–

customsReferenceType

string

Customs and/or excise purposes required by the relevant authorities for the import, export, or transit of the goods.

For Example listed below. Pass through

Type - Country - Description

UCR -NL - Unique Consignment Reference
CUS -NL - Customs Union and Statistics
ACID - EG - Advance Cargo Information Declaration in Egypt

–

customsReferenceValue

string

The value of the customsReference type.

–

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

codeListResponsibleAgencyType

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

countryCode

string

The 2 characters for the country code using ISO 3166-1 alpha-2

–

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. IMDG/IMO Class.

–

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.

Valid values:

TRUE - 1 - Yes Limited
FALSE - 0 - No

–

isMarinePollutant

boolean

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

Valid values:

TRUE - 1 - Yes Pollutant
FALSE - 0 - No

–

packagingGroup

string

Dangerous goods packaging group in terms of Roman number I, II or III.

–

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

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:

CELSIUS - Degree, Celsius
FAHRENHEIT - Degree, Fahrenheit

–

H108 =

CE (CELSIUS) Or
FA (FAHRENHEIT)

DGS040-020=

CEL (CELSIUS) Or
FAH (FAHRENHEIT)

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)"
ICAO - International civil aviation organization
UN - United nations code

–

H103 =

T (IATADG) Or
I (IMDG) Or
A (ICAO) Or
U (UN)

DGS010 =

ICA (ICAO)
IMD (IMDG)
ADR (ADR)

dangerousGoodsIdentifier

Number String

Dangerous goods identifier./ UNDG Number

–

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:

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

–

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.

Valid values:

TRUE - 1 - Yes
FALSE - 0 - No

–

additionalDangerousGoodsInformation

array

Additional Dangerous Goods information to be considered while specifying shipment instructions.

–

Segment H2 Loop under LX - N7 - 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

–

contactInformation

array

Dangerous goods contact information.

–

CTA

contactType

string

Contact type.

Valid values include:

DANGEROUSGOODS - Dangerous goods contact, Department/person to be contacted for details about the transportation of dangerous goods/hazardous material
EMERGENCYDANGEROUS - Contact person/person in charge in case of emergency.

–

CTA010 =

HG (DANGEROUSGOODS)
HE (EMERGENCYDANGEROUS)

contactName

string

Contact name.

–

H105

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.

–

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

freeFormText

string

Free test string.

–

FTX040-010

dangerousGoodsIdentifiers

array

It describes the hazardous commodity identification reference number and quantity.

–

Segment LH1 under LX - N7 loop

–

unitOfMeasure

string

Unit of measure for dangerous goods identification.

–

LH101

–

ladingQuantity

Number

Number of units (pieces) of the lading commodity.

–

LH102

–

hazardousMaterialIndex

string

The United Nations page number as required for the international transport of hazardous materials.

–

LH104

–

hazardousGoodsCommodityCode

string

Code describing a commodity or group of commodities.

–

LH105

–

dangerousGoodsQuantityValue

number

Quantity of product at line item level for dangerous goods.

–

LH107

–

residueIndicatorType

string

Types of residue indicator.

Valid values:

CONTAINMENT- Residue Last Contained Description (Small Means of Containment)
PACKAGES - Residue Last Contained Description (Packages)
RAILCAR - Residue Last Contained Description (Rail Car)

–

LH109 =

G (CONTAINMENT) or
P (PACKAGES) or
R (RAILCAR)

–

packagingGroup

string

Dangerous goods packaging group in terms of Roman number I, II or III.

–

LH110

–

dangerousMaterialRegulatoryIdentifier

string

Identifies the current regulatory version number used for hazardous materials shipments.

–

LH111

–

dangerousGoodsEndorsementInformation

array

LH2 segment describes about hazardous material notation and endorsement.

–

Segment LH2 under LX - N7 - LH1 loop

–

dangerousGoodsClassCode

string

Dangerous goods identifier.

–

LH201

–

dangerousGoodsClassification

string

Describes the hazardous material class.

Valid Values :

PRIMARY - Primary Goods
SECONDARY - Secondary Goods

–

LH202 =

P (PRIMARY) or
S (SECONDARY)

–

reportableSubstanceQuantityCode

string

To capture the presence of hazardous substance quantity code for quick action in case of emergency.

–

LH205

–

unitOfMeasure

string

Unit of measure for dangerous goods identification.

–

LH206

–

shipmentFlashPoint

string

Indicating the flashpoint of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.”

–

LH207

–

shipmentControlTemperature

string

Indicating the controlled temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.”

–

LH209

–

shipmentEmergencyTemperature

string

Indicating the maximum emergency temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.”

–

LH211

–

weightUnitType

string

Type of weight recorded.

Valid values include:

METRICTON - Metric ton
GRAMS - Grams
KILOGRAMS - Kilograms
POUNDS - Pounds
OUNCES - Ounces

–

LH212 =

E (METRICTON) or
G (GRAMS) or
K (KILOGRAMS) or
L (POUNDS) or
M (MEASUREMENTTON) or
O (OUNCES) or
S (SHORTTON) or
T (LONGTON)

–

explosiveWeight

Number

Net weight of the explosive quantity of the hazardous commodity.

–

LH213

–

dangerousGoodsRegulatedIdentifiers

array

To uniquely identify the variable information required by government regulation covering the transportation of hazardous material shipments.

–

Segment LFH under LX - N7 - LH1 loop

–

hazardMaterialInformationType

string

Type of shipment description recorded.

Valid value:

AIRLIFT - Cargo airlift only
ISSUEINGAUTHORITY - Person certifying that the shipment complies with the regulations
WET - "Dangerous When Wet" Declaration
EMERGENCYSCHEDULE - Emergency Schedule (EMS) Page Number
INHALATION - Inhalation Hazard
LIMITEDQUANTITY - Limited Quantity Declaration
MFAG - Medical First Aid Guide (MFAG) Page Number
POLLUTANT - Marine Pollutant
POISION - Poison Declaration
RADIOACTIVE - Radioactive Material Data
CHEMICAL -Technical or Chemical Group Name

–

LFH01 =

CAO (AIRLIFT) or
CER (ISSUEINGAUTHORITY) or
DWW (WET) or
EMS (EMERGENCYSCHEDULE) or
INH (INHALATION) or
LQY (LIMITEDQUANTITY) or
MFA (MFAG) or
MPI (POLLUTANT) or
POI (POISION) or
RAM(RADIOACTIVE) or
TEC (CHEMICAL)

–

description

string

Specific information required by law for hazardous material shipments.

–

LFH02 + LFH03

–

consignmentItems

array

Each consignment 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 each commodity item.

–

L001

GID010

billedQuantityValue

number

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

–

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

–

weightValue

Number

Weight of product at PO line item

–

L004

weightType

string

Type of weight recorded.

Valid values include:

GROSSWEIGHT
NETWEIGHT

–

L005

–

volumeValue

Number

Volume for item

–

L006

–

volumeType

string

Type of weight recorded.

Valid values includes:

CUBICFEET - Cubic feet
CUBICMETER - Cubic meters

–

L007

–

ladingQuantity

number

Number of handling units of the line item tendered to carrier.

–

L008

GID020-010

declaredAmount

number

Declared monetary value of the consignment item, as stated by the consignor, for ad valor-em rating purposes and to determine the carrier’s liability in the event of loss, damage, or delay.

–

insuranceAmount

number

The monetary value of this supply chain consignment item as covered by an insurance policy.

–

packagingFormatCode

string

Packing form of lading quantity,

Valid values include:

CONTAINER - Containers
BARREL - Barrels

–

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

description

string

Material description used to protect lading.

–

L010

GID020-050

weightUnitType

string

Type of weight recorded.

Valid values include:

METRICTON - Metric ton
GRAMS - Grams
KILOGRAMS - Kilograms
POUNDS - Pounds
OUNCES - Ounces

–

L011 =

E (METRICTON) or
G (GRAMS) or
K (KILOGRAMS) or
L (POUNDS) or
M (MEASUREMENTTON) or
O (OUNCES) or
S (SHORTTON) or
T (LONGTON)

–

transportServiceType

string

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

Valid values are:

AIRPORTTOAIRPORT - Rate for requested transport services from airport to airport
BULKBREAK - Rate for requested transport services for bulk break
DOORTODOOR - Rate for requested transport services from door to door
DOORTOAIRPORT - Rate for requested transport services from door to airport

–

L012 =

AA (AIRPORTTOAIRPORT) or
BB (BULKBREAK) or
DD (DOORTODOOR) or
DA (DOORTOAIRPORT)

TMD010-010

packageVerificationQuantity

number

Total number of boxes, cartons, or pieces contained on a pallet, skid, or slip sheet for the line item.

–

packageVerificationFormatCode

string

Packing form of counting required quantity.

Valid values:

BOX - Boxes
CARTON - Cartons
PIECES - Pieces

–

isVerificationRequired

boolean

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

Valid values:

TRUE - Yes
FALSE - No

–

equipmentIdentifier

string

The container/Equipment number, where this cargo item located.

–

ladingItemDetails

array

Lading line item in terms of description, packaging, and marks and numbers.

–

L5

PIA / PCI

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

PIA020-010

commoditySystemType

string

Describes the commodity coding system used for Commodity Code.

Valid values included:

DUNS - Dun's SIC 2+2, Dun & Bradstreet
NDC - National Drug Code
FREIGHT - Canadian Freight
FALSEMOTORFREIGHT - Motor Freight Classification
BULK - Bulk Codes
QUOTA - Quota Category
TRADE - Standard International Trade Classification
TRANSPORTATION - Standard Transportation Commodity Code
MUTUALLYDEFINED - Mutually defined
HARMONISEDSYSTEM - Harmonized system
COMMODITYGROUPING - Commodity grouping

–

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)

PIA020-020 =

BG (NDC)
HS (HARMONISEDSYSTEM)
CG (COMMODITYGROUPING)
ZZ (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)

–

numberOfPackages

number

The number of logistics packages at this level.

–

packagingIdentifierType

string

Packaging identifier type.

Valid values ENTIRESHIPMENT - Marking refer to entire shipment.

–

L507 = S (ENTIRESHIPMENT)

PCI010 = 23 (ENTIRESHIPMENT)

packagingIdentifier

string

Packaging identifier value defined by the packaging type.

–

L506

PCI020

ladingItemRateCharges

array

Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements.

–

Segment: L0 - L1 Loop

Segment TCC and MOA (Segment Group: 28 (CNI))

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 (implicit decimal)

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)

–

freightInvoiceChargeType

string

Code representing type of freight charges.

Valid values:

TOTAL - Total amount -
TAX - Tax amount
DECLARED - Total declared
CHARGEDUE - Total charge due
FREIGHTDUE - Total freight due
PAYMENT - Total payment amount
SERVICE - Total service charge
SALESTAX - Sales tax
UNITPRICE - Unit Price
TRANSFER - Transfer Amount
CUSTOMS - Customs duty paid

–

MOA010-010 =

128 (TOTAL) or
162 (CUSTOMS) or
146 (UNITPRICE) or
124 (TAX) or
134 (DECLARED) or
130 (CHARGEDUE) or
135 (FREIGHTDUE) or
139 (PAYMENT) or
140 (SERVICE) or
120 (SALESTAX) or
143 (TRANSFER)

totalCharges

number

Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency.

–

L104

MOA010-020, as per freightInvoiceChargeType

currencyCode

string

Currency code for the pricing amount.

–

MOA010-030

currencyUsageType

string

Describes the type of currency based on usage.

Valid values are:

CUSTOMS - Customs valuation currency
INVOICE - Invoicing currency
ACCOUNT - Account currency
TARGET - Destination or target currency
ORDER - Purchase order currency
PRICING - Pricing currency
TAX - Tax currency

–

MOA010-040 =

1 (CUSTOMS) or
4 (INVOICE) or
5 (ACCOUNT) or
7 (TARGET) or
9 (ORDER) or
10 (PRICING) or
18 (TAX)

advancePayment

number

Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.

–

L105

–

prepaidAmount

number

Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.

–

L106

–

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

–

L107 =

FSAC (RAIL) or
IATA (AIR) or
R260 (R260) or
SPLC (MOTOR)

–

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.

Valid values include:

CONTRACT - Contract rate
EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate
MINIMUM - Minimum
QUOTED - Quoted rate
SENDER - Sender rate
CONTAINER - IATA Container or Unit Load Device (ULD)
EXCEPTION - Exception rating
BASIC - Basic rate
COMMODITY - Specific commodity rate
EXPORT -Export Subsidy Rate
SUBSIDY - Subsidy Rate
KILOGRAM - Rate per kilogram

–

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

Special Charge Description

–

L112

TCC010-040

billedQuantityType

string

Code identifying the type of quantity or value on which the rate or item pricing is based.

Valid values include:

KILOMETERS - Kilometers
MILES - Miles
DRIVERS - Identifies a billable unit expressed as persons operating equipment
EACH - Each
POUND - Pound
KILOGRAM - Kilograms
HUNDREDPOUND - 100 pounds
PALLET - Pallet
STOPS - Stops
DAYS - Days
HOURS - Hours
TONS - Tons

–

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
BX (BOX) or
NU (UNIT) or
BL (BOL) or
FR (FLAT) or
KG (KILOGRAM) or
LC (HUNDREDPOUND) or
PL (PALLET) or
SP (STOPS) or
TD (DAYS) or
TH (HOURS) or
TN (TONS)

–

billedQuantityValue

number

Quantity of product in delivery - Basis for rating (miles, value, volume, etc.)

–

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

–

companyIdentifierType

string

Company identifier type for business partner.

Valid values include:

GLN
DUNS
DUNS4
COMPANYID
COMPANYSITEID

–

companyIdentifierValue

string

Company identifier value for business partner.

–

rateOrTariffClassDescription

string

Free form description of an applicable rate or tariff class.

–

TCC020-040

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

TDT010-020

agencyCode

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

TDT010-030

freightInvoiceCurrency

array

Currency codes for freight charge.

–

Segment C3

TCC- CUX

currencyCode

string

Currency code for specifying monetary unit.

–

C301

CUX010-020

exchangeRateCurrencyCode

string

Currency code for currency exchange.

–

exchangeRate

number

Exchange rate for conversion from currencyCode to currencyCodeExchange.

–

validityDate

string

Validity date for exchange rate.

–

epochValidityDate

integer

Validity date for exchange rate generated in epoch integer date format.

–

currenctyEntityCode

string

Currency entity code.

–

pricingInformation

array

Pricing information for product.

–

TCC/PRI

pricingType

string

Pricing type for price sales catalog.

Valid values include UNIT -Per Unit.

–

PRI010-030 = PE(UNIT)

PRI010-010 = "CAL" (Cal price)

pricingAmount

number

Unit price for pricing type.

–

PRI010-020

currencyCode

string

Currency code for the pricing amount.

–

pricingTypeQuantity

number

Quantity for pricing type.

–

PRI010-050

unitPriceBasisQuantity

string

Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12.

–

unitOfMeasure

string

Unit of measure used for pricing at the price conditions line item details level.

–

PRI010-060

itemQuantity

array

Quantity details pertain to charges.

–

TCC- QTY

quantityType

string

Type of quantity recorded.

Valid values include

CHARGEABLEWEIGHT - Chargeable weight quantity from the total consignment quantity.

–

QTY01

quantityValue

number

Quantity of product in shipment.

–

QTY02

unitOfMeasure

string

Unit or Basis for Measurement Code.

Unit of entry UOM's include:

UN - Unit
PC - Piece

–

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:

PILOTAGEARRANGED - Reports that pilot age for the vessel has been arranged.

–

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. Pass thru mapping, ie, 9 = GS1

–

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:

STORAGE - Storage temperature
TRANSPORT - Transport temperature
CARGO - Cargo operation temperature
EMERGENCY - Transport emergency temperature
TRANSPORTCONTROL - Transport control temperature
RECORDEDTEMPERATURE - Recorded temperature

–

TMP010 =

1 (STORAGE) Or
2 (TRANSPORT) Or
3 (CARGO) Or
4 (EMERGENCY) Or
5 (TRANSPORTCONTROL) Or
7 (RECORDEDTEMPERATURE)

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:

CE - Celsius
FA - Fahrenheit

–

RNG020-010 = CEL (CE) Or FAH (FA)

description

string

Descriptive information about environment required for goods item.

–

locationDetails

Location or country details related to item in transport, such as country of origin, destination.

–

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

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.

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 volument
EQUIPMENTGROSSWEIGHT - Transport equipment gross weight
GROSSWEIGHT - Weight (mass) of goods including packing but excluding the carrier's equipment.
NETWEIGHT - Net weight
NETVOLUME - Net volume
RADIOACTIVITY - Radio activity
MUTUALLYDEFINED - Custom measurement type

–

MEA020-010 =

SQ (SHIPPEDQUANTITY) Or
AAW (GROSSVOLUME) Or
AET (EQUIPMENTGROSSWEIGHT) Or
G (GROSSWEIGHT) Or
AAF (NETWEIGHT) Or
AAX (NETVOLUME) Or
AEO (RADIOACTIVITY) Or
ZZZ (MUTUALLYDEFINED)
ABJ (VOLUME)

shipmentDimensions

array

Dimensions of freight.

–

GID-DIM

dimensionsType

string

Type of dimensions recorded for freight.

Valid values include:

LENGTH - Largest horizontal dimension of an object measured when the object is in the upright position
WIDTH - Shorter measurement of the two horizontal dimensions measured with the object in the upright position
HEIGHT - Vertical dimension of an object measured when the object is in the upright position

–

dimensionsValue

Number

Volume for item in inches.

–

DIM020-020, when dimensionsType = LENGTH
DIM020-030, when dimensionsType = WIDTH
DIM020-040, when dimensionsType = HEIGHT

unitOfMeasure

string

Dimension unit of measure for parent packaging. Valid values.

C - Centimeters
F - Feet
N - Inches
X - Meters

–

DIM020-010

exportLicense

array

Captures export license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.

–

Segment X1 under LX - L0 loop

–

isRequired

boolean

Information provided by the shipper to indicate whether an Export License or permit is required for this shipment/commodity/destination.

Valid values:

TRUE - Required
FALSE - Not required

–

licenseNumber

string

License number assigned by authority.

–

X102

–

licenseIssuingAgency

string

License number given authority or agency code.

–

X101

–

licenseTypeCode

string

License control/type, code

–

X106

–

licenseCountry

string

Issuing country code.

–

X107

–

IssueDate

string

License issued date.

–

epochIssueDate

integer

License issued date in epoch format.

–

expirationDate

string

License expiry date.

–

X104

–

epochExpirationDate

integer

License expiry date in epoch format.

–

exportClassificationCode

string

Export classification code ECCN code.

–

X116

–

importLicense

array

Captures import license details required for controlled commodities, including license number, type, issuing country, authorization party and validity dates.

–

Segment X2 under LX - L0 loop

–

isRequired

boolean

Information provided by the shipper to indicate whether an Export License or permit is required for this shipment/commodity/destination.

Valid values:

TRUE - Required
FALSE - Not required

–

licenseNumber

string

License number assigned by authority.

–

X201

–

licenseIssuingAgency

string

License number given authority or agency code.

–

licenseTypeCode

string

License control/type, code.

–

licenseCountry

string

Issuing country code.

–

IssueDate

string

License issued date.

–

X202

–

epochIssueDate

integer

License issued date in epoch format.

–

expirationDate

string

License expiry date.

–

X203

–

epochExpirationDate

integer

License expiry date in epoch format.

–

exportClassificationCode

string

Export classification code ECCN code.

–

customsReferenceInformation

array

Additional identifiers for specific needs, for example required by national agency such as customs.

–

customsReferenceType

string

Customs and/or excise purposes required by the relevant authorities for the import, export, or transit of the goods.

For Example listed below.

Type - Country - Description

UCR -NL - Unique Consignment Reference
CUS -NL - Customs Union and Statistics
ACID - EG - Advance Cargo Information Declaration in Egypt

–

customsReferenceValue

string

The value of the customsReference type.

–

codeListIdentifier

string

Identifies which code list a given value comes from, ensuring the meaning of the code is interpreted correctly.

–

codeListResponsibleAgencyType

string

Specifies the organization or responsible agency code that maintains or governs the referenced code list.

–

countryCode

string

The 2 characters for the country code using ISO 3166-1 alpha-2.

–

certificationClause

array

Defines standardized certifications or contractual clauses associated with a shipment, capturing both the coded clause and its descriptive text for inclusion in transport documents like the Bill of Lading.

–

Segment C8 under LX - L0 loop

–

lineItemNumber

string

transaction set line number.

–

certificationOrClauseCode

string

Coded certification/condition applied

Valid values include:

SHORTSHIPPED - Cargo Short‑Shipped
EMERGENCYSTATEMENT - Instructions for accident handling (spill, fire, DG).
IMOCERTIFICATION - Confirms cargo meets maritime safety rules.
CERTIFICATIONSTATEMENT - General compliance confirmation.
NOEXPORTDECLARATION - No Shipper’s Export Declaration Required
CUSTOM - Custom / Mutually Defined Clause

–

C802 =

08 (SHORTSHIPPED) Or
29 (EMERGENCYSTATEMENT) Or
30 (IMOCERTIFICATION) Or
38 (CERTIFICATIONSTATEMENT) Or
20 (NOEXPORTDECLARATION) Or
CC (CUSTOM)

–

description

string

Free‑form clause or descriptive text supporting the code.

–

C803

–

certificationClauseDescription

array

Stores additional free‑form continuation texts associated with a certification or contractual clause.

–

Segment C8C under LX - L0 - C8 loop

–

description

string

Clause free form text description.

–

C8C01 / C802 / C803

–

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

lineItemNumber

string

transaction set line number.

–

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.

Valid values:

TRUE - 1 - Yes
FALSE - 0 - NA

–

isMarinePollutant

boolean

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

Valid values:

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.

–

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:

CELSIUS - Degree, Celsius
FAHRENHEIT - Degree, Fahrenheit

–

H108 =

CE (CELSIUS) Or
FA (FAHRENHEIT)

DGS040-020=

CEL (CELSIUS) Or
FAH (FAHRENHEIT)

dangerousGoodsType

string

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

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)"
ICAO - International civil aviation organization
UN - United nations code

–

H103 =

T (IATADG) Or
I (IMDG) Or
A (ICAO) Or
U (UN)

DGS010 =

ICA (ICAO)
IMD (IMDG)
ADR (ADR)

dangerousGoodsIdentifier

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:

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

–

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.

Valid values:

TRUE - 1 - Yes
FALSE - 0 - No

–

isExceptedQuantityAllowed

boolean

Indicates whether the hazardous material qualifies to be transported under an excepted quantity provision as defined by applicable dangerous goods regulations.

–

isSalvagePackaging

boolean

Indicates whether special recovery or salvage packaging is used for damaged, leaking, or non‑compliant hazardous material containers.

–

isWasteMaterial

boolean

Identifies whether the hazardous goods being transported are classified as waste material.

–

isHighTemperatureCargo

boolean

Indicates whether the hazardous cargo is transported at elevated temperatures requiring special handling or regulatory consideration.

–

isAuthorityApprovalRequired

boolean

Indicates whether prior approval from a regulatory or governing authority is required before transporting the hazardous goods.

–

approvalSignatoryAuthority

string

Captures the name and reference information of the regulatory authority that granted approval for the hazardous goods shipment.

–

additionalDangerousGoodsInformation

array

Additional Dangerous Goods information to be considered while specifying shipment instructions.

–

Segment H2 Loop 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

–

contactInformation

array

Dangerous goods contact information.

–

CTA

contactType

string

Contact type.

Valid values include:

DANGEROUSGOODS - Dangerous goods contact, Department/person to be contacted for details about the transportation of dangerous goods/hazardous material
EMERGENCYDANGEROUS - Contact person/person in charge in case of emergency.

–

CTA010 =

HG (DANGEROUSGOODS)
HE (EMERGENCYDANGEROUS)

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.

–

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

freeFormText

string, array

Free test string.

–

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.

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 volument
EQUIPMENTGROSSWEIGHT - Transport equipment gross weight
GROSSWEIGHT - Weight (mass) of goods including packing but excluding the carrier's equipment.
NETWEIGHT - Net weight
NETVOLUME - Net volume
RADIOACTIVITY - Radio activity
MUTUALLYDEFINED - Custom measurement type

–

MEA020-010 =

SQ (SHIPPEDQUANTITY) Or
AAW (GROSSVOLUME) Or
AET (EQUIPMENTGROSSWEIGHT) Or
G (GROSSWEIGHT) Or
AAF (NETWEIGHT) Or
AAX (NETVOLUME) Or
AEO (RADIOACTIVITY) Or
ZZZ (MUTUALLYDEFINED)

dangerousGoodsIdentifiers

array

It describes the hazardous commodity identification reference number and quantity.

–

Segment LH1 under LX - N7 loop

–

lineItemNumber

string

transaction set line number

–

unitOfMeasure

string

Unit of measure for dangerous goods identification.

–

LH101

–

ladingQuantity

Number

Number of units (pieces) of the lading commodity.

–

LH102

–

hazardousMaterialIndex

string

The United Nations page number as required for the international transport of hazardous materials.

–

LH104

–

hazardousGoodsCommodityCode

string

Code describing a commodity or group of commodities.

–

LH105

–

dangerousGoodsQuantityValue

number

Quantity of product at line item level for dangerous goods.

–

LH107

–

residueIndicatorType

string

Types of residue indicator.

Valid values:

CONTAINMENT- Residue Last Contained Description (Small Means of Containment)
PACKAGES - Residue Last Contained Description (Packages)
RAILCAR - Residue Last Contained Description (Rail Car)

–

LH109 =

G (CONTAINMENT) or
P (PACKAGES) or
R (RAILCAR)

–

packagingGroup

string

Dangerous goods packaging group in terms of Roman number I, II or III.

–

LH110

–

dangerousMaterialRegulatoryIdentifier

string

Identifies the current regulatory version number used for hazardous materials shipments.

–

LH111

–

dangerousGoodsEndorsementInformation

array

LH2 segment describes about hazardous material notation and endorsement.

–

Segment LH2 under LX - L0 - LH1 loop

–

dangerousGoodsClassCode

string

Dangerous goods identifier.

–

LH201

–

dangerousGoodsClassification

string

Describes the hazardous material class.

Valid Values :

PRIMARY - Primary Goods
SECONDARY - Secondary Goods

–

LH202 =

P (PRIMARY) or
S (SECONDARY)

–

reportableSubstanceQuantityCode

string

To capture the presence of hazardous substance quantity code for quick action in case of emergency.

–

LH205

–

unitOfMeasure

string

Unit of measure for dangerous goods identification.

–

LH206

–

shipmentFlashPoint

string

Indicating the flashpoint temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.”

–

LH207

–

shipmentControlTemperature

string

Indicating the controlled temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.”

–

LH209

–

shipmentEmergencyTemperature

string

Indicating the maximum emergency temperature of the goods, expressed in the unit of measure defined for temperature. Applicable only for dangerous goods of type “IMDG.”

–

LH211

–

weightUnitType

string

Type of weight recorded.

Valid values include:

METRICTON - Metric ton
GRAMS - Grams
KILOGRAMS - Kilograms
POUNDS - Pounds
OUNCES - Ounces

–

LH212 =

E (METRICTON) or
G (GRAMS) or
K (KILOGRAMS) or
L (POUNDS) or
M (MEASUREMENTTON) or
O (OUNCES) or
S (SHORTTON) or
T (LONGTON)

–

explosiveWeight

Number

Net weight of the explosive quantity of the hazardous commodity.

–

LH213

–

dangerousGoodsRegulatedIdentifiers

array

To uniquely identify the variable information required by government regulation covering the transportation of hazardous material shipments.

–

Segment LFH under LX - L0 - LH1 loop

–

hazardMaterialInformationType

string

Type of shipment description recorded.

Valid value:

AIRLIFT - Cargo airlift only
ISSUEINGAUTHORITY - Person certifying that the shipment complies with the regulations
WET - "Dangerous When Wet" Declaration
EMERGENCYSCHEDULE - Emergency Schedule (EMS) Page Number
INHALATION - Inhalation Hazard
LIMITEDQUANTITY - Limited Quantity Declaration
MFAG - Medical First Aid Guide (MFAG) Page Number
POLLUTANT - Marine Pollutant
POISION - Poison Declaration
RADIOACTIVE - Radioactive Material Data
CHEMICAL -Technical or Chemical Group Name

–

LFH01 =

CAO (AIRLIFT) or
CER (ISSUEINGAUTHORITY) or
DWW (WET) or
EMS (EMERGENCYSCHEDULE) or
INH (INHALATION) or
LQY (LIMITEDQUANTITY) or
MFA (MFAG) or
MPI (POLLUTANT) or
POI (POISION) or
RAM(RADIOACTIVE) or
TEC (CHEMICAL)

–

description

string

Specific information required by law for hazardous material shipments.

–

LFH02 + LFH03

–

goodsPlacedEquipment

array

Allocation / placement of goods into equipment, this segment can also used establish relation to goods and equipments.

–

GID/SGP

equipmentIdentifier

string

The container/Equipment number indicated here must be identical to the container number in the EQD segment.

–

SGP010-010

ladingQuantity

Number

Number of packages, The actual number of packages in the container.

–

SGP020

sealQuantity

Number

Indicates how many seals are applied to the transport equipment.

–

equipmentSealNumbers

array

Shipment carrying equipments seal numbers.

–

segment loop LX-N7-M701

–

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

CARRIER - Carriers
ENDCUSTOMER - End customer
SHIPPER - Shipper
CUSTOMS - Customs
UNKNOWN - Unknown

–

transactionReferenceIdentifierList

array

Transaction references for deliveries at header level.

–

Segment Group: 31 (RFF (Part of CNI loop))

b2bTransactionIdentifierType

string

Referenced document type.

–

RFF01-010

b2bTransactionIdentifierValue

string

Reference order identifier value for Dispatch advice transaction type identified by transactionReferenceIdentifierType.

–

REF010-020

transactionDate

string

Date transaction created.

–

epochTransactionDate

integer

Date transaction created in epoch integer date format.

–

lineItemNumber

string

Line item number in transaction reference. Line item level only.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments L11 and N9 for information other than transaction documents.

–

Segment Group: 31 (RFF (Part of CNI loop))

transactionReferenceType

string

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

Valid values include:

COMMODITYIDENTIFIER: Actual commodity or Product Identifier packed in transport
BOOKINGIDENTIFIER: Booking Number

–

RFF01-010 = AED (COMMODITYIDENTIFIER)

transactionReferenceIdentifier

string

Transaction reference identifier value.

–

RFF01-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.

–

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

freeTextNote

array

Free text, instructions, notes, descriptions and other free text elements.

–

Segment FTX

textReferenceCode

string

Text reference or subject code.

Example values for EDIFACT:

AAA - Goods item description
AAB - Payment term
AAD - Dangerous goods technical name
AAK - Price conditions
AAR - Delivery terms
AAS - Bill of lading remarks
DAR - Damage remarks
COI - Order Information
CUR - Customer remarks
DIN - Delivery instruction
INV - Invoice instruction
BLC - Bill of lading clause

–

FTX010

textFunctionCode

string

Text function code.

–

FTX020

language

string

Language key for message.

–

languageCode

string

ISO language code for message.

–

textFormatCode

string

Format code for free text.

–

freeFormText

string, array

Free text array.

–

K101, K102 Each is 30 characters. Mapping to canonical, concatenate K1 and K2. Mapping from canonical split into 2 fields.

FTX040-010, FTX040-20, FTX040-030, FTX040-040

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.

–

canonicalOceanBillOfLadingWeightChargesSummary

–

Describes the total shipment in terms of weight, volume, rates, charges, advances, and prepaid amounts applicable to one or more line items.

–

Segment L3 (weight and charges summary)

–

freightRate

number (implicit decimal)

Rate that applies to the specific commodity.

–

L303

–

freightRateType

string

Qualifiers to extend charges or interpret or calculate value.

Valid values are:

UNIT - Per Unit
CAR - Per Car
POUND - Per Pound
PERCENTAGE - Percentage
CHARGES - Charges based on mentioned percentage
MILES - Per Miles
MINIMUM - Minimum Charge
FLAT - Flat rate
PERHUNDRED - Per Hundred (of Basic Unit )

–

L304 or L315 =

PU (UNIT) or
PC (CAR) or
PW (PERCENTAGE) or
CR (CHARGES) or
PM (MILES) or
MN (MINIMUM) or
PH (PERHUNDRED) or
FR (FLAT) or
LB (POUND)

–

totalCharges

number

Describes about freight or special charge or total charges expressed in the standard monetary denomination for specified currency.

–

L305

–

advancePayment

number

Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.

–

L306

–

prepaidAmount

number

Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.

–

L307

–

specialChargeCode

string

Type of special charge or allowance allowed.

Valid values include:

DISCOUNT - Discount
SPECIALDISCOUNT - Special Discount
CUSTOMSENTRY - Customs Entry
CUSTOMSCHARGE - Customs Charge

–

L308 =

DSC (DISCOUNT) or
295 (SPECIALDISCOUNT) or
CSE (CUSTOMSENTRY) or
CUS (CUSTOMSCHARGE)

–

tariffIdentifier

string

Standard tariff number for the tariff which governs the rates applied to the commodity item(s).

–

L313

–

weightUnitType

string

Type of weight recorded.

Valid values include:

METRICTON - Metric ton
GRAMS - Grams
KILOGRAMS - Kilograms
POUNDS - Pounds
OUNCES - Ounces

–

L312 =

E (METRICTON) or
G (GRAMS) or
K (KILOGRAMS) or
L (POUNDS) or
M (MEASUREMENTTON) or
O (OUNCES) or
S (SHORTTON) or
T (LONGTON)

–

quantityType

string

Type of quantity recorded.

Valid values include LADING.

–

quantityValue

number

Quantity of product in delivery

–

L311 where quantityType = LADING

–

weightType

string

Type of weight recorded.

Valid values include:

GROSSWEIGHT
NETWEIGHT
DIMENSIONALWEIGHT
TARE

–

L302

–

weightValue

Number

Weight of product at PO line item.

–

L301

–

volumeType

string

Type of weight recorded.

Valid values include TOTAL.

–

L310

–

volumeValue

Number

Volume for item.

–

L309

–

canonicalOceanBillOfLadingFreightChargesSummary

array

Describes rate and charges details related to a line item including freight charges, advances, special charges, and entitlements Even though the X12 L1 segment appears in the summary section of the 310, it actually behaves like a charge line rather than a simple total. Each L1 can describe how a charge was calculated, including the rate, basis, and quantity (for example, freight charged per container or per weight). Multiple L1 segments can exist, similar to individual invoice lines shown at the end of a Bill of Lading. Its position reflects document structure, not business meaning. Because of this, L1 cannot be directly treated as equivalent to the EDIFACT TCC segment, which only classifies charges at a high level.

–

Segment: L1 Loop

–

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.

–

L101

–

freightRate

number (implicit decimal)

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)

–

freightInvoiceChargeType

string

Code representing type of freight charges.

Valid values:

TOTAL -Total amount
TAX - Tax amount
DECLARED - Total declared
CHARGEDUE - Total charge due
FREIGHTDUE - Total freight due
PAYMENT - Total payment amount
SERVICE - Total service charge
SALESTAX - Sales tax
UNITPRICE - Unit Price
TRANSFER - Transfer Amount
CUSTOMS - Customs duty paid

–

totalCharges

number

Describes about freight or special charge or total charges -- expressed in the standard monetary denomination for specified currency.

–

L104

–

currencyCode

string

Currency code for the pricing amount.

–

currencyUsageType

string

Describes the type of currency based on usage.

Valid values are:

CUSTOMS - Customs valuation currency
INVOICE - Invoicing currency
ACCOUNT - Account currency
TARGET - Destination or target currency
ORDER - Purchase order currency
PRICING - Pricing currency
TAX - Tax currency

–

advancePayment

number

Incidental charges occurred during transportation expressed in the standard monetary denomination for the specified currency.

–

L105

–

prepaidAmount

number

Money paid at point of origin (usually by shipper) expressed in the standard monetary denomination for the specified currency.

–

L106

–

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

–

L107 =

FSAC (RAIL) or
IATA (AIR) or
R260 (R260) or
SPLC (MOTOR)

–

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.

Valid values include:

CONTRACT - Contract rate
EXCESSWEIGHT - Weight in Excess of Pivot Weight and Applicable Rate
MINIMUM - Minimum
QUOTED - Quoted rate
SENDER - Sender rate
CONTAINER - IATA Container or Unit Load Device (ULD)
EXCEPTION - Exception rating
BASIC - Basic rate
COMMODITY - Specific commodity rate
EXPORT -Export Subsidy Rate
SUBSIDY - Subsidy Rate
KILOGRAM - Rate per kilogram

–

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)

–

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:

KILOMETERS - Kilometers
MILES - Miles
DRIVERS - Identifies a billable unit expressed as persons operating equipment
EACH - Each
POUND - Pound
KILOGRAM - Kilograms
HUNDREDPOUND - 100 pounds
PALLET - Pallet
STOPS - Stops
DAYS - Days
HOURS - Hours
TONS - Tons

–

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
BX (BOX) or
NU (UNIT) or
BL (BOL) or
FR (FLAT) or
KG (KILOGRAM) or
LC (HUNDREDPOUND) or
PL (PALLET) or
SP (STOPS) or
TD (DAYS) or
TH (HOURS) or
TN (TONS)

–

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

–

companyIdentifierType

string

Company identifier type for business partner.

Valid values include:

GLN
DUNS
DUNS4
COMPANYID
COMPANYSITEID

–

companyIdentifierValue

string

Company identifier value for business partner.

–

rateOrTariffClassDescription

string

Free form description of an applicable rate or tariff class.

–

freightInvoiceCurrency

array

Currency codes for invoice.

–

Segment C3

–

currencyCode

string

Currency code for pricing in freight invoice.

–

C301

–

exchangeRateCurrencyCode

string

Currency code for currency exchange.

–

exchangeRate

number

Exchange rate for conversion from currencyCode to currencyCodeExchange

–

validityDate

string

Validity date for exchange rate.

–

epochValidityDate

integer

Validity date for exchange rate generated in epoch integer date format.

–

currenctyEntityCode

string

Currency entity code.

–

canonicalOceanBillOfLadingSummary

array

Summary totals in invoice.

–

summaryType

string

Type of summary.

Valid values include:

TOTALEQUIPMENTS - Total no of equipments
NUMBEROFITEMS - Total number of line items
LADINGQUANTITY - Total BOL quantity
GROSSWEIGHT - Gross weight
DECLARED - Declared value

–

CNT010-010 =

16 (TOTALEQUIPMENTS) Or
2 (NUMBEROFITEMS) Or
11 (LADINGQUANTITY) Or
7 (GROSSWEIGHT) Or

summaryValue

–

Value in summary to map it to segment count.

–

SE01 when summaryType = NUMBEROFITEMS

CNT010-020

summaryUnit

string

Unit of measure or currency or other unit for summary value.

–

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.

–