Load tender response canonical guidelines

Canonical Element	Type Definition	Description	IDoc mapping	X12 mapping	EDIFACT mapping
Canonical Element	–	JSon object type/root element.	–	–	–
	controlFileHeader	–	Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages.	–	–	–
	canonicalCarrierLoadTenderResponse	–	Overall details for the load tender response message canonical.	–	Segment B1	–
		processingFunctionTypeCode	string	Processing function, transaction set purpose code. Valid values include: `CREATE` `CHANGE` `CANCEL` `ORIGINAL` `REPLACE` `STATUS` `CONFIRM`	–		–
		carrierCode	string	Shipping carrier alpha code (SCAC).	–	B101	–
		shipmentBookingStatus	string	Code specifying status of the booking request. Valid values include: `True` `CONFIRMED` - Booking request accepted `CONDITIONAL` - Conditionally accepted `ALTERNATIVEOFFER` - Counter proposal made by carrier with different options `CANCELLED` - Reservation canceled `REJECTED` - Reservation declined before its confirmation `RECEIVED` - New request received	–	B104	–
		isPartialLoad	boolean	Code specifying partial load allowed. Valid values: - Partial load allowed `False` - Partial load not allowed.	–	B105 = Y (true) Or N (false)	–
		bookingDeclineReasonCode	string	Code specifying reason behind booking cancel by carrier or customer valid values include: `CAPACITYTYPE` - Carrier cannot accept because the type of requested space/capacity isn’t offered `CAPACITY` - Carrier offers that capacity type, but it’s currently full/ un available `EQUIPMENTTYPE` - The requested equipment type isn’t supported. `EQUIPMENT` - The equipment is unavailable	–	B106	–
		shipmentChargePaymentMethodType	string	Payment terms for transportation charges. Valid values: `COLLECT` `PREPAIDSELLER` `SELLER` `THIRDPARTYPAY` `ADVANCECOLLECT` `ADVANCEPREPAID` `BUYER` `BUYERSELLERDEFINED`	–	B107 = CC (COLLECT) or PA (ADVANCEPREPAID) or PO (PREPAIDONLY) or PP (PREPAIDSELLER) or PS (SELLER) or TP (THIRDPARTYPAY) or CA (ADVANCECOLLECT) or BP (BUYER) or DF (BUYERSELLERDEFINED)	–
		transactionReferenceIdentifierList	array	List of documents and transactions((Do not have sample data, kept this based on 315 sample data) at the header level of the message.	–	L11 for(>=4010) Version N9 (v4010) & B1	–
			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: `LOADTENDERRESPONSE` (Required) - Transaction unique indentifier `CONSIGNEEORDERIDENTIFIER` - Conginees order number `PURCHASEORDER` - Purchase Order Number `BOL` - Bill of Lading Number `PURCHASEORDER` - Purchase Order Number `SUPPLIERORDER` - Vendor order number `MASTERBOL` - Master BOL `AGENTSHIPMENT` - Agent shipment number `CARRIERREFERENCE` - Carrier reference number	–	N901 / L1102 = BM (BOL) Or CT (CONTRACT) Or PO (PURCHASEORDER) Or VN (SUPPLIERORDER) Or SI (SHIPMENT) Or MB (MASTERBOL) Or AG (AGENTSHIPMENT) Or CN (CARRIERREFERENCE) Or	–
			b2bTransactionIdentifierValue	string	Transaction reference identifier value.	–	B102 when b2bTransactionIdentifierType =BOL or LOADTENDERRESPONSE N902 / L1101 for remaining qualifiers in b2bTransactionIdentifierType	–
			transactionDate	string	Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.	–	B103 (Date)b2bTransactionIdentifierType =LOADTENDERRESPONSE N904+N905 / L1104 for remaining qualifiers in b2bTransactionIdentifierType	–
			epochTransactionDate	string	Transaction reference date and time, if time available, in epoch date format.	–	–	–
			lineItemNumber	integer	Transaction reference date and time in EPOCH date time format.	–	–	–
			b2bTransactionIdentifierTypeName	string	B2B Transaction Identifier Type Name.	–	–	–
			timeZone	string	Time Zone.	–	–	–
		transactionReferenceInformation	array	Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.(Do not have sample data, kept this based on 315 sample data)	–	L11 for (>=4010) Version N9 (v4010)	–
			transactionReferenceType	string	Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. Valid values include: `BOOKINGIDENTIFIER` - Booking Number `PACKINGLIST` - Packing List Number `PURCHASEOPTIONS` - Purchase Option Agreement `DELIVERYTICKET` - Delivery Ticket Number `HARMONIZED` - Harmonized Code System (USA) `TARIFFIDENTIFIER` - Tariff Number	–	N901 / L1102 = PK (PACKINGLISTIDENTIFIER) or PK (PURCHASEOPTIONS) or DJ (DELIVERYTICKETIDENTIFIER) or HS (HARMONIZED) or TS (TARIFFIDENTIFIER)	–
			transactionReferenceIdentifier	string	Transaction reference identifier value.	–	N902 / L1101	–
			description	string	Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02).	–	N903 / L1103	–
			transactionReferenceDate	string	Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.	–	N904+N905 / L1104	–
			epochTransactionReferenceDate	integer	Transaction reference date and time in EPOCH date time format..	–	–	–
		mpcDates	array	Dates relevant for Shipment Booking Request at header.	–	G62 (v4010) only	–
			dateType	string	Date type at header level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values: `ESTIMATEDDEPARTURE` `ESTIMATEDSAILING` `BOOKINGAUTHORIZATION` `SHIPMENTREQUIRED`	–	G6201	–
			dateValue	string	Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.	–	G6202	–
			epochDateValue	integer	Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.	–	–	–
			dateTimePeriodFormat	string	Code specifying representation of date or time or format presented in date value. Valid vlaues include: `CCYYMMDD` - Date format century year month day, 2 characters each `CCYYMMDDHHMM` - Date format century year month day hour minutes, 2 characters each	–	–	–
			timeZone	string	Time zone for referenced dates	–	G6205	–
			eventTimeType	string	Event Time Type.	–	G6203	–
		loadTenderResponseEquipmentInformation	–	Shipment equipment details.	–	Segment N7(v4010 ) only	–
			equipmentPrefix	string	Prefix or alphabetic part of an equipment unit's identifying number.	–	N701	–
			equipmentIdentifier	string	Sequencing or serial part of an equipment unit's identifying number.	–	N702	–
			carrierCode	string	Carrier code for shipper.	–	N712	–
			shipmentFlashPoint	string	Free-form abbreviation of temperature range or flash-point temperature.	–	N713	–
			equipmentType	string	Type of equipment used in delivery. Valid values include: `CONTAINER` `RAILCAR` `TRAILER` `SHIP` `AIRCRAFT` `TRUCK`	–	N711 = AP (AIRCRAFT) or CN (CONTAINER) or RR (RAILCAR) or TL (TRAILER) or VT (SHIP) or TO (TRUCK)	–
			equipmentTypeISOCode	string	Equipment type ISO code.	–	–	–
			checkDigitIdentifier	number	Equipment check digit number, (Container check digit number).	–	N718	–
			weightUnitType	string	Type of weight recorded. Valid values include: `METRICTON` - Metric ton `GRAMS` - Grams `KILOGRAMS` - Kilograms `POUNDS` - Pounds `OUNCES` - Ounces	–	N717 = E (METRICTON) or G (GRAMS) or K (KILOGRAMS) or L (POUNDS) or M (MEASUREMENTTON) or O (OUNCES) or S (SHORTTON) or T (LONGTON)	–
			weightType	string	Type of weight recorded in shipment. Valid values include: `GROSSWEIGHT` - Gross weight `NETWEIGHT` - Net Weight `SHIPPER` - Shipper's weight `TARE` - Tare weight	–	N704	–
			weightValue	string	Weight of product at delivery header level.	–	N703 in all other cases. N705 where weightType = TARE	–
			tareType	string	Tare Qualifier Code. `ACTUAL` - Actual tare `MARKED` - Marked tare	–	N716 = A (ACTUAL) Or M (MARKED)	–
			tareWeight	number	Tare weight of equipment.	–	N705	–
			volumeType	string	Type of volume recorded. Valid values include: `BARGE` - Volume of barge `CONTAINER` - Volume of container `CUBICCENTIMETERS` - Cubic centimeters `CUBICDECIMETERS` - Cubic decimeters	–	N709	–
			volumeValue	Number	Vessel volume for type.	–	N708	–
			equipmentDimensions	array	Dimensions of freight.	–	–	–
				dimensionsType	string	Type of dimensions recorded for freight. Valid values include: `LENGTH` `WIDTH` `HEIGHT`	–	–	–
				dimensionsValue	Number	Volume for item in inches.	–	N715where dimensionsType = LENGTH N720 where dimensionsType = HEIGHT N721 where dimensionsType = WIDHT	–
				unitOfMeasure	string	Dimension unit of measure for parent packaging.	–	–	–
			itemQuantity	array	Equipment quantity.	–	–	–
				quantityType	string	Type of quantity recorded.	–	–	–
				quantityValue	number	Quantity of product in shipment.	–	–	–
				unitOfMeasure	string	Unit or Basis for Measurement Code. Unit of entry UOM's include `UN` - Unit.	–	–	–
			equipmentSealNumbers	array	Shipment carriying equipments seal numbers.	–	–	–
				sealNumber	string	Applied seal number for shipment carrying equipment.	–	–	–
				sealAppliedEntityType	string	Seal applied entity type code, it could be an organization or location or an individual. Valid values include: `CARRIER` - Carrier applied seal number `SHIPPER` - Shipper applied seal number `CUSTOMS` - Customs department applied seal number `TERMINALOPERATOR` - Terminal operator applied seal number	–	–	–
			shipmentMeasurements		Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights.	–	–	–
				measurementCategory	string	Broad category of measurement to which measurement type belongs to or applies. Valid values include: `ACTUALTOTAL` - Total market sales `MARKETSHARE` - Prediction of apex sales	–	–	–
				measurementType	string	Code identifying a measurement type for a measurement value. Valid values includes: `WEIGHT` - Weight `CELSIUS` - Celsius `FREEZINGPOINT` - Freezing Point	–	–	–
				measurementValue	string	The value of the measurement	–	–	–
				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	–	–	–
				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	–	–	–
		partnerBusinessInformation	array	Partner Entity group location identifiers and address information.	–	–	–
			partnerEntityType	string	Explains the type of the partner entity involved in this business transaction. Valid values include: `SUPPLIER` - Supplier `CUSTOMER` - Buyer `SHIPPER` - Shipper `CARRIER` - Carrier `FREIGHTFORWARDER` - Freight forwarder	–	–	–
			businessName	string	Business name for partner or location.	–	–	–
			additionalBusinessName	string	Additional Business name for partner or location.	–	–	–
			companyLocationPartnerName	string	Additional Location of same Business partner.	–	–	–
			mpcCompanyLocationIdentifierList	array	Identifier list for business party.	–	–	–
				isIdentifierPresentInEvent	boolean	Is identifier present in event boolean.	–	–	–
				companyIdentifierType	string	Company identifier type for business partner.	–	–	–
				companyIdentifierValue	string	Company identifier value for business partner.	–	–	–
				alternateCompanyLocationIdentifierValue	string	Alternate company location identifier value.	–	–	–
			address	–	Party address information.	–	–	–
				address1	string	Main street address.	–	–	–
				address2	string	Supplemental street address.	–	–	–
				city	string	City	–	–	–
				district	string	District	–	–	–
				state	string	State or region code.	–	–	–
				postalCode	string	Postal code	–	–	–
				country	string	Country code	–	–	–
				telephone	string	Telephone number.	–	–	–
				fax	string	Fax number	–	–	–
				url	string	Website URL	–	–	–
				buildingNumber	string	Building number	–	–	–
				plantNumber	string	Plant number	–	–	–
				floorNumber	string	Floor number in building.	–	–	–
				lscAddressIdentifier	string	LSC address identifier.	–	–	–
				village	string	Village name	–	–	–
				houseNumber	string	House number	–	–	–
				township	string	Township	–	–	–
				premisesCode	string	Premises code	–	–	–
			companyLocationContactInformation	–	–	–	–	–
				contactType	string	Contact type. Valid values include: `INFORMATION` - Information contact `FORWARDER` - Forwarder contact `CONFIRMEDWITH` - Person whom the content of the PO has been discussed and agreed prior to sending this message. `EMERGENCYDANGEROUS` - Emergency dangerous goods contact `SENDER` - Message sender contact	–	–	–
				contactName	string	Contact name	–	–	–
				contactTitle	string	Title of contact	–	–	–
				contactPhone	string	Contact phone number.	–	–	–
				contactEmail	string	Contact email address.	–	–	–
			mpcAdditionalAddressInformation	–	Additional address information that is not included in addressTypeDefinition.	–	–	–
				externalERPUserName	string	External ERP system user name for user who generated message.	–	–	–
				organizationCode	string	Code for organization responsible for generating the message.	–	–	–
				organizationDescription	string	Description of the organization responsible for generating the message.	–	–	–
				groupCode	string	Code identifying group responsible for generating the message.	–	–	–
				language	string	Language key for message.	–	–	–
				languageCode	string	ISO language code for message.	–	–	–
				referenceIdentifier	string	Partner reference identifier.	–	–	–
				orderType	string	Order Type.	–	–	–
				address3	string	Additional address information that is not included in addressTypeDefinition.	–	–	–
				postalArea	string	Postal Area.	–	–	–
				timeZone	string	Time zone for referenced dates.	–	–	–
				telephone	string	Telephone Number	–	–	–
				emailAddress	string	Email Address	–	–	–
				vatRegistrationNumber	string	Vat Registration Number	–	–	–
				taxExemptCode	string	Tax exempt Code	–	–	–
				locationType	string	Business Partner Location Type.	–	–	–
				locationIdentifier	string	Business Partner location Identifier.	–	–	–
				countrySubDivisionCode	string	Describes the country subdivision.	–	–	–
		freeTextNote	array	Ship to party company identifiers and address information.	–	Segment K1 (v4010 only)	–
			textReferenceCode	string	Text reference or subject code.	–	–	–
			textFunctionCode	string	Text function code.	–	–	–
			language	string	Language of free text.	–	–	–
			textFormatCode	string	Format code for free text.	–	–	–
			freeText	string	Free test string.	–	K101, K102 Each is 30 characters. Mapping to canonical, concatenate K1 and K2. Mapping from canonical split into 2 fields.	–
		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.	–	–	–
	canonicalLoadTenderResponseEventDetails	array	To report events occurred during ocean, rail, air shipments.	–	V9 (v4010 only)	–
		shipmentEventType	string	Code to specify type of the ocean shipment event. Valid values include: `ANTICIPATEDPICKUP` - Anticipated Pickup `VESSELARRIVAL` - Vessel Arrival `VESSELDEPARTURE` - Vessel Departure `UNLOADEDFROMVESSEL` - Unloaded From Vessel `LOADEDONVESSEL` - Actually Loaded on Vessel `FINALDESTINATIONACTUALARRIVALDATE` - Actual Arrival Date at Final Destination	–	V901 = APU (Anticipated Pickup) Or VAR (Vessel Arrival) Or VDP (Vessel Departure) Or UFV (Unloaded From Vessel) Or ALV (Actually Loaded on Vessel) Or ARD (Actual Arrival Date at Final Destination)	–
		eventName	string	Event descriptive information.	–	V902	–
		transportEventTimeStamp	string	Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.	–	V903 & V904	–
		epochTransportEventTimeStamp	integer	Event date and time in epoch format.	–	–	–
		timeZone	string	Time zone code.	–	V913	–
		city	string	Event city	–	V905	–
		state	string	State code	–	V906	–
		countryCode	string	Event Country code.	–	V907	–
		transactionStatusReasonCode	string	Reason indicating why a shipment status code was transmitted. Valid values included: `CONTAINERDELAY` - Import Container Delay `INCORRECTADDRESS` - Incorrect Address `CONSIGNEEREFUSED` - Refused by Consignee `DAMAGEDDELIVERYNOTCOMPLETED` - Damaged - Delivery Not Completed	–	V908 = 052 (CONTAINERDELAY) Or A03 (INCORRECTADDRESS) Or A07 (CONSIGNEEREFUSED) Or A10 (DAMAGEDDELIVERYNOTCOMPLETED) Or	–
		longitudeCoordinate	string	Longitude coordination.	–	–	–
		latitudeCoordinate	string	Latitude coordination.	–	–	–
		directionIndicator	string	Coordination direction.	–	–	–
		equipmentTypeTemperatures		Equipment type and its required temperatures.	–	–	–
			equipmentType	string	Type of equipment used in delivery. Valid values include: `CONTAINER` `RAILCAR` `TRAILER` `SHIP` `AIRCRAFT` `TRUCK`	–	–	–
			temperatureType	string	Type of temperature follow while shipment. Valid values: `STORAGE` - Storage temperature `TRANSPORT` - Transport temperature `CARGO` - Cargo operation temperature `EMERGENCY` - Transport emergency temperature `TRANSPORTCONTROL` - Transport control temperature `TEMPERATURECORDED` - Recorded temperature	–	–	–
			transportEventTimeStamp	string	Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.	–	–	–
			temperatureSetpoint	number	Temperature value setting expressed in degrees.	–	–	–
			temperatureScale	string	Temperature unit of measure, `CELSIUS` - Degree, Celsius `FAHRENHEIT` - Degree, Fahrenheit `KELVIN` - Degree Celsius per kelvin	–	–	–
			rangeType	string	Type of range Valid values: `TEMPERATURE` - Item temperature range `TRANSPORTTEMPERATURE` - Transport temperature range	–	–	–
			minTemperature	number	Equipment minimum allowable temperature.	–	–	–
			maxTemperature	number	Equipment maximum allowable temperature.	–	–	–
			ventSetting	string	To specifying equipment vent adjustment code. Valid values: `OPEN25PERCENT` - Vent 25% Open `OPEN50PERCENT` - Vent 50% Open `OPEN75PERCENT` - Vent 75% Open `OPEN100PERCENT` - Vent 100% Open `OPEN10PERCENT` - Vent 10% Open `CLOSED` - Vent should be in closed position. `CARRIERSET` - Carrier to set based on commodity type	–	–	–
			description	string	Descriptive information about environment required in refrigerated container when other then normal air required.	–	–	–
			humidityPercent	number	Percent in integer format , example: 50% required, in 50.	–	–	–
			supplyTemperature	number	The temperature of the air coming into the container.	–	–	–
			returnTemperature	number	The temperature of the air leaving the container.	–	–	–
			co2Setpoint	number	The designated CO2 atmosphere level for transporting your cargo.	–	–	–
			co2Reading	number	The CO2 atmosphere level.	–	–	–
			o2Setpoint	number	The designated O2 atmosphere level for transporting your cargo.	–	–	–
			o2Reading	number	The O2 atmosphere level.	–	–	–
			relativeHumidity	number	The relative humidity.	–	–	–
			humiditySetpoint	number	The designated humidity level for transporting your cargo.	–	–	–
			pulpLocation1Temperature	number	One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container.	–	–	–
			pulpLocation2Temperature	number	One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container.	–	–	–
			pulpLocation3Temperature	number	One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container.	–	–	–
	customFields	array	Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level.	–	–	–
		name	string	Name of mapped field.	–	–	–
		value	string	Value in named field.	–	–	–

