Overview DTOs
- ser_hcskb_api
Following tables contain the list of main DTOs that can be configured and transferred via SSI. “Directions” column indicates in which data transfer directions the DTO is used – inbound (data is pushed to Transporeon), outbound (data is pulled or pushed from Transporeon) or both directions.
Note, all listed DTOs can contain dependent child DTOs. For example, transport DTO contains transport attributes as well as deliveries, stations, prices, and measurement DTOs.
Transport Creation
Creation of transport is the first step for all business cases except Time Slot Management standalone. No matter if you are using complete transport execution on Transporeon platform or only Real-Time Visibility, Transporeon needs to know at least minimum information about the transport and its deliveries.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
transport | Transport data and dependent object DTOs as deliveries, loading station, etc. Deprecated, see transport_order | Both | PUT /v1/transports GET /v1/transport | ||
transport_order | Successor of transport with support for stops. Included in OpenApi version 2, SOAP and all other available protocols based on XSD | Both | POST /v2/transport_orders GET /v2/transport_orders/pull | ||
delivery | A new or a modified delivery as an independent object or as a part of a transport. Deprecated, see order | Inbound | PUT /v1/deliveries | ||
order | Successor of delivery, used together with transport_order. | Inbound | POST /v2/orders |
Transport Assignment
Following table contains other main DTOs related to transport assignment.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
transport_assignment | Status update of a transport assignment (Accepted, Declined, Expired) | Outbound | GET /v2/transport_assignments/pull | ||
offer | Details about an offer from a carrier | Outbound | GET /v2/offers GET /v2/offers/pull | ||
accept_offer | Acceptance of an offer | Inbound | POST /v2/accept_offers | ||
currency_rate | Currency rates | Inbound | POST /v2/currency_rates | ||
order_item_updates | Incremental update of order / delivery items. It can create, modify and delete items. | Inbound | POST /v2/order_item_updates |
Note, currency_rate DTO is only relevant for a custom integration that has been agreed and implemented as part of an integration project. Usage will be agreed with the responsible project manager.
Freight Matching
The following DTO / request is related to freight matching processes.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
freight_matching_forwarding | Forward a transport | Inbound | POST /v2/freight_matching_forwardings |
Vehicle Allocation
To provide visibility to the customer, the Transporeon platform requires a minimum information about transports, corresponding deliveries, and allocated vehicles. Following calls are available for vehicles search, allocation, and de-allocation:
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
vehicle_allocation | Vehicle allocation based on license plate and a transport reference | Inbound | POST /v2/vehicle_allocation | ||
vehicle_deallocation | Vehicle deallocation | Inbound | POST /v2/vehicle_deallocation | ||
vehicle_allocation_results | Feedback about a vehicle allocation | Outbound | GET /v2/vehicle_allocation_results/pull |
Transports Tracking & Tracing
Import and export of transport visibility statuses and export of calculated ETAs for transports.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
eta | Encloses estimated time of arrival data calculated for a transport. | Outbound | GET /v2/etas/pull | ||
process_status | Information of the process status, placed for a transport by a dispatcher or a driver of a transport executing carrier. | Both | GET /v2/process_statuses/pull POST /v2/process_statuses |
File Transfer
File DTO with its attributes is used to attach files to an object, like transport or delivery.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
file | File (Attachments) meta and binary data | Both | GET /v2/files/pull POST /v2/files |
Time Slot Management
SSI interface supports Transporeon TSM module. Following are main DTOs of Time Slot Management.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
booking | Time slot booking which has been created, modified or deleted | Outbound | GET /v2/bookings GET /v2/bookings/pull | ||
open_booking | Creation of an open booking. Open bookings are used to show users time slots that need to be booked with the possibility to pre-select certain data. | Inbound | POST /v2/open_bookings | ||
dispatch_status | Dispatch status information communicated by shipper for a transport to provide booking and transport visibility for the carriers | Inbound | POST /v2/dispatch_statuses | ||
quantity_contract | Information of a quantity contracts between the customers and their suppliers | Inbound | POST /v2/quantity_contracts |
Note, quantity contract DTO is only relevant for a custom integration that has been agreed and implemented as part of an integration project. Usage will be agreed with the responsible project manager.
Time Slot Management for Retailers
The following DTO is related to Time Slot Management for Retailers:
DTO | Description | Directions | Documentation | Processes | OpenAPI |
|---|---|---|---|---|---|
retail_orders | Retail Orders transfer one to many orders to Time Slot Management for Retailers | Inbound |
| POST /v2/retail_orders |
Surcharge Management
Following main DTOs are used to collect surcharges requested by your carriers, and to push related decisions back to the Transporeon platform.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
surcharge | Surcharge information requested by a carrier | Outbound | GET /v2/surcharges/pull | ||
accept_surcharge | Acceptance of a surcharge request with corresponding information | Inbound | POST /v2/accept_surcharges | ||
decline_surcharge | Declining of a surcharge request | Inbound | POST /v2/decline_surcharges |
Freight Settlement
Following DTOs are in place for Transporeon Freight Settlement module.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
request_settlement | Settlement request of shipper invoices, made by shipper | Inbound | POST /v2/request_settlements | ||
cancel_settlement | Cancellation of a settlement request | Inbound | POST /v2/cancel_settlements | ||
settlement_decision | Acceptance or declining of a settlement request | Outbound | GET /v2/settlement_decisions/pull |
Processing Results
Messages sent to our OpenApi server are processed asynchronously. An asynchronous reply can be provided to indicate the processing result.
DTO | Description | Directions | Documentation | Processes | OpenApi |
|---|---|---|---|---|---|
processing_result | Result of processing a message | Both | POST /v2/processing_results GET /v2/processing_results/pull |