Tour

@id

Transporeon ID to identify this transport

N4/10

True

Unique identifier

timestamp

Timestamp of export file creation

C1/19

True

YYYY-MM-DD HH:MM:SS

document_reference

Reference number for this document / message.

C/100

True

This is a unique reference per transaction on our side.

It can be used as a reference for our support teams.

Note, it is not unique if a transaction on our side generated multiple messages.

changed

Indicates who did a change

C1/1

True

number

Transport number in the shipper's system

C1/20

True

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

Might not be disclosed depending on shipper specific processes.

external_transport_number

Additional transport number from shipper

C1/50

False

transport_group_id

ID for grouped transport

C1/20

False

Transport is not in a group if id is 0 or empty

attachments

Metadata for attached files for this transport.

See Tour Attachment Metadata (CI)

False

tpw_link

URL to transport in Transporeon Platform

C1

False

Direct URL to the assigned transport in Transporeon Platform

status

Transport status

C1/1

True

qualifier

Transport status details

C1/

True

shadow_nto

Shadow NTO transport

C1/1

False

Transports flagged with shadow NTO support only a limited set of features.

partial_accept

Partial accept available

C1/1

False

company_id

Shipper's Transporeon ID

C1/20

True

Unique number in Transporeon

company_name

Shipper's name

C1/200

True

company_address

Shipper's street and number

C1/100

True

company_zip_address

Shipper's postal code

C1/20

True

company_city

Shipper's city

C1/100

True

company_region

Shipper's region

C1/100

False

company_country_id

Shipper's country code

C1/2

True

ISO 3166-1 alpha-2

disponent_firstname

First name of shipper's scheduler

C1/100

False

disponent_lastname

Last name of shipper's scheduler

C1/100

False

disponent_phone

Phone number of shipper's scheduler

C1/100

False

disponent_id

Shipper scheduler's Transporeon ID

N4/10

False

carrier_disponent_name

First name and Last name of carrier scheduler

C1/100

False

No-Touch Order: User who accepted the transport.
Best carrier: User who submitted the offer.

carrier_disponent_id

ID of the carrier scheduler

C1/6

False

No-Touch Order: User who accepted the transport.
Best carrier: User who submitted the offer.

carrier_disponent_email

Carrier scheduler email address

C1/100

False

vehicle_id

Vehicle’s ID or name

C1/100

False

Shipper's ID or name for the required vehicle

vehicle_name

Shipper's name for the required vehicle

C1/50

False

Shipper's name for the required vehicle

start_date

Earliest date of loading

C1/10

False

YYYY-MM-DD

start_time

Earliest time of loading

C1/10

False

HH:MM:SS

end_date

Latest date of unloading

C1/10

False

YYYY-MM-DD

end_time

Latest time of unloading

C1/10

False

HH:MM:SS

owner

Scheduling unit

C1/50

False

Deprecated, see also “plant”

start_country_id

Country code of first loading station

C1/2

False

ISO 3166-1 alpha-2

start_zip

Postal code of first loading station

C1/20

False

start_city

City of first loading station

C1/100

False

start_region

Region of first loading station

C1/100

False

end_country_id

Country code of last unloading station

C1/2

False

ISO 3166-1 alpha-2

end_zip

Postal code of last unloading station

C1/20

False

end_city

City of last unloading station

C1/100

False

end_region

Region of last unloading station

C1/100

False

price_offered

Price of your offer

F4/9

False

price_basic

Basic price

F4/9

False

Best Carrier = frame price specified by shipper;

No-Touch Order = price of transport agreement negotiated between shipper and carrier

price_additional1

Surcharge 1

F4/9

False

price_additional2

Surcharge 2

F4/9

False

price_additional3

Surcharge 3

F4/9

False

price_additional1_desc

Description of surcharge 1

C1/50

False

price_additional2_desc

Description of surcharge 2

C1/50

False

price_additional3_desc

Description of surcharge 3

C1/50

False

currency_id

Currency code

C1/3

False

Currency code is valid for all prices in this document unless specified otherwise for a certain field

Codes are in accordance to ISO 4217

offer_price_disabled