Canonical Element

–

JSon object type/root element.

–

controlFileHeader

–

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

–

canonicalCarrierLoadTenderResponse

–

Overall details for the load tender response message canonical.

–

Segment B1

–

processingFunctionTypeCode

string

Processing function, transaction set purpose code.

Valid values include:

CREATE
CHANGE
CANCEL
ORIGINAL
REPLACE
STATUS
CONFIRM

–

carrierCode

string

Shipping carrier alpha code (SCAC).

–

B101

–

shipmentBookingStatus

string

Code specifying status of the booking request.

Valid values include: True

CONFIRMED - Booking request accepted
CONDITIONAL - Conditionally accepted
ALTERNATIVEOFFER - Counter proposal made by carrier with different options
CANCELLED - Reservation canceled
REJECTED - Reservation declined before its confirmation
RECEIVED - New request received

–

B104

–

isPartialLoad

boolean

Code specifying partial load allowed.

Valid values:

- Partial load allowed
False - Partial load not allowed.

–

B105 =

Y (true) Or
N (false)

–

bookingDeclineReasonCode

string

Code specifying reason behind booking cancel by carrier or customer

valid values include:

CAPACITYTYPE - Carrier cannot accept because the type of requested space/capacity isn’t offered
CAPACITY - Carrier offers that capacity type, but it’s currently full/ un available
EQUIPMENTTYPE - The requested equipment type isn’t supported.
EQUIPMENT - The equipment is unavailable

