INTTRA External Mappings

The following INTTRA External Mappings are supported.

TM Entity Type

TM Entity Column

INTTRA Field

Notes:

Carrier

CARR_CD

CargoMovementType

The movement type of the Carrier. Valid values are: “FCL/FCL”, “FCL/LCL”.

  • FCL/FCL: Full Container Load
  • FCL/LCL: Less than Container Load

Carrier

CARR_CD

ChargeType

Only used if Carrier requires Prepaid or Collect Information. Valid values are:

AdditionalCharges

OceanFreight

DestinationHaulageCharges

DestinationTerminalHandling

OriginHaulageCharges

OriginTerminalHandling

Carrier

CARR_CD

City

Only used if Carrier requires Prepaid or Collect Information. The city in which the Carrier’s charges are paid.

Carrier

CARR_CD

INTTRACompanyID

The INTTRA Company Identifier for the Carrier. Must be specified for all Carriers to be integrated with INTTRA.

Note: INTTRACompanyID is used to identify Carriers in the INTTRA system. In cases when there is no INTTRACompanyID for a Carrier, then the Blue Yonder SCAC for that Carrier should be set to the INTTRA Partner Alias. INTTRA Partner Aliases must be configured in the INTTRA system.

Carrier

CARR_CD

Name

Only used if Carrier requires Prepaid or Collect Information. The name of the location at which the Carrier’s charges are paid.

Carrier

CARR_CD

PrepaidorCollectIndicator

Only used if Carrier requires Prepaid or Collect Information. Valid values are:

Collect

PrePaid

ThirdParty

Carrier

CARR_CD

State

Only used if Carrier requires Prepaid or Collect Information. The state in which the Carrier’s charges are paid.

Carrier

CARR_CD

UNLOCODE

Only used if Carrier requires Prepaid or Collect Information. The UN/LOCODE of the location at which the Carrier’s charges are paid.

Commodity

CDTY_CD

AggregationState

For hazardous commodities, the aggregate state. Valid values are:

Solid

Liquid

Gas

Commodity

CDTY_CD

EMSNumber

For hazardous commodities, the EMS Number which identifies the emergency procedures.

Commodity

CDTY_CD

EmptyUncleanedReceptacle

For hazardous commodities, specifies an empty uncleaned receptacle is requested. Valid values are: “true”

If it is not requested, do not specify the mapping for the commodity.

Commodity

CDTY_CD

EquipmentTemperature

For temperature controlled commodities, the temperature the container should be maintained at, expressed in system temperature UOM. Must be 3 digits. Prepend with 0s if necessary.

Note: If temperature setting is provided, then the equipment type must be a refrigerated equipment type in the INTTRA system.

Commodity

CDTY_CD

GeneralHazmatComments

For hazardous commodities, any general comments or additional information.

Commodity

CDTY_CD

HazardCodeVersionNumber

For hazardous commodities, the applicable Dangerous Goods Regulations version number of the hazard substance/item/page number.

Commodity

CDTY_CD

HazardousGoodsAcidConcentrtn

For hazardous commodities, the acid concentration, expressed as the percentage of Acid vs. Water.

Commodity

CDTY_CD

HazardousGoodsRadioactivity

For hazardous commodities, the radioactivity measurement, expressed in MegaBecquerels.

Commodity

CDTY_CD

HazmatPlacardInformation

For hazardous commodities, the Haz Mat Placard (explosive, flammable, etc.)

Commodity

CDTY_CD

IMDGPageNumber

For hazardous commodities, the hazard substance/item/page number.

Commodity

CDTY_CD

InhalantHazard

For hazardous commodities, specifies that the commodity is an inhalant hazard. Valid values are: “true”.

If it is not an inhalant hazard, do not specify the mapping for the commodity.

Commodity

CDTY_CD

IntermedBulkContainerCode

For hazardous commodities, the IBC Code (intermediate bulk container code)

Commodity

CDTY_CD

MarinePollutantStatus

For hazardous commodities, the marine pollutant status. Valid values are:

MarinePollutant

NotMarinePollutant

