Transport
Transport DTO is deprecated for providing transport related data and is superseded by Order.
Please consider using Transport Order for new integrations. However, we continue to support Transport as well. Please also see the Breaking 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.
Fields that are crucial for the business logic are marked as True in the “Mandatory” column.
Attribute | Description | Type (Length) | Example | Mandatory |
---|---|---|---|---|
number | Transport number, unique | CHAR(50) | 123456 | True |
deliveries | Encloses list of delivery DTOs, see Delivery | True | ||
status | Transport status 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 |
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 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 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 Types
| CHAR(25) |
| False |
parameters | List of parameter DTOs, that enclose additional transport 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 | 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 Units, Statuses, and Enumerations | FLOAT | 30.6 | False |
weight | Load weight. See Units, Statuses, and Enumerations | FLOAT | 15.5 | False |
If no scheduling unit is provided, the “Standard” scheduling unit is used.
The Transporeon platform supports different sets of fields in the DTOs, depending on the specific business case. This means that not all fields are relevant for all business cases. An example is the RTV standalone case, where only a limited number of fields and parameters are considered when processing a transport on the Transporeon side.
There are parameters with reserved qualifiers that are relevant for specific post-processing logic. For example, the qualifier “cooled” represents whether the load needs to 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.