DTOs for Forwarders
- ser_hcskb_api
The structure of the Transport Order DTO is as follows:
A transport order can contain multiple orders (Order Details).
An order can contain multiple Order Items. Order items contain information about the load.
Each order provides the usual order details and references to loading and unloading stops. There is usually one loading and one unloading stop.
Stops contain address data and the information when to arrive at a stop.
Transport order and order details are different for forwarders. Order item and Stops are the same
Transport Order
The Transporeon platform supports different sets of attributes in the DTOs, depending on a specific business case. This means not all fields are relevant for all business cases.
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 order details get aggregated to be displayed on transport level by default. See “Measurement” chapter.
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
number | Transport number, unique | CHAR(50) | 123456 | True |
orders | Encloses list of order details DTOs (Transporeon Deliveries), see “Orders Details” chapter | True | ||
stops | Encloses list of stop DTOs, see “Stop” chapter | True | ||
status | Transport status: N Save new transport for manual assignment D Delete transport NTO Direct Match BC Spot Match AP Auto Match | CHAR (3) | N | True |
acceptance_deadline | A deadline to accept a transport or place an offer. Considered for Direct and Spot assignment method | CHAR(25) | 2021-1118T11:30:00+ 03 | False |
offer_deadline | A deadline until the offer can be placed. Considered for Spot Match assignment method. The Deadline is exactly the time stamp in the provided time zone offset | CHAR(25) | 2021-1118T11:30:00+ 03 | False |
offer_deadline_update | A deadline until the offer can be updated. Considered for Spot Match 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 | CHAR(50) | CARRIER123 | True if status is NTO, else False |
carrier_group | Carrier group name. Considered for Spot Match assignment method if provided, ignored otherwise. Not yet supported, but kept here since it will come soon. | CHAR(50) | Carriers-DE | False |
comment | Comment for transport | CHAR(3000) | My transport comment | False |
loading_meter | Length of the load on vehicle. Attribute “unit” contains one of supported length units. See “Measurement” for more details. | FLOAT | 13.6 | False |
criticality | Parameter for Spot Match product | INTEGER 0 … 100 | 100 | False |
distance | Distance between loading and unloading stations. Attribute “unit” contains one of supported distance units. See “Measurement” for more details. | FLOAT | 352.0 | False |
parameters | List of parameter DTOs, that enclose additional transport data, see “Parameter”. | False | ||
prices | List of prices DTOs with price and surcharge information of the transport, see “Price”. | False | ||
scheduling_unit | Scheduling unit. If scheduling unit is not provided, “Standard” scheduling unit is used. | CHAR(100) | Ulm | False |
storageposition_count | Number of pallet places | FLOAT | 10.5 | False |
vehicle | Vehicle type, required for the transport | CHAR(50) | Jumbo | False |
volume | Load volume. Attribute “unit” contains one of supported volume units | FLOAT | 30.6 | False |
weight | Load weight, Attribute “unit” contains one of supported weight units | FLOAT | 15.5 | False |
Order Details
Every transport order must contain at least one order.
By default storage positions and measurement values of deliveries (weight, volume, loading meter and distance) get aggregated to be displayed on transport order level.
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
number | Order / Delivery number, unique | CHAR(50) | D123 | True |
status | N Create / Update D Delete For removing orders from existing transports, the best approach is to send a full transport order update just without the orders to be removed | CHAR(1) | N | True |
loading_stop_ids | References to loading stops. For regular use cases exactly 1 reference is expected. | True | ||
unloading_stop_ids | References to unloading stops. For regular use cases exactly 1 reference is expected. | True | ||
comment | Delivery comment, free text | CHAR(3000) | My delivery comment | False |
distance | Distance between loading and unloading stations. Attribute “unit” contains one of supported distance units. See “Measurement” for more details. | FLOAT | 352.0 | False |
hzg_class | Hazardous goods class | CHAR(20) | 1 Explosives | False |
hzg_number | Hazardous goods name | CHAR(20) | TNT | False |
incoterm_city | Incoterm city that is related to the incoterm | CHAR(100) | Ulm | False |
incoterms | Incoterms. See "Incoterms" for supported values. | CHAR(100) | EXW | False |
order_items | List of Order Item DTOs, containing corresponding order items data, see “Order Item” | |||
loading_meter | Length of the load on vehicle. Attribute “unit” contains one of supported length units. See “Measurement” for more details. | FLOAT | 20.45 | False |
parameters | List of parameter DTOs, that enclose additional data of the delivery, see “Parameter”. | False | ||
scheduling_unit | Scheduling unit. If scheduling unit is not provided, “Standard” scheduling unit is used. | CHAR(100) | Ulm | False |
storageposition_count | Number of pallet places | FLOAT | 10.5 | False |
transport_unit | A unit containing loading tackle data (e. g. pallet details). See “Transport unit”. | |||
vehicle | Vehicle type | CHAR(50) | Jumbo | False |
volume | Load volume. Attribute “unit” contains one of supported volume units). See “Measurement” for more details. | FLOAT | 30.6 | False |
weight | Load weight, Attribute “unit” contains FLOAT one of supported weight units). See “Measurement” for more details. | FLOAT | 15.5 | False |
Transport_assignment DTO
Attribute | Description | Type (Length) | Example | |
|---|---|---|---|---|
carrier_creditor_number | Carrier creditor number | CHAR(50) | CARRIER01 | |
currency | Currency of the transport price | CHAR(3) | EUR | |
decline_reason_qualifier | Identifier of the transport decline reason for Direct Match | CHAR(100) | transport.declined | |
link | Link to the transport in Transport Execution module, Transporeon UI. Login and password are required to see the transport. | CHAR(100) | ||
number | Transport number | CHAR(50) | ABC123 | |
price | Transport price | FLOAT | 299.99 | |
status | Indicates if the transport has been accepted by the carrier. ACCEPTED Carrier accepted a Direct Match DECLINED Carrier declined a Direct Match or an offer EXPIRED Direct Match acceptance- or Spot Match offer deadline expired | CHAR(20) | ACCEPTED | |
timestamp | Timestamp (UTC+offset) | CHAR(29) | 2021-12-19T14:16:28.000+01:00 | |
transport_id | Internal transport identifier | INTEGER64 | 669627623 | |
type | Assignment type BC Spot Match NTO Direct Match | CHAR(3) | NTO | |