SevereMarinePollutant

Commodity

CDTY_CD

NatureOfCargo

If the commodity requires special handling, the type of handling required. Valid values are:

EnvironmentalPollutant

NonContainerized

Note: Commodities may also be "Hazardous" and "TemperatureControlled". These are determined based on the TM Commodity properties, not a NatureOfCargo mapping

Commodity

CDTY_CD

PackageTypeCode

The commodity’s packaging information in coded form.

Two-character UN/ECE recommendation 21, revision 4 package codes.

If either PackageTypeCode or PackageTypeDescription is mapped, the number of packages will be communicated to INTTRA.

Commodity

CDTY_CD

PackageTypeDescription

The commodity’s packaging description.

Description of the form in which goods are presented.

If either PackageTypeCode or PackageTypeDescription is mapped, the number of packages will be communicated to INTTRA.

Commodity

CDTY_CD

RadioactiveGoodsAdditionalInstructions

For hazardous commodities, additional information related to radioactive goods.

Commodity

CDTY_CD

RegulatoryInformation

For hazardous commodities, regulatory information for authorities.

Commodity

CDTY_CD

TransportInLimitedQuantities

For hazardous commodities, specifies that the commodity should be transported in limited quantities. Valid values are: “true”.

If the commodity does not need to be transported in limited quantities, do not specify the mapping for the commodity.

Commodity

CDTY_CD

TremCardNumber

For hazardous commodities, the identifier of a transport emergency card giving advice for emergency actions.

Commodity

CDTY_CD

USHTS

The commodity classification. INTTRA recommends that customers use 6-character classification codes from the World Customs Organization (WCO) Harmonized System (HS) Schedule.

Country

CTRY_CD

CustomsDeclarationInformationType

When customs declaration information is provided for an origin country, the type of the information. Valid values are: “CCN”, “UCR”

CCN: Canadian Cargo Control Number

UCR: Customs Export Declaration Unique Consignment Reference

The customs declaration information number is provided as a reference number on the booking, where the reference number type is mapped to the same CustomsDeclarationInformationType.

Note: The Customs Declaration Information can be mapped to reference numbers at the booking level or at the shipment level. When the information is sent to INTTRA, CustomsDeclarationInformationType at the header level is pulled from booking reference numbers, while CustomsDeclarationInformationType at the GoodsDetails section is pulled from shipment reference numbers. For customers configuring customs declaration information, mapping should be configured at only one of these two levels (booking or shipment reference numbers). INTTRA will not accept customs declaration information at both levels.

Country

CTRY_CD

ExportLicense

The export license for an origin country.

Country

CTRY_CD

ExportLicenseExpiryDate

The expiration date for the export license for an origin country.

Country

CTRY_CD

ExportLicenseIssueDate

The issue date for the export license for an origin country.

Division

DIV_CD

INTTRACompanyID

If INTTRA information for Booker and Shipper parties is different, the Shipper Party INTTRA Company ID for the division. Otherwise the value at the Logistics Group or Shipping Location or Global Defaults level (in this order of priority) will be used for both Booker and Shipper parties.

Division

DIV_CD

InformationContact

If INTTRA information for Booker and Shipper parties is different, the Shipper Party Information Contact name for the division. Otherwise the value at the Logistics Group or Shipping Location or Global Defaults level (in this order of priority) will be used for both Booker and Shipper parties.

Division

DIV_CD

InformationContactFax

If INTTRA information for Booker and Shipper parties is different, the Shipper Party Information Contact fax number for the division. Otherwise the value at the Logistics Group or Shipping Location or Global Defaults level (in this order of priority) will be used for both Booker and Shipper parties.

Division

DIV_CD

InformationContactPhone

If INTTRA information for Booker and Shipper parties is different, the Shipper Party Information Contact phone number for the division. Otherwise the value at the Logistics Group or Shipping Location or Global Defaults level (in this order of priority) will be used for both Booker and Shipper parties.

Domain Table / Transit Mode

45

TransportMode

The INTTRA Transport Mode equivalent of this TM Transit Mode. Used to override the default mappings provided by the system. Valid values are:

InlandWaterTransport

MaritimeTransport

Rail/RoadTransport

Rail/WaterTransport

RailTransport

Road/WaterTransport

RoadTransport

Note: Set Supplemental ID to TM Transit Mode VAL_CD values, which identifies the TM Transit Mode Domain Table.

Note: The system TM Transit Mode VAL_CD values (and default mapping) are:

AIR

RAIL (RailTransport)

ROAD (RoadTransport)

MARINE (MarineTransport)

PARCEL

Truckload (RoadTransport)

LTL

Intermodal (Rail/WaterTransport)

UserDefined1

UserDefined2

UserDefined3

UserDefined4

UserDefined5

UserDefined6

UserDefined7

UserDefined8

UserDefined9

Equipment Type

EQMT_TYP_CD

EquipmentSupplier

The supplier of the equipment (container). Valid values are:

CarrierSupplied

ShipperSupplied

Note: ShipperSupplied is defaulted if no mapping exists for an Equipment Type.

Equipment Type EQMT_TYP_CD EquipmentTemperature For temperature controlled equipments, the temperature the equipment should be maintained at, expressed in system temperature UOM. Applicable only if EquipmentTemperature is not specified for Commodity and NonActiveReefer specified for the EquipmentType is not true

Equipment Type

EQMT_TYP_CD

EquipmentTypeCode

The INTTRA Equipment Type Code for the TM Equipment Type. INTTRA requires ISO Container Group codes and ISO Container

Type codes. See INTTRA documentation for a list of supported ISO Container Group Type codes.

Equipment Type

EQMT_TYP_CD

FullEmptyIndicator

Whether the equipment (container) is full or empty when shipped. Valid values are:

Empty

Full

Equipment Type EQMT_TYP_CD NonActiveReefer If true, the information will be included in all communication with INTTRA. Applicable only if EquipmentTemperature is not specified for Commodity.

Global Defaults

-

EDIID

The EDI ID of the Sender of INTTRA messages (generally the customer EDI ID)

Global Defaults

-

GeneralInformation

INTTRA supports a general information tag in booking request and booking amendment messages. If specified, the information will be included in all communication with INTTRA.

Global Defaults

-

INTTRACompanyID

The Booker/Shipper Party INTTRA Company ID. If Division or Logistics Group or Shipping Locations level INTTRA Company ID is not provided, this value will be used for both Booker and Shipper parties.

Global Defaults

-

InformationContact

The Booker/Shipper Party Information Contact name. If Division or Logistics Group or Shipping Locations level INTTRA Company ID is not provided, this value will be used for both Booker and Shipper parties.

Global Defaults

-

InformationContactFax

The Booker/Shipper Party Information Contact fax number. If Division or Logistics Group or Shipping Locations level INTTRA Company ID is not provided, this value will be used for both Booker and Shipper parties.

Global Defaults

-

InformationContactPhone

The Booker/Shipper Party Information Contact phone number. If Division or Logistics Group or Shipping Locations level INTTRA Company ID is not provided, this value will be used for both Booker and Shipper parties.

Global Defaults

-

PerContainerReleaseNbrReqst

Customers can request Carriers for Per Container Release Handling, i.e., that a unique release number should be issued for each requested container, preferably under a single booking number. To request this, specify this setting. Valid values are: “true”.

If Per Container Release Handling is not required, do not specify the External Mapping.

Logistics Group LGST_GRP_CD CityName City Name for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD CountryCode Country Code for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD CountryName Country Name for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD InformationContact Information Contact for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD InformationContactFax Information Contact Fax for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD InformationContactPhone Information Contact Phone for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD INTTRACompanyID INTTRA Company ID for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD Name Name for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD PostalCode Postal Code for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD StreetAddress Street Address for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.
Logistics Group LGST_GRP_CD Subdivision State code for Booker and Shipper Information. Used in Booker Information if specified. Used in Shipper Information if specified and information not available from Division.

Reference Number Type

RFRC_NUM_TYP

ReferenceInformation