–

B106

–

shipmentChargePaymentMethodType

string

Payment terms for transportation charges.

Valid values:

COLLECT
PREPAIDSELLER
SELLER
THIRDPARTYPAY
ADVANCECOLLECT
ADVANCEPREPAID
BUYER
BUYERSELLERDEFINED

–

B107 =

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

–

transactionReferenceIdentifierList

array

List of documents and transactions((Do not have sample data, kept this based on 315 sample data) at the header level of the message.

–

L11 for(>=4010) Version N9 (v4010) & B1

–

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:

LOADTENDERRESPONSE (Required) - Transaction unique indentifier
CONSIGNEEORDERIDENTIFIER - Conginees order number
PURCHASEORDER - Purchase Order Number
BOL - Bill of Lading Number
PURCHASEORDER - Purchase Order Number
SUPPLIERORDER - Vendor order number
MASTERBOL - Master BOL
AGENTSHIPMENT - Agent shipment number
CARRIERREFERENCE - Carrier reference number

–

N901 / L1102 =

BM (BOL) Or
CT (CONTRACT) Or
PO (PURCHASEORDER) Or
VN (SUPPLIERORDER) Or
SI (SHIPMENT) Or
MB (MASTERBOL) Or
AG (AGENTSHIPMENT) Or
CN (CARRIERREFERENCE) Or

–

b2bTransactionIdentifierValue

string

Transaction reference identifier value.

–

B102 when b2bTransactionIdentifierType =BOL or LOADTENDERRESPONSE N902 / L1101 for remaining qualifiers in b2bTransactionIdentifierType

–

transactionDate

string

Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

–

B103 (Date)b2bTransactionIdentifierType =LOADTENDERRESPONSE N904+N905 / L1104 for remaining qualifiers in b2bTransactionIdentifierType

–

epochTransactionDate

string

Transaction reference date and time, if time available, in epoch date format.

–

lineItemNumber

integer

Transaction reference date and time in EPOCH date time format.

–

b2bTransactionIdentifierTypeName

string

B2B Transaction Identifier Type Name.

–

timeZone

string

Time Zone.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents.

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.(Do not have sample data, kept this based on 315 sample data)

–

L11 for (>=4010) Version N9 (v4010)

–

transactionReferenceType

string

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

Valid values include:

BOOKINGIDENTIFIER - Booking Number
PACKINGLIST - Packing List Number
PURCHASEOPTIONS - Purchase Option Agreement
DELIVERYTICKET - Delivery Ticket Number
HARMONIZED - Harmonized Code System (USA)
TARIFFIDENTIFIER - Tariff Number

–

N901 / L1102 =

PK (PACKINGLISTIDENTIFIER) or
PK (PURCHASEOPTIONS) or
DJ (DELIVERYTICKETIDENTIFIER) or
HS (HARMONIZED) or
TS (TARIFFIDENTIFIER)

–

transactionReferenceIdentifier

string

Transaction reference identifier value.

–

N902 / L1101

–

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02).

