Shipment

Field Descriptions

Field

Description

Type (Length)

Mandatory

Remark

Field

Description

Type (Length)

Mandatory

Remark

@id

Transporeon delivery / order ID

N4/10

True

Unique ID on Transporeon Platform

index

Serial number

N4/10

True

Not unique across documents

tour_id

Transporeon transport ID

N4/10

True

Unique transport ID on Transporeon Platform

owner

Name of shipper´s scheduling unit

C1/50

False

Place of dispatching

number

Delivery / Order number in the shipper's system

C1/50

False

Might be re-used by the shipper after the life-cycle of the current transport ends (Cancelled or removed by retention policy).

Deliveries / Orders can also be moved between transports.

Might not be disclosed depending on shipper specific processes.

customer_name

Recipient company name

C1/50

False

 

customer_number

Recipient shipper specific customer number

C1/50

False

 

faktura

Incoterms

C1/10

False

e. g.: EXW, FCA, FAS, FOB, CFR, CIF, CPT, CIP, DAF, DES, DEQ, DDU, DDP

vehicle_id

ID of vehicle

N4/10

False

Shipper's ID or name for the required vehicle

vehicle_name

Name of vehicle

C1/50

True

Shipper's name for the required vehicle

weight

Delivery / Order weight

F4/9

False

 

weight_unit

Delivery / Order weight unit

C1/3

False

e.g.: t, kg

length

Delivery / Order loading meter

F4/9

False

 

length_unit

Delivery / Order loading meter unit

C1/3

False

e.g.: m

volume

Delivery / Order volume

F4/9

False

 

volume_unit

Delivery / Order volume unit

C1/3

False

e.g.: cbm

route

Distance

F4/9

False

 

route_unit

Distance unit

C1/3

False

e.g.: km

dlclass

Dangerous goods class

C1/100

False

 

dlnumber

Dangerous goods number

C1/100

False

 

storage_position_count

Number of storage positions

double

False

 

handling_units

Handling units

List

False

List of HandlingUnit

handling_units/handling_unit/qualifier

Qualifies the handling unit

 

String

True

Handling units can be defined per shipper. Standard handling units:

BARREL, BIG_BAG, BIN, BOX, CAGE, COMPACTOR, CONTAINER, CRATE, HANGING_GARMENT, IBC, PALLET, PARCEL, WASTE_BIN, WASTE_BASKET, NOT_SET

handling_units/handling_unit/amount

Number of handling units

integer

True

 

comment

Delivery comment

C1/3000

False

This is free text and may be subject of change at any time. We strongly recommend to not parse values from this field.

comment_plain_text

Delivery comment

C1/3000

False

This is free text and may be subject of change at any time. We strongly recommend to not parse values from this field.

loading_stop_ids

Identifier of loading stop

See Stop (CI)

C1/20

False

Points to stop one level above

unloading_stop_ids

Identifier of unloading stop

See Stop (CI)

C1/20

False

Points to stop one level above

items

Delivery items

See Item (CI)

 

 

 

station

Loading and unloading stations

See Station (CI)

 

True

 

parameters

Shipper and process specific additional information

See Parameter (CI)

 

False

 

Â