Forwarder Transport Cancellation
- ser_hcskb_api
Use Case
A forwarder wants to cancel a transports or some it's orders, e.g. because the transport was cancelled by the forwarder's customer.
Description
To cancel a transport, send the same transport DTO with the value of ‘status’ attribute set to “D” (Deleted).
If the transport is assigned to a carrier, the carrier will be informed about the cancellation
If the transport is published as Spot Match, the publication ends and all price offers from carriers are discarded
If the transport is Direct Match and waiting for the carrier's confirmation, the confirmation request will be cancelled
In the following cases a cancellation will not be possible:
one day after the latest of all unloading (and loading dates) on deliveries or, if no loading and unloading dates were specified, the date of transport assignment
as soon as a loading status was set in the Time Slot Management, e.g. “Loading begin”
as soon as a Transport Visibility status was set for the transport, e.g. “ETA Estimated Time of Arrival“
There are two possibilities to cancel an order of a transport:
send the transport again with the order ‘status’ set to “D” (Deleted)
send the transport again without the order
Visual Illustration
Steps and API References
Resources
POST /v2/transport_orders Pushes transport orders for asynchronous processing.
POST /v2/orders Pushes orders for asynchronous processing.
Transport Order DTOs (DTOs for forwarders) are used to cancel transports.
Relevant Fields from Transport Order
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
number | Transport number, unique | CHAR(50) | 123456 | True |
status | Transport status: D Delete | CHAR (3) | D | True |
Relevant Fields from Order
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
number | Order / Delivery number, unique | CHAR(50) | D123 | True |
status | D Delete | CHAR(1) | D | True |