–

N903 / L1103

–

transactionReferenceDate

string

Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

–

N904+N905 / L1104

–

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format..

–

mpcDates

array

Dates relevant for Shipment Booking Request at header.

–

G62 (v4010) only

–

dateType

string

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

Valid values:

ESTIMATEDDEPARTURE
ESTIMATEDSAILING
BOOKINGAUTHORIZATION
SHIPMENTREQUIRED

–

G6201

–

dateValue

string

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

–

G6202

–

epochDateValue

integer

Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit.

–

dateTimePeriodFormat

string

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

Valid vlaues include:

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

–

timeZone

string

Time zone for referenced dates

–

G6205

–

eventTimeType

string

Event Time Type.

–

G6203

–

loadTenderResponseEquipmentInformation

–

Shipment equipment details.

–

Segment N7(v4010 ) only

–

equipmentPrefix

string

Prefix or alphabetic part of an equipment unit's identifying number.

–

N701

–

equipmentIdentifier

string

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

–

N702

–

carrierCode

string

Carrier code for shipper.

–

N712

–

shipmentFlashPoint

string

Free-form abbreviation of temperature range or flash-point temperature.

–

N713

–

equipmentType

string

Type of equipment used in delivery.

Valid values include:

CONTAINER
RAILCAR
TRAILER
SHIP
AIRCRAFT
TRUCK