TM Reference Numbers can be mapped to INTTRA Reference Information. When mapped, the value of the reference number will be passed to INTTRA. This External Mapping specifies the Reference Information type mapping. See the Reference Information Mapping table for more information.

Reference Number Type

RFRC_NUM_TYP

CustomsDeclarationInformationType

If the TM reference number contains Customs Declaration Information, specify the type of information. If specified, the reference number value will be passed as the value of the Customs Declaration Information. Valid values are: “CCN”, “UCR”.

CCN: Canadian Cargo Control Number

UCR: Customs Export Declaration Unique Consignment Reference

Note: The origin country must specify a matching Customs Declaration Information Type.

Service Exception Code

SEC_CD

AmendmentJustification

Used to map tender update reason codes to INTTRA amendment justifications. When a tender update is communicated to INTTRA, this specifies the amendment justification text to send with the update.

Shipping Location SHPG_LOC_CD AddressOverride Supported values are Booker/Shipper/Both. Used to override the Booker and Shipper information derived from the Origin Location of the Booking’s Shipment.
Shipping Location SHPG_LOC_CD CityName Ignored if AddressOverride is not one of Booker or Shipper or Both. Otherwise, overrides the City Name derived from the Origin Location of the Booking’s Shipment in Booker/Shipper Information.
Shipping Location SHPG_LOC_CD CountryCode Ignored if AddressOverride is not one of Booker or Shipper or Both. Otherwise, overrides the Country Code derived from the Origin Location of the Booking’s Shipment in Booker/Shipper Information.
Shipping Location SHPG_LOC_CD CountryName Ignored if AddressOverride is not one of Booker or Shipper or Both. Otherwise, overrides the Country Name derived from the Origin Location of the Booking’s Shipment in Booker/Shipper Information.

Shipping Location

SHPG_LOC_CD

CYDateOffset

The number of hours prior to a time table entry’s departure date to set the Container Yard Date/Time. This value is used when the INTTRA Ocean Schedule Import job type creates new time table entries. The value should be a valid decimal number.

Shipping Location SHPG_LOC_CD InformationContact Information Contact for Booker and Shipper Information. Used in Booker Information if specified and information not available from Logistics Group. Used in Shipper Information if specified and information not available from Logistics Group or Division.
Shipping Location SHPG_LOC_CD InformationContactFax Information Contact Fax for Booker and Shipper Information. Used in Booker Information if specified and information not available from Logistics Group. Used in Shipper Information if specified and information not available from Logistics Group or Division.
Shipping Location SHPG_LOC_CD InformationContactPhone Information Contact Phone for Booker and Shipper Information. Used in Booker Information if specified and information not available from Logistics Group. Used in Shipper Information if specified and information not available from Logistics Group or Division.
Shipping Location SHPG_LOC_CD INTTRACompanyID INTTRA Company ID for Booker and Shipper Information. Used in Booker Information if specified and information not available from Logistics Group. Used in Shipper Information if specified and information not available from Logistics Group or Division.
Shipping Location SHPG_LOC_CD Name Name for Booker and Shipper Information. Used in Booker Information if specified and information not available from Logistics Group. Used in Shipper Information if specified and information not available from Logistics Group or Division.

Shipping Location

SHPG_LOC_CD

PartnerAlias

For locations which do not have a UN/LOCODE, the PartnerAlias is the location name as configured in the INTTRA system. If a UNLOCODE mapping exists, it will be used instead of the PartnerAlias.

Note: PartnerAlias should be used rarely. All PartnerAlias values must be configured with INTTRA. For these locations, a PartnerAlias External Mapping should be configured, and a UNLOCODE External Mapping should not be configured.

Shipping Location SHPG_LOC_CD PostalCode Ignored if AddressOverride is not one of Booker or Shipper or Both. Otherwise, overrides the Postal Code derived from the Origin Location of the Booking’s Shipment in Booker/Shipper Information.

Shipping Location

SHPG_LOC_CD

SIDateOffset

The number of hours prior to a time table entry’s departure date to set the Shipping Instructions Date/Time. This value is used when the INTTRA Ocean Schedule Import job type creates new time table entries. The value should be a valid decimal number.

