Dispatch Status
- ser_hcskb_api
The Shipper Standard Interfaces provide the possibility to place dispatch status for bookings.
Dispatch statuses indicate the current status of a booking in the workflow it represents. For example, the truck has arrived, is being loaded or has left the yard. This is displayed in the front-end applications using color codes.
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
comment | Dispatch status comment, free text | CHAR(255) | My status comment | False |
driver_mobile | Mobile phone number of the driver | CHAR(50) | +49555555454 | False |
driver_name | Name of the driver | CHAR(50) | John Doe | False |
entries | Includes corresponding status entries, see Dispatch Status Entry | True | ||
extensions | A list of extension elements, see Booking Extension Entry | True | ||
gate | Gate of the corresponding booking | CHAR(50) | Gate 1 | Required if more than 1 booking has the same reference (transport_number) |
licence_plate | Licence plate number of the vehicle | CHAR(50) | UL-TP 123 | False |
loading_type | Possible values are PICKUP, DELIVERY | CHAR(50) | DELIVERY | False |
location | Location of the corresponding booking | CHAR(50) | Ulm | Required if more than 1 booking has the same reference (transport_number) |
transport_number | Transport number | CHAR(50) | ABC123 | True |
booking_id | Booking Id of the corresponding booking | Long (64 bit) | 123456 | False |
Â