–

N711 =

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

–

equipmentTypeISOCode

string

Equipment type ISO code.

–

checkDigitIdentifier

number

Equipment check digit number, (Container check digit number).

–

N718

–

weightUnitType

string

Type of weight recorded.

Valid values include:

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

–

N717 =

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

–

weightType

string

Type of weight recorded in shipment.

Valid values include:

GROSSWEIGHT - Gross weight
NETWEIGHT - Net Weight
SHIPPER - Shipper's weight
TARE - Tare weight

–

N704

–

weightValue

string

Weight of product at delivery header level.

–

N703 in all other cases. N705 where weightType = TARE

–

tareType

string

Tare Qualifier Code.

ACTUAL - Actual tare
MARKED - Marked tare

–

N716 =

A (ACTUAL) Or
M (MARKED)

–

tareWeight

number

Tare weight of equipment.

–

N705

–

volumeType

string

Type of volume recorded.

Valid values include:

BARGE - Volume of barge
CONTAINER - Volume of container
CUBICCENTIMETERS - Cubic centimeters
CUBICDECIMETERS - Cubic decimeters

–

N709

–

volumeValue

Number

Vessel volume for type.

–

N708

–

equipmentDimensions

array

Dimensions of freight.

–

dimensionsType

string

Type of dimensions recorded for freight.

