Transport DTO is deprecated for providing transport related data and is superseded by /wiki/spaces/AHID/pages/83002165Order.
Please consider using Transport Order for new integrations. However, we continue to support Transport as well. Please also see the /wiki/spaces/AHID/pages/83001548Breaking Changes Policy.
Transport DTOs are used to create, update, and delete transports and deliveries on the Transporeon platform. The following table lists the attributes of the Transport DTO. Some of them may be optional for message processing in the interface but are crucial for one or another business or use case.
...
Attribute | Description | Type (Length) | Example | Mandatory | |||||
|---|---|---|---|---|---|---|---|---|---|
number | Transport number, unique | CHAR(50) | 123456 | True | |||||
deliveries | Encloses list of delivery DTOs, see /wiki/spaces/AHID/pages/83002433 Delivery | True | |||||||
status | Transport status
| CHAR(3) | NTO | True | |||||
acceptance_deadline | A deadline to accept an offer. Considered for No-Touch Order assignment method, ignored otherwise. | CHAR(25) | 2021-11-18T11:30:00+03 | False | |||||
offer_deadline | A deadline until the offer can be placed. Considered for Best Carrier assignment method. | CHAR(25) | 2023-01-16T11:30:00+03 | False | |||||
offer_deadline_update | A deadline until the offer can be updated. Considered for Best Carrier assignment method. | CHAR(25) | 2023-01-17T11:30:00+03 | False | |||||
offer_deadline_withdrawal | A deadline until the offer can be deleted. Considered for Best Carrier assignment method. | CHAR(25) | 2023-01-18T11:30:00+03 | False | |||||
carbon_visibility_only | If set to true, transport is marked as Carbon Visibility only and participate only in CO2 calculations. See “Carbon visibility” chapter. Default value is False. | BOOLEAN | false | False | |||||
carrier_creditor_number | Creditor number of an assigned carrier. Considered and mandatory for No-Touch Order assignment method, ignored otherwise. | CHAR(50) | CARRIER1 | True for NTO w/o ACA | |||||
carrier_group | Carrier group name. Considered for Best Carrier assignment method if provided, ignored otherwise | CHAR(50) | Carriers-DE | False | |||||
comment | Comment for transport | CHAR(3000) | My transport comment | False | |||||
distance | Distance between loading and unloading stations. See /wiki/spaces/AHID/pages/83003788 Units, Statuses, and Enumerations | FLOAT | 352.0 | False | |||||
internal_comment | Transport comment, visible to the shipper’s users | CHAR(3000) | My internal comment | False | |||||
loading_meter | Length of the load on vehicle. See /wiki/spaces/AHID/pages/83003788 Units, Statuses, and Enumerations | FLOAT | 13.6 | 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
| CHAR(25) | False | ||||||
parameters | List of parameter DTOs, that enclose additional transport data, see /wiki/spaces/AHID/pages/83002213 Parameter | False | |||||||
prices | Prices DTOs with price and surcharge information of the transport, see /wiki/spaces/AHID/pages/83002705 Prices | False | |||||||
scheduling_unit | Scheduling unit | 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. See /wiki/spaces/AHID/pages/83003788 Units, Statuses, and Enumerations | FLOAT | 30.6 | False | |||||
weight | Load weight. See /wiki/spaces/AHID/pages/83003788 Units, Statuses, and Enumerations | FLOAT | 15.5 | False | |||||
If no scheduling unit is provided, the “Standard” scheduling unit is used.
...