Offer placing disabled

Boolean

False

Indicator whether offer can contain a total price. Relevant for Best Carrier

assigned_carrier_id

Carrier's Transporeon ID

C1/20

False

unique ID in Transporeon

assigned_carrier_name

Carrier's company name

C1/200

False

assigned_creditor_number

Creditor number of assigned carrier in the shipper's system

C1/20

False

carrier_number

Carrier number of assigned carrier in the shipper's system

C1/20

False

weight

Transport net weight/gross weight

F4/9

False

depending on the shipper's settings

weight_unit

Transport weight unit

C1/3

False

depending on the shippers’ settings / e.g. : kg, t

length

Transport net/gross loading meter

F4/9

False

depending on the shipper's settings

length_unit

Transport loading meter unit

C1/3

False

depending on the shipper’s setting/ e.g. : m

volume

Transport net/gross volume

F4/9

False

depending on the shipper's settings

volume_unit

Transport volume unit

C1/3

False

depending on the shipper’s setting/ e.g. : cbm

route

Distance

F4/9

False

maximum over all shipment distances/sum of all shipment distances, depending on the shipper's settings

route_unit

Distance unit

C1/3

False

Example: km

auction_start_date

Start date of auction

C1/10

False

Best Carrier only; YYYY-MM-DD

auction_start_time

Start time of auction

C1/10

False

Best Carrier only; HH:MM:SS

auction_end_date

End date of auction

C1/10

False

Best Carrier only; YYYY-MM-DD

auction_end_time

End time of auction

C1/10

False

Best Carrier only; HH:MM:SS

auction_offer_edit_end_date

Deadline until when offer can be edited

C1/10

False

Best Carrier only; YYYY-MM-DD

auction_offer_edit_end_time

Deadline until when offer can be edited

C1/10

False

Best Carrier only; HH:MM:SS

auction_offer_withdrawal_end_date

Deadline until when offer can be withdrawn

C1/10

False

Best Carrier only; YYYY-MM-DD

auction_offer_withdrawal_end_time

Deadline until when offer can be withdrawn

C1/10

False

Best Carrier only; HH:MM:SS

auction_comment

General auction comment

C1/8000

False

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

auction_comment_plain_text

General auction comment

C1/8000

False

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

loading_datetime_offer_requested

Loading datetime

Boolean

False

Best Carrier only; Indicates that placed offer must contain loading timestamps for all deliveries

unloading_datetime_offer_requested

Unloading datetime

Boolean

False

Best Carrier only; Indicates that placed offer must contain unloading timestamps for all deliveries

plant

Name of shipper's scheduling unit

C1/50

False

Place of dispatching

delivery_group_number

-

integer

False

deprecated

tkn_weight

-

integer

False

deprecated

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

General transport comment

C1

False

This is free text and may be subject for change at any time. We strongly recommend to not parse values from this field. This Field is limited with 3000 chars

comment_plain_text

General transport comment

C1

False

This is free text and may be subject for change at any time. We strongly recommend to not parse values from this field. This Field is limited with 3000 chars

tsm_light_login_link

Web link to Time Slot Management

C1/300

False

This web link has a limited validity. It can be used for booking, rebooking and deleting of a booking.

internal_comment

Internal comment added by the carrier

C1

False

This is free text and may be subject for change at any time. We strongly recommend to not parse values from this field. This Field is limited with 3000 chars

parameters

Shipper and process specific additional information

See Parameter (CI)

False

required_price_components

Indicates which price components must be provided when placing bids

See Required Fields Indicators

False

Best Carrier only

required_offer_parameters

Lists required additional information when placing bids

See Required Fields Indicators

False

Best Carrier only

required_transport_parameters

Lists required additional information on transport level

See Required Fields Indicators

False

required_delivery_parameters

Lists required additional information on delivery level

See Required Fields Indicators

False

required_delivery_item_fields

Lists required additional information on item level

See Required Fields Indicators

False

shipments

Deliveries / Orders

See Shipment

False

stops

All stops

See Stop (CI)

False

offer

Assigned offer

See Offer (CI, Outbound)

False

Best Carrier only