Valid values include:

LENGTH
WIDTH
HEIGHT

–

dimensionsValue

Number

Volume for item in inches.

–

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

–

unitOfMeasure

string

Dimension unit of measure for parent packaging.

–

itemQuantity

array

Equipment quantity.

–

quantityType

string

Type of quantity recorded.

–

quantityValue

number

Quantity of product in shipment.

–

unitOfMeasure

string

Unit or Basis for Measurement Code.

Unit of entry UOM's include UN - Unit.

–

equipmentSealNumbers

array

Shipment carriying equipments seal numbers.

–

sealNumber

string

Applied seal number for shipment carrying equipment.

–

sealAppliedEntityType

string

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

Valid values include:

CARRIER - Carrier applied seal number
SHIPPER - Shipper applied seal number
CUSTOMS - Customs department applied seal number
TERMINALOPERATOR - Terminal operator applied seal number

–

shipmentMeasurements

Specifies physical measurements for shipment, including weights, dimensions, tolerances, variances, and weights.

–

measurementCategory

string

Broad category of measurement to which measurement type belongs to or applies.

Valid values include:

ACTUALTOTAL - Total market sales
MARKETSHARE - Prediction of apex sales

–

measurementType

string

Code identifying a measurement type for a measurement value.

Valid values includes:

WEIGHT - Weight
CELSIUS - Celsius
FREEZINGPOINT - Freezing Point

–

measurementValue

string

The value of the measurement

–

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

–

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

–

partnerBusinessInformation

array

Partner Entity group location identifiers and address information.

–

partnerEntityType

string

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

Valid values include:

SUPPLIER - Supplier
CUSTOMER - Buyer
SHIPPER - Shipper
CARRIER - Carrier
FREIGHTFORWARDER - Freight forwarder

–

businessName

string

Business name for partner or location.

–

additionalBusinessName

string

Additional Business name for partner or location.

–

companyLocationPartnerName

string

Additional Location of same Business partner.

–

mpcCompanyLocationIdentifierList

array

Identifier list for business party.

–

isIdentifierPresentInEvent

boolean

Is identifier present in event boolean.

–

companyIdentifierType

string

Company identifier type for business partner.

–

companyIdentifierValue

string

Company identifier value for business partner.

–

alternateCompanyLocationIdentifierValue

string

Alternate company location identifier value.

–

address

–

Party address information.

–

address1

string

Main street address.

–

address2

string

Supplemental street address.

–

city

string

City

–

district

string

District

–

state

string

State or region code.

–

postalCode

string

Postal code

–

country

string

Country code

–

telephone

string

Telephone number.

–

fax

string

Fax number

–

url

string

Website URL

–

buildingNumber

string

Building number

–

plantNumber

string

Plant number

–

floorNumber

string

Floor number in building.

–

lscAddressIdentifier

string

LSC address identifier.

–

village

string

Village name

–

houseNumber

string

House number

–

township

string

Township

–

premisesCode

string

Premises code

–

companyLocationContactInformation

–

contactType

string

Contact type.

Valid values include:

INFORMATION - Information contact
FORWARDER - Forwarder contact
CONFIRMEDWITH - Person whom the content of the PO has been discussed and agreed prior to sending this message.
EMERGENCYDANGEROUS - Emergency dangerous goods contact
SENDER - Message sender contact

–

contactName

string

Contact name

–

contactTitle

string

Title of contact

–

contactPhone

string

Contact phone number.

–

contactEmail

string

Contact email address.

–

mpcAdditionalAddressInformation

–

Additional address information that is not included in addressTypeDefinition.

–

externalERPUserName

string

External ERP system user name for user who generated message.

–

organizationCode

string

Code for organization responsible for generating the message.

–

organizationDescription

string

Description of the organization responsible for generating the message.

–

groupCode

string

Code identifying group responsible for generating the message.

–

language

string

Language key for message.

–

languageCode

string

ISO language code for message.

–

referenceIdentifier

string

Partner reference identifier.

–

orderType

string

Order Type.

–

address3

string

Additional address information that is not included in addressTypeDefinition.

–

postalArea

string

Postal Area.

–

timeZone

string

Time zone for referenced dates.

–

telephone

string

Telephone Number

–

emailAddress

string

Email Address

–

vatRegistrationNumber

string

Vat Registration Number

–

taxExemptCode

string

Tax exempt Code

–

locationType

string

Business Partner Location Type.

–

locationIdentifier

string

Business Partner location Identifier.

–

countrySubDivisionCode

string

Describes the country subdivision.

–

freeTextNote

array

Ship to party company identifiers and address information.

–

Segment K1 (v4010 only)

–

textReferenceCode

string

Text reference or subject code.

–

textFunctionCode

string

Text function code.

–

language

string

Language of free text.

–

textFormatCode

string

Format code for free text.

–

freeText

