Transport Order

Transport Order DTOs are used to create, update, and delete transports and deliveries.

The structure is as follows:

image-2023-1-27_17-2-35.png

 

A transport order can contain multiple orders (Order Details).
An order can contain many order items. Order items contain information about the load.
Each order provides the usual order details and references to loading and unloading stops, usually one loading and one unloading stop.
Stops contain address data and the information when to arrive at a stop.

Attribute

Description

Type (Length)

Example

Mandatory

Attribute

Description

Type (Length)

Example

Mandatory

number

Transport number, unique

CHAR(50)

123456

True

orders

Encloses list of order details DTOs (Transporeon Deliveries), see Order Details

True

stops

Encloses list of stop DTOs, see Stop

True

status

Transport status

Status

  • N: Save new transport for manual assignment

  • D: Delete transport

  • NTO: Route No Touch Order

  • BC: Publish Best Carrier

  • AP: Publish Autonomous Procurement

CHAR(3)

NTO

True

acceptance_deadline

A deadline to accept a transport or place an offer. Considered for No-Touch Order assignment method

The Deadline is exactly the time stamp in the provided time zone offset

CHAR(25)

2021-11-18T11:30:00+03:00

False

acceptance_required

If set false, carrier does not need to confirm a transport. Use with caution, this requires special agreements with carriers!

Default is true → acceptance is required

BOOLEAN

true

False

offer_deadline

A deadline until the offer can be placed. Considered for Best Carrier assignment method.

The Deadline is exactly the time stamp in the provided time zone offset

CHAR(25)

2023-01-20T20:00:00Z

False

offer_deadline_update

A deadline until the offer can be updated. Considered for Best Carrier assignment method.

The Deadline is exactly the time stamp in the provided time zone offset

CHAR(25)

2023-01-21T21:00:00Z

False

offer_deadline_withdrawal

A deadline until the offer can be removed. Considered for Best Carrier assignment method.

The Deadline is exactly the time stamp in the provided time zone offset

CHAR(25)

2023-01-22T22:00:00Z

False

carrier_creditor_number

Creditor number of an assigned carrier. Considered and mandatory for No-Touch Order assignment method without Automatic Carrier Allocation feature, leave it empty otherwise.

CHAR(50)

CARRIER1

See description

carrier_group

Carrier group name. Considered for Best Carrier assignment method if provided, ignored otherwise.

Use either this field or carrier_group_carriers

CHAR(50)

Carriers-DE

False

carrier_group_carriers

Provide a list of carrier creditor numbers a Best Carrier transport is visible to.

Use either this field or carrier_group

False

comment

Transport comment, machine generated

CHAR(3000)

My transport comment

False

auction_comment

Transport comment, user-editable

CHAR(3000)

My user edited comment

False

internal_comment

Transport comment, only visible to the shipper side. Can be machine edited and edited by users

CHAR(3000)

My internal comment

False

loading_meter

Length of the load on vehicle. Attribute “unit” contains one of supported length units. See Measurement and Units, Statuses, and Enumerations

FLOAT

13.6

False

criticality

Parameter for Autonomous Procurement product

INTEGER

0 … 100

100

False

distance

Distance between loading and unloading stations. Attribute “unit” contains one of supported distance units. See Units, Statuses, and Enumerations

FLOAT

352.0

False

necessary_slots

Number of time slots that are needed for the transport, considered only when configured for customer.

INTEGER

2

False

group

Transport group name.

CHAR(50)

 

False

load_type

Transport load type

Types

  • BULK

  • CEP

  • CPU

  • FCL

  • FTL

  • LCL

  • LTL_GROUPAGE

  • LTL

CHAR(25)

 

False

parameters

List of parameter DTOs, that enclose additional data. See Parameter

False

prices

Prices DTOs with price and surcharge information of the transport. See Prices

False

scheduling_unit

Scheduling unit

CHAR(100)

Ulm

True

storageposition_count

Number of pallet places

FLOAT

10.5

False

handling_units

Handling units

List

 

 

handling_units/handling_unit/qualifier

Qualifies the handling unit

See Units, Statuses, and Enumerations

String

 

 

handling_units/handling_unit/amount

Number of handling units

INTEGER

 

 

vehicle

Vehicle type, required for the transport

CHAR(50)

Jumbo

False

volume

Load volume. Attribute “unit” contains one of supported volume units. See Units, Statuses, and Enumerations

 

FLOAT

30.6

False

weight

Load weight, Attribute “unit” contains one of supported weight units. See Units, Statuses, and Enumerations

FLOAT

15.5

False

loading_datetime_offer_requested

Specifies if the carrier should provide the loading datetime for the orders with the offer

BOOLEAN

true

False

unloading_datetime_offer_requested

Specifies if the carrier should provide the unloading datetime for the orders with the offer

BOOLEAN

true

False

transport_mode

Mode of transportation

Mode

  • AIR

  • OCEAN

  • RIVER

  • ROAD

  • RAIL

  • MULTIMODAL

  • NETWORK

  • UNKNOWN

 

See Description

 

False

transport_remarks

Zero to many transport remarks that signifies distinctive attributes

See Description

 

False

container_number

Container number

String

See ISO 6346

False

ocean_order_type

Ocean order type. Deprecated, use multimodal_order_type instead.

 

See Description

 

False

multimodal_order_type

Order type in multi modal scenarios

See Description

 

False

carrier_has_write_access

Specifies if the carrier can edit the transport

BOOLEAN

false

False

Transporeon platform supports different sets of fields in the DTOs, depending on a specific business case. This means not all fields are relevant for all business cases. An example is RTV standalone case, where only limited number of fields and parameters is considered when processing a transport on Transporeon side.

There are parameters with reserved qualifiers that are relevant for specific post-processing logic. For example, “cooled” qualifier represents whether the load must be refrigerated, “loadtype” allows to provide type of load, and both qualifiers participate in more precise CO2 emission calculations if their values are provided. Another example is ocean and sea transports. To enable ocean RTV and ensure its best results, all ocean-related standard parameters are advised to be provided. Please review “Reserved parameter qualifiers” and “Ocean and sea transports tracking and tracing” paragraphs.

For consistency, storage positions and measurement elements like weight, volume, loading meter and distance are usually not imported on transport level. Instead, measurement values of deliveries get aggregated to be displayed on transport level by default. Please, inform Transporeon project team if you want to have the default aggregation method changed to populate the values on transport level.