Shipping Location SHPG_LOC_CD StreetAddress Ignored if AddressOverride is not one of Booker or Shipper or Both. Otherwise, overrides the Street Address derived from the Origin Location of the Booking’s Shipment in Booker/Shipper Information.
Shipping Location SHPG_LOC_CD Subdivision Ignored if AddressOverride is not one of Booker or Shipper or Both. Otherwise, overrides the State Code derived from the Origin Location of the Booking’s Shipment in Booker/Shipper Information.

Shipping Location

SHPG_LOC_CD

UNLOCODE

The UN/LOCODE of the location. If neither a Partner Alias nor a UN/LOCODE are mapped, it is assumed that the TM Location Code is set as a valid UN/LOCODE.

Customers should use UN/LOCODE wherever it is possible. For rail heads and ports, it should be set to the UN/LOCODE of the location. For other locations, it should be set to the city.

If the locations are already named with the appropriate UN/LOCODE, no External Mapping is required.

The reverse mapping process from INTTRA locations to TM locations requires a UN/LOCODE to map to only one TM location. This applies to locations used for sailing schedules and booking lifecycle revisions.

Note: If the UN/LOCODE is stored as a field on the TM shipping locations in the system (e.g. Equivalent External Code 1), an entity column mapping may be configured instead of a fixed value mapping for each location.

Shipping Location SHPG_LOC_CD NoIdentifier

The ‘NoIdentifier’ External Mapping should only be configured for locations that do not have a UN/LOCODE and do not have a PartnerAlias. This mapping will instruct the integration to only supply address information (no UN/LOCODE or PartnerAlias).

Note: Additional information can be found in the INTTRA Shipper ILINK documentation or from INTTRA directly.

Reference Information Mapping

Reference Information

INTTRA Documentation

Notes:

BillOfLadingNumber

Reference number assigned to a bill of lading

 

BookingNumber

Carrier Booking Number. Limited to 30 characters.

If defined, a reference number of the mapped type will be created when the Carrier provides a Carrier Booking Number in confirmation messages.

ConsigneeReferenceNumber

Reference number of the consignee.

 

ContractLineItemNumber

Contract Line Item Number. Must only be used when CT (Contract Number) is also provided.

 

ContractNumber

Contract/Quote number

 

ContractPartyReferenceNumber

Reference number assigned to a party for a particular contract.

 

FeederArrivalDateReferenceNumber   Used to capture the arrival date/time of the feeder vessel
FeederContainerYardDateReferenceNumber   Used to capture the container yard date/time of the feeder vessel
FeederDepartureDateReferenceNumber   Used to capture the departure date/time of the feeder vessel
FeederIMOReferenceNumber   Used to capture the IMO number of the feeder vessel
FeederPortOfDischargeReferenceNumber   Used to capture the port of discharge of the feeder vessel
FeederPortOfLoadReferenceNumber   Used to capture the port of loading of the feeder vessel
FeederShippingInstructionDateReferenceNumber   Used to capture the shipping instruction date of the feeder vessel
FeederVesselReferenceNumber   Used to capture the feeder vessel name
FeederVoyageReferenceNumber   Used to capture the voyage number of the feeder vessel

FreightForwarderRefNumber

Reference number assigned to the consignment by the freight forwarder.

 

FreightTariffNumber

Freight tariff number

 

INTTRAReferenceNumber

INTTRA Reference Number

Required. A mapping from a valid TM Reference Number Type to the INTTRAReferenceNumber must be specified. The INTTRAReferenceNumber returned in the INTTRA confirmation will be stored as a reference number of the mapped type on the booking.

OutboundBookingAgentRefNumber

Outbound Booking Agent Reference

 

PurchaseOrderNumber

Reference number assigned by the buyer to an order.

 

ShipperReferenceNumber

Shipper's identifying number for shipment attributes

 

VehicleIdentificationNumber

The identification number which uniquely distinguishes one vehicle from another through the lifespan of the vehicle.

 

See Also