string

Free test string.

–

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

–

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.

–

canonicalLoadTenderResponseEventDetails

array

To report events occurred during ocean, rail, air shipments.

–

V9 (v4010 only)

–

shipmentEventType

string

Code to specify type of the ocean shipment event.

Valid values include:

ANTICIPATEDPICKUP - Anticipated Pickup
VESSELARRIVAL - Vessel Arrival
VESSELDEPARTURE - Vessel Departure
UNLOADEDFROMVESSEL - Unloaded From Vessel
LOADEDONVESSEL - Actually Loaded on Vessel
FINALDESTINATIONACTUALARRIVALDATE - Actual Arrival Date at Final Destination

–

V901 =

APU (Anticipated Pickup) Or
VAR (Vessel Arrival) Or
VDP (Vessel Departure) Or
UFV (Unloaded From Vessel) Or
ALV (Actually Loaded on Vessel) Or
ARD (Actual Arrival Date at Final Destination)

–

eventName

string

Event descriptive information.

–

V902

–

transportEventTimeStamp

string

Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

–

V903 & V904

–

epochTransportEventTimeStamp

integer

Event date and time in epoch format.

–

timeZone

string

Time zone code.

–

V913

–

city

string

Event city

–

V905

–

state

string

State code

–

V906

–

countryCode

string

Event Country code.

–

V907

–

transactionStatusReasonCode

string

Reason indicating why a shipment status code was transmitted.

Valid values included:

CONTAINERDELAY - Import Container Delay
INCORRECTADDRESS - Incorrect Address
CONSIGNEEREFUSED - Refused by Consignee
DAMAGEDDELIVERYNOTCOMPLETED - Damaged - Delivery Not Completed

–

V908 =

052 (CONTAINERDELAY) Or
A03 (INCORRECTADDRESS) Or
A07 (CONSIGNEEREFUSED) Or
A10 (DAMAGEDDELIVERYNOTCOMPLETED) Or

–

longitudeCoordinate

string

Longitude coordination.

–

latitudeCoordinate

string

Latitude coordination.

–

directionIndicator

string

Coordination direction.

–

equipmentTypeTemperatures

Equipment type and its required temperatures.

–

equipmentType

string

Type of equipment used in delivery.

Valid values include:

CONTAINER
RAILCAR
TRAILER
SHIP
AIRCRAFT
TRUCK

–

temperatureType

string

Type of temperature follow while shipment.

Valid values:

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

–

transportEventTimeStamp

string

Event date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

–

temperatureSetpoint

number

Temperature value setting expressed in degrees.

–

temperatureScale

string

Temperature unit of measure,

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

–

rangeType

string

Type of range

Valid values:

TEMPERATURE - Item temperature range
TRANSPORTTEMPERATURE - Transport temperature range

–

minTemperature

number

Equipment minimum allowable temperature.

–

maxTemperature

number

Equipment maximum allowable temperature.

–

ventSetting

string

To specifying equipment vent adjustment code.

Valid values:

OPEN25PERCENT - Vent 25% Open
OPEN50PERCENT - Vent 50% Open
OPEN75PERCENT - Vent 75% Open
OPEN100PERCENT - Vent 100% Open
OPEN10PERCENT - Vent 10% Open
CLOSED - Vent should be in closed position.
CARRIERSET - Carrier to set based on commodity type

–

description

string

Descriptive information about environment required in refrigerated container when other then normal air required.

–

humidityPercent

number

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

–

supplyTemperature

number

The temperature of the air coming into the container.

–

returnTemperature

number

The temperature of the air leaving the container.

–

co2Setpoint

number

The designated CO2 atmosphere level for transporting your cargo.

–

co2Reading

number

The CO2 atmosphere level.

–

o2Setpoint

number

The designated O2 atmosphere level for transporting your cargo.

–

o2Reading

number

The O2 atmosphere level.

–

relativeHumidity

number

The relative humidity.

–

humiditySetpoint

number

The designated humidity level for transporting your cargo.

–

pulpLocation1Temperature

number

One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container.

–

pulpLocation2Temperature

number

One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container.

–

pulpLocation3Temperature

number

One of the three cargo probes are inserted into the pulp of the cargo in three specific locations of the container.

–

customFields

array

Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level.

–

name

string

Name of mapped field.

–

value

string

Value in named field.

–

Load tender response canonical guidelines

Table of contents

Table of contents

Load tender response canonical guidelines

Table of contents

Table of contents

Related Content

Load tender responses

Motor carrier load tenders

Forecast plan response (IDoc)

Cookie Settings