General
- GID (package) information is taken from the handling units on consignment level.
- For each handling unit found on consignment level, this message includes the dangerousGoods information from the handling units on shipment level that are packed into that handling unit.
- The child handling units within an OVERPACK are not included in the message. The message only contains the consignment level handling units combined with the dangerous goods information taken from the shipment level handling units.
- Identical handling units on consignment level are not consolidated but are included individually in the message.
- Package types must be configured. In case a package type is submitted for which no translation can be found, the integration will return an error and no message will be send to the carrier.
- The package type for child handling units in an overpack are always set to Viya package type
box. If no translation is found for package typeboxin the configuration, the the package type for overpack children is defaulted to package typeBXin the GID segment.
Documentation
- unece.org: https://unece.org/fileadmin/DAM/trade/untdid/d01b/trmd/iftmin_c.htm
- gs1: https://www.gs1.org/sites/default/files/docs/eancom/ean02s4/part2/iftmin/toc.htm
Example message
UNA:+.? 'UNB+UNOC:3+233222332+0008897789:14+20250625:0654+1750834472'UNH+4010000108006134370825+IFTMIN:D:01B:UN+SiS'BGM+610+4010000108006134370825+5'DTM+137:202506250654:203'FTX+DIN+++AAAA|Test'FTX+DIN+++TR02|packinglist is included#LD12 | delivery until 1200#LD10 | Anliefe'FTX+DIN+++DDWB | MO-FR 8.00-16.00#DASC | Dabrowa (allow split shipments)#DDFD | 'FTX+TCA+1+DIRECT:SERVICELEVEL:ZZZ'CNT+11:3'CNT+15:17:MTQ'CNT+7:500:KGM'TOD+6++CIP'RFF+AAA:4010000108006134370825'RFF+CU:4010000108006134370825'RFF+AAM:2K029373'RFF+BN:67584847'RFF+SRN:4010000108006134370825'NAD+LP+C034'NAD+PW+C034++Company name pickup location+STREETNAME 12+CITY NAME++41-000+PL'NAD+CN+0000000000000++Company name+Streetname+City++26-000+PL'NAD+CZ+4001895000003++Company name of sender+Streetname and Number+City++4900+CH'GID+1+1:BX:::BX+1:BX:::BX'MEA+WT+GW+KGM:100'MEA+VOL++MTQ:1'DIM+2+CMT:100:100:100'PCI+18'GIN+AW+ROOT_SSCC_1'DGS+ADR+NO_INFORMATION+3481+Flashpoint should be string+III+++NO+++BOX+2+(E)'FTX+AAA+++MARINE_POLUTANT'FTX+AAC+++packing instructions'FTX+AAD++Niet beperkt - Lithium-ion batterijen in apparatuur conform speciale bepaling 18:INNER PACKAGING, PLASTIC SYRING'FTX+F02+++BOX::3'MEA+WT+AAE+KGM:0'DGS+IMD'FTX+ADW+++EQ'MEA+WT+AAE+KGM:0'GID+2+1:PX:::PX+1'MEA+WT+GW+KGM:200'MEA+VOL++MTQ:8'DIM+2+CMT:200:200:200'PCI+18'GIN+AW+059025961363267999'DGS+ADR+3+1876+Flashpoint should be string+I+++NO+++PALLET+1+(E)'FTX+AAA+++MARINE_POLUTANT'FTX+AAC+++Note here'FTX+AAD++Proper shipping name here:Secret package description'FTX+F02+++PALLET::8'MEA+WT+AAE+KGM:0'DGS+IMD'FTX+ADW+++LQ'MEA+WT+AAE+KGM:0'DGS+ADR'FTX+ADW+++EQ'FTX+F02+++PALLET::1'DGS+ADR+3+1876+Flashpoint should be string+I+++NO+++PALLET+1+(E)'FTX+AAA+++MARINE_POLUTANT'FTX+AAC+++Note here'FTX+AAD++Proper shipping name here:Secret package description'FTX+F02+++PALLET::1'MEA+WT+AAE+KGM:0'GID+3+1:PX:::PX+1'MEA+WT+GW+KGM:200'MEA+VOL++MTQ:8'DIM+2+CMT:200:200:200'PCI+18'GIN+AW+ONE_MORE'UNT+65+4010000108006134370825'UNZ+1+1750834472'Mapping
UNA segment
Example: UNA:+.? '
This segment is used to inform the receiver of the interchange that a set of service string characters which are different to the default characters are being used.
| value | description | mapping |
|---|---|---|
: | Component data element separator | Fixed : |
+ | Data element separator | Fixed + |
. | Decimal mark | Fixed . |
? | Release character | Fixed ? |
UNB segment
Example: UNB+UNOC:3+233222332+0008897789:14+20241120:1051+1732099864'
This segment is used to envelope the interchange, as well as to identify both, the party to whom the interchange is sent and the party who has sent the interchange.
| value | description | mapping |
|---|---|---|
UNOC | Syntax identifier | Fixed UNOC |
:3 | Syntax version number | Fixed 3 |
233222332 | Interchange sender identification (GLN) | Configuration.iftminD01bSenderGln |
0008897789 | Interchange recipient identification (GLN) | Configuration.iftminD01bReceiverGln Can be configured per ship to country |
:14 | Identification code qualifier (14=GS1) | Fixed 14 |
20241120 | Creation date of the document in YYYYMMDD | System date at document creation |
:1051 | Creation time of the document in HHNN | System time at document creation |
1732099864 | Interchange control reference, unique reference identifying the interchange. Must be equal to reference in UNZ segment | Automatically generated random number |
UNH segment
Example: UNH+6100192+IFTMIN:D:01B:UN+Viya'
Message header, a service segment starting and uniquely identifying a message. The message type code for the Instruction message is IFTMIN.
| value | description | mapping |
|---|---|---|
6100192 | Message reference number. Senders unique message reference. | reference |
IFTMIN | Message type | Fixed IFTMIN |
:D | Message version number | Fixed D |
:01B | Message release number | Fixed 01B |
:UN | Controlling agency, coded | Fixed UN |
SIS | Common access reference | Fixed SIS |
BGM segment
Example: BGM+610+6100192+9'
Beginning of message, a segment to indicate the beginning of a message and to transmit identifying number and type of the message.
| value | description | mapping |
|---|---|---|
610 | Document name code (610=Forawrding Instructions) | Fixed 610 |
6100192 | Document identifier, transport Instruction number assigned by the document sender. | reference |
9 | Message function code (9=Original). In playground environment 5 is used. | Fixed 9 or 5 |
DTM segment
Example: DTM+137:202411200941:203'
Date/time/period, document/message date/time. Date/time when a document/message is issued.
| value | description | mapping |
|---|---|---|
137 | Date or time or period function code qualifier (137=document message creation date/time) | Fixed 137 |
:202411200941 | Date or time or period value | System date/time at document creation in CYYMMDDHHMM |
:203 | Date or time or period format code (203=CCYYMMDDHHMM) | Fixed 203 |
FTX+DIN segment
Example: FTX+DIN+++DASC|Dabrowa (allow split shipments)#DDWB|MO-FR 8.00-16.00'
Free text, delivery instructions. Instructions regarding the delivery of the cargo.
| value | description | mapping |
|---|---|---|
DIN | Code qualifier (DIN=delivery instructions) | Fixed DIN |
DASC|Dabrowa (allow split shipments)#DDWB|MO-FR 8.00-16.00 | Instruction values. Instructions are seperated by #.Note no differentiation is made between loading, transport and delivery instructions but instead concatenate them to one string. | instructions.carrierInstructions.collection instructions.carrierInstructions.transport instructions.carrierInstructions.delivery |
FTX+TCA segment
Example: FTX+TCA+1+DIRECT:SERVICELEVEL:ZZZ'
Free text, tariff applied. Specification of the tariff applied.
| value | description | mapping |
|---|---|---|
TCA | Code qualifier (TCA=tariff applied) | Fixed TCA |
1 | Free text value code | Fixed 1 |
DIRECT | Service level | serviceLevelReference, if value contains # only the right part of the value is mapped. |
:SERVICELEVEL | fixed text to indicate function | Fixed SERVICELEVEL |
:ZZZ | fixed text, indicates values are mutually defined | Fixed ZZZ |
CNT+11 segment
Example: CNT+11:2'
Control total, a segment to specify totals for a consignment. Total number of packages in cnsignment.
| value | description | mapping |
|---|---|---|
11 | Control total type code qualifier (11=total number of packages) | Fixed 11 |
2 | Number of packages in consignment | count handlingUnits on consignment level |
CNT+15 segment
Example: CNT+15:0.098592:MTQ'
Control total, a segment to specify totals for a consignment. Total consignment, cube.
| value | description | mapping |
|---|---|---|
15 | Control total type code qualifier (15=total consignment volume) | Fixed 15 |
:0.098592 | Total volume | sum of volume of all handling units in consignment |
:MTQ | Unit of measurement (MTQ=cubic meter) | Fixed MTQ |
CNT+7 segment
Example: CNT+7:158:KGM'
Control total, a segment to specify totals for a consignment. Total gross weight of consignment.
| value | description | mapping |
|---|---|---|
7 | Control total type code qualifier (7=total consignment gross weight) | Fixed 7 |
:158 | Total gross weight | sum of gross weight of all handling units in consignment |
:KGM | Unit of measurement (KGM=kilogram) | Fixed KGM |
TOD segment
Example: TOD+6++cip'
Terms of delivery or transport, a segment to specify the applicable terms of delivery.
| value | description | mapping |
|---|---|---|
6 | Delivery or transport terms function code (6=Delivery condition) | Fixed 6 |
cip | Delivery condition | incoterms.incoterm |
RFF+AAA segment
Example: RFF+AAA:6100192'
Reference, Acknowledgement of order number
| value | description | mapping |
|---|---|---|
AAA | Reference code qualifier (AAA=Acknowledgement of order number) | Fixed AAA |
:6100192 | Reference value | reference |
RFF+CU segment
Example: RFF+CU:6100192'
Reference, consignor’s reference number, reference number assigned by a consignor to a particular consignment for his own purposes or for those of the consignee.
| value | description | mapping |
|---|---|---|
CU | Reference code qualifier (CU=Consignor’s reference number) | Fixed CU |
:6100192 | Reference value | reference |
RFF+AAM segment
Example: RFF+AAM:2K029373'
Reference number assigned to a waybill. Use this reference to refer to this consignment when sending tracking information to Viya.
| value | description | mapping |
|---|---|---|
AAM | Reference code qualifier. (AAM=Reference number assigned to a waybill) | Fixed AAM |
:2K029373 | Reference number assigned to the consignment. Use his reference for tracking to refer to this consignment | trackingReference |
RFF+BN segment
Example: RFF+BN:67584847'
Reference number assigned by the carrier (pre-advise reference). Use this reference when pre-booking applies.
| value | description | mapping |
|---|---|---|
BN | Reference code qualifier. (BN=Reference number assigned by the carrier) | Fixed BN |
:2K029373 | Reference number assigned by the carrier at pre-booking | references.freightForwarderAssigned |
RFF+SRN segment
Example: RFF+SRN:6100192'
Reference, shipment reference number, reference number assigned to a shipment.
| value | description | mapping |
|---|---|---|
SRN | Reference code qualifier (SRN=Shipment reference number) | Fixed SRN |
:6100192 | Reference value | reference |
NAD+LP segment
Example: NAD+LP+C034'
Name and address. Loading party, party responsible for the loading when other than carrier.
| value | description | mapping |
|---|---|---|
LP | Address code qualifier (LP=Loading Party) | Fixed LP |
C034 | Party identifier | addresses.sender.references.consignorAssigned |
NAD+PW segment
Example: NAD+PW+C034++PL DABROWA GORNICZA HUB:BUILDING 2+Street 12+DABROWA GORNICZA++11-111+PL'
Name and address. Despatch party, party where goods are collected or taken over by the carrier (i.e. if other than consignor).
| value | description | mapping |
|---|---|---|
PW | Address code qualifier (PW=Despatch Party) | Fixed PW |
C034 | Party identifier | addresses.collection.references.consignorAssigned |
PL DABROWA GORNICZA HUB | Party name | addresses.collection.companyName |
:BUILDING 2 | Additional address information | addresses.collection.addressLine2 |
Street 12 | Street and number | addresses.collection.addressLine1 |
DABROWA GORNICZA | City name | addresses.collection.city |
11-111 | Postal identification code | addresses.collection.postCode |
PL | Country name code | addresses.collection.countryCode |
NAD+CN segment
Example: NAD+CN+0000000000000++ELNEX NOWAK DARIUSZ JOZEF:Second floor+Street 3+RADOM++11-111+PL'
Name and address. Consignee, party to which goods are consigned.
| value | description | mapping |
|---|---|---|
CN | Address code qualifier (CN=Consignee) | Fixed CN |
0000000000000 | Party identifier (GLN) | addresses.receiver.references.consignorAssigned |
ELNEX NOWAK DARIUSZ JOZEF | Party name | addresses.receiver.companyName |
:Second floor | Additional address information | addresses.receiver.addressLine2 |
Street 3 | Street and number | addresses.receiver.addressLine1 |
RADOM | City name | addresses.receiver.city |
11-111 | Postal identification code | addresses.receiver.postCode |
PL | Country name code | addresses.receiver.countryCode |
NAD+CZ segment
Example: NAD+CZ+4001895000011++EMEA COE HEADQUARTERS:Office building 34+Street 2+Langenthal++1111+CH'
Name and address. Consignor, party which, by contract with a carrier, consigns or sends goods with the carrier, or has them conveyed by him. Synonym: shipper, sender.
| value | description | mapping |
|---|---|---|
CZ | Address code qualifier (CN=Consignor) | Fixed CZ |
4001895000011 | Party identifier (GLN) | addresses.transportBuyer.references.consignorAssigned |
EMEA COE HEADQUARTERS | Party name | addresses.transportBuyer.companyName |
:Office building 34 | Additional address information | addresses.transportBuyer.addressLine2 |
Street 2 | Street and number | addresses.transportBuyer.addressLine1 |
Langenthal | City name | addresses.transportBuyer.city |
1111 | Postal identification code | addresses.transportBuyer.postCode |
CH | Country name code | addresses.transportBuyer.countryCode |
CTA segment
Example: CTA+IC+:Harry Styles'
Contact information. Added per NAD segment. Only available when contact name is provided
| value | description | mapping |
|---|---|---|
IC | Contact function code (IC=Information contact) | Fixed IC |
Harry Styles | Information contact name | contactName from applicable addressset (PW, CN, CZ) |
COM segment
Example: COM+031635241627:TE' or COM+unknown@known.com:EM'
This segment identifies the communications number and type of communications for the person or department identified in the previous CTA segment. Added per NAD segment. Only available when contact name and phone (or email) is provided.
| value | description | mapping |
|---|---|---|
unknown@known.com | Contact information | TE = contactPhone from applicable addressset (PW, CN, CZ)EM = contactEmail from applicable addressset (PW, CN, CZ) |
TE | Communication address code qualifier (TE=Telephone) | contactPhone from applicable addressset (PW, CN, CZ) |
EM | Communication address code qualifier (EM=Electronic mail) | contactEmail from applicable addressset (PW, CN, CZ) |
GID segment
Example: GID+1+2:PE:::PE+1' (no overpack)
Goods item details, a segment to identify a goods item for which transport is undertaken. A goods item can be identified by up to three levels of packaging.
| value | description | mapping |
|---|---|---|
1 | Package quantity. Always set to 1. We do not consolidate identical packages. | Fixed 1 |
2 | Package count. Value increases by 1 for every package | Counter |
:PE:::PE | Package type code of handling unit, translated using configuration. Both package types are always the same (in this example both PE) | handlingUnit.packageType.code |
1 | Package count of child packages in case of overpack. Always set to 1 inthis scenario since there is no overpack. | Count of overpack childs |
Example: GID+1+2:PE:::PE+3:BX:::BX' (overpack)
Goods item details, a segment to identify a goods item for which transport is undertaken. A goods item can be identified by up to three levels of packaging.
| value | description | mapping |
|---|---|---|
1 | Package quantity. Always set to 1. We do not consolidate identical packages. | Fixed 1 |
2 | Package count. Value increases by 1 for every package | Counter |
:PE:::PE | Package type code of overpack, translated using configuration. Both package types are always the same (in this example both PE) | handlingUnit.packageType.code |
3 | Package count of child packages in case of overpack. | Count of overpack childs |
:BX:::BX | Package type of child packages in overpack, using the translation for packageType box. Translation for packageType box must be present. If not present, value is defaulted to BX Both package types are always the same (in this example both BX) | handlingUnit.packageType.code |
MEA+WT segment
Example: MEA+WT+GW+KGM:79'
Measurements, weight of the handling unit.
| value | description | mapping |
|---|---|---|
WT | Measured purpose code qualifier (WT=Weight) | Fixed WT |
GW | Measured attribute code (GW=Gross weight, maximum) | Fixed GW |
KGM | Measurement unit code (KGM=Kilograms) | Fixed KGM |
79 | Weight value | handlingUnit.weight |
MEA+VOL segment
Example: MEA+VOL++MTQ:0.049296'
Measurements, volume of the handling unit.
| value | description | mapping |
|---|---|---|
VOL | Measured purpose code qualifier (VOL=Volume) | Fixed VOL |
MTQ | Measurement unit code (MTQ=Cubic meters) | Fixed MTQ |
0.049296 | Volume value | handlingUnit.length * handlingUnit.width * handlingUnit.height / 1000000 Note the message converts from cubic centimeter to cubic meter |
DIM segment
Example: DIM+2+CMT:79:24:26'
This segment is used to indicate the dimensions of the goods item identified in the GID segment. All dimensions given in the DIM segments relate to the highest level packaging (the despatch units) identified in the GID segment.
| value | description | mapping |
|---|---|---|
2 | Dimension type code qualifier (2=Package dimensions (incl. goods)) | Fixed 2 |
CMT | Measurement unit code (CMT=Centimeters) | Fixed CMT |
79 | Length dimension value | handlingUnit.length |
24 | Width dimension value | handlingUnit.width |
26 | Height dimensiob value | handlingUnit.height |
PCI segment
Example: PCI+18'
Package identification.
| value | description | mapping |
|---|---|---|
18 | Package level indicator (18=SSCC level detail) | Fixed 18 |
GIN segment
Example: GIN+AW+059025961363267233'
Goods identity number, reference / SSCC of the handling unit.
| value | description | mapping |
|---|---|---|
AW | Object identification code qualifier (AW=Serial shipping container code(sscc)) | Fixed AW |
059025961363267233 | Serial shipping container code(sscc) | handlingUnit.reference |
DGS segment
Example: DGS+ADR+3.1+4501+25.3CEL+II+++1234++TFC+4G+3+(N)'
Dangerous goods, a segment to indicate the class of dangerous goods, packing group, etc.
| value | description | mapping |
|---|---|---|
ADR | Dangerous goods regulations codeICA = Regulations covering the international transportation of dangerous goods issued by the International Air Transport Association and the International Civil Aviation Organization.ADR = European agreement on the international carriage of dangerous goods on roadIMD = Regulations regarding the transportation of dangerous goods on ocean-going vessels issued by the International Maritime Organization. CFR = United States federal regulations issued by the US Department of transportation covering the domestic transportation of dangerous goods by truck, rail, water and air. | shipment.handlingUnits.goodsItems.dangerousGoods.regulation |
3.1 | Dangerous goods class | shipment.handlingUnits.goodsItems.dangerousGoods.class |
4501 | United Nations Dangerous Goods (UNDG) identifier (UN number) Value is transmitted without the prefix ‘UN’ | shipment.handlingUnits.goodsItems.dangerousGoods.unNumber |
25.3CEL | Dangerous goods flashpoint value | shipment.handlingUnits.goodsItems.dangerousGoods.flashPoint |
II | Packing group, packaging danger level code | shipment.handlingUnits.goodsItems.dangerousGoods.packingGroup |
1234 | Transport emergency card identifier | shipment.handlingUnits.goodsItems.dangerousGoods.tremCardNumber |
TFC | Dangerous goods classification code | shipment.handlingUnits.goodsItems.dangerousGoods.classificationCode |
4G | Packing code, packing instruction type code | shipment.handlingUnits.goodsItems.dangerousGoods.packingCode |
3 | Transport category. Category used to determine how many units can be combined into 1 transport unit | shipment.handlingUnits.goodsItems.dangerousGoods.transportCategory |
(N) | Tunnel restriction code. Code that indicates if /when goods are restricted to be transported through tunnels | shipment.handlingUnits.goodsItems.dangerousGoods.tunnelRestrictionCode |
FTX+ADW segment
Example: FTX+ADW+++LQ' or FTX+ADW+++EQ'
Free text, characteristics of goods, description of the characteristics of goods in addition to the description of the goods.
| value | description | mapping |
|---|---|---|
ADW | Text subject code qualifier (ADW=characteristics of goods) | Fixed ADW |
LQ | Limited Quantity | shipment.handlingUnits.goodsItems.dangerousGoods.type |
EQ | Excepted Quantity | shipment.handlingUnits.goodsItems.dangerousGoods.type |
FTX+AAA segment
Example: FTX+AAA+++MARINE_POLUTANT' or FTX+AAA+++INNER PACK 23 FLAMABLE:3.000:kgm'
Free text, dangerous goods description, plain language description of the nature of the goods sufficient to identify them at the level required for banking, Customs, statistical or transport purposes, avoiding unnecessary detail (Generic term)
| value | description | mapping |
|---|---|---|
AAA | Text subject code qualifier (AAA=dangerous goods description) | Fixed AAA |
MARINE_POLUTANT | Is the item Environmentally Hazardous. If true, a seperate FTX line is generated. Only send when isEnvironmentallyHazardous=true | shipment.handlingUnits.goodsItems.dangerousGoods.isEnvironmentallyHazardous |
INNER PACK 23 FLAMABLE | Inner package description of the dangerous goods | shipment.handlingUnits.goodsItems.dangerousGoods.innerPackage.description |
:3.000 | Inner package quantity | shipment.handlingUnits.goodsItems.dangerousGoods.innerPackage.quantity.value |
:kgm | Inner package unit of measurement | shipment.handlingUnits.goodsItems.dangerousGoods.innerPackage.quantity.unitOfMeasure |
FTX+AAC segment
Example: FTX+AAC+++Fibreboard box'
Free text, dangerous goods additional information, additional information concerning dangerous goods.
| value | description | mapping |
|---|---|---|
AAC | Text subject code qualifier (AAC=dangerous goods additional information) | Fixed AAC |
Fibreboard box | Information about the package containing dangerous goods | shipment.handlingUnits.goodsItems.dangerousGoods.packingDescription |
FTX+AAD segment
Example: FTX+AAD++TLQ+BATTERIES, DRY:STEEL DRUMS WITH REMOVABLE HEAD (1A2):36448-AA:121.2'
Free text, dangerous goods technical name, proper shipping name, supplemented as necessary with the correct technical name, by which a dangerous substance or article may be correctly identified or which is sufficiently informative to permit identification by reference to generally available literature.
| value | description | mapping |
|---|---|---|
AAD | Text subject code qualifier (AAD= dangerous goods technical name, proper shipping name) | Fixed AAD |
TLQ | Dangerous goods type indicator. TLQ = Limited QuantityTEQ = Excepted Quantity | shipment.handlingUnits.goodsItems.dangerousGoods.type |
BATTERIES, DRY | Proper shipping name. If empty the technical name is sent when available. | shipment.handlingUnits.goodsItems.dangerousGoods.properShippingName or shipment.handlingUnits.goodsItems.dangerousGoods.technicalName |
STEEL DRUMS WITH REMOVABLE HEAD (1A2) | Outer package information | shipment.handlingUnits.goodsItems.dangerousGoods.packingDescription |
36448-AA | MSDS number. Number of a material safety data sheet (MSDS). A MSDS document is a document that describes the hazards of a hazardous substance or mixture and provides advice on how to work with it safely. | shipment.handlingUnits.goodsItems.dangerousGoods.msdsNumber |
121.2 | Dangerous goods gross weight | shipment.handlingUnits.goodsItems.dangerousGoods.weight.gross |
UNT segment
Example: UNT+33+6100192'
Message trailer, used for verifying message correctness and completeness.
| value | description | mapping |
|---|---|---|
33 | Number of segments in a message | Fixed 33 |
6100192 | Message reference number. The message reference number detailed here should equal the one specified in the UNH segment. | reference |
UNZ segment
Example: UNZ+1+1732096429'
This segment is used to provide the trailer of an interchange. This segment is a mandatory UN/EDIFACT segment. It must always be the last segment in the message.
| value | description | mapping |
|---|---|---|
1 | Interchange control count.Number of messages or functional groups within an interchange. Always 1. We send 1 file per message. | Fixed 1 |
1732096429 | Interchange control reference. Identical to reference in UNB segment. | Automatically generated random number |