Description of dock scheduler time windows, warehouses and announcements.
Available methods
What is the scope of dock scheduler:
- create time window
- delete time window
- get list of time windows
- get list of warehouses
- get details of single time window by id
- get announcements list
Creating new time window
In order to create time window you have to add a warehouse and dock first – both can be added using Platform.
Json | Is required | Example | Type | Description |
valid_from | Yes |
2021-06-04
|
Timestamp | Time slot begin date |
valid_to
|
Yes |
2021-06-04
|
Timestamp | Time slot end date |
start_time
|
No |
09:00:00
|
Timestamp | Time slot begin hour |
end_time
|
No |
18:00:00
|
Timestamp | Time slot end hour |
remarks
|
No | Example remark | String | Time slot remarks |
range_type
|
Yes | Cycle | String | It can be set either to cycle or interval |
external_number
|
No | 123xyz | String | Time window external number |
carrier
|
Yes | Object | Carrier information | |
carrier.id
|
Yes | 1111111 | Int | Identification number of carrier company |
route
|
Yes | Object | Route information | |
route.spots | Yes | Array of objects |
Spot must contain either warehouse id or address
|
|
route.spots.order | Yes | 1 | Int | Information about the order of spot places – first spot always has spot_order set to 1 |
route.spots.warehouse_id | Yes/No | 29 | Int | If belongs_to_time_window = true, then warehouse_id is required |
route.spots.operations | Yes | Array | Operations to be completed in given spot (in each spot first operation always has operation_order set to 1) | |
route.spots.operations.operation_type | Yes | Loading | String |
The first operation has to be of type loading and the last operation of type unloading
|
route.spots.operations.order | Yes | 1 | Int | Operation order at a given spot |
route.spots.operations.belongs_to_time_window | Yes | True | Boolean | Defines if operation belongs to time slot |
route.spots.order | Yes | 2 | Int | Information about the order of spot places |
route.spots.address | Yes | Object | If belongs_to_time_window = false, then only address is required | |
route.spots.address.name | Yes | Spot 2 | String | Address name |
route.spots.address.locality | No |
Wrocław
|
String | Town |
route.spots.address.postal_code | No |
50-002
|
String | Postal code |
route.spots.address.country | No | PL | String | Country ISO value |
route.spots.address.street | No | Racławicka | String | Street |
route.spots.address.number | No | 2 | Int | Number |
route.spots.operations | Yes | Array | Operations to be completed in given spot (in each spot first operation always has operation_order set to 1) | |
route.spots.operations.operation_type | Yes | Unloading | String | The first operation has to be of type loading and the last operation of type unloading |
route.spots.operations.order | Yes | 1 | Int | Operation order at a given spot |
route.spots.operations.belongs_to_time_window | Yes | False | Boolean | Defines if operation belongs to time slot |
Request example
{ "valid_from": "2021-06-04", "valid_to": "2021-06-04", "start_time": "09:00:00", "end_time": "18:00:00", "remarks": "Example remark", "range_type": "CYCLE", "external_number": "123xyz", "carrier": { "id": 1013865 }, "route": { "spots": [ { "order": 1, "warehouse_id": 29, "operations": [ { "operation_type": "LOADING", "order": 1, "belongs_to_time_window": true } ] }, { "order": 2, "address": { "name": "Spot 2", "locality": "Wrocław", "postal_code": "50-002", "country": "pl", "street": "Raclawicka", "number": "2" }, "operations": [ { "operation_type": "UNLOADING", "order": 1, "belongs_to_time_window": false } ] } ] } }
Get list of time windows
Json | Example | Type | Description |
content | Array of objects | List of time windows | |
content.carrier
|
Object | Carrier information | |
content.carrier.id
|
1111111 | Int | Identification number of carrier company |
content.carrier.legal_name | Test company | String | Company legal name |
content.created_at |
2020-09-29T08:54:24
|
Timestamp | Time window creation date |
content.end_time
|
18:00:00
|
Timestamp | Time slot end hour |
content.external_number
|
123xyz | String | Time window external number |
content.freight_order
|
Object | Data from freight and order based on which a time slot has been created automatically. Will be null if time slot was added manually. | |
content.freight_order.driver | Object | Driver data | |
content.freight_order.driver.document_type | Passport | String | ID card, passport, driving licence, etc |
content.freight_order.driver.full_name |
Adam Kowalski
|
String | Driver first and last name |
content.freight_order.driver.id_number |
11111abc
|
String |
Document number
|
content.freight_order.driver.phone_number | 11111111 | Int | Driver phone number |
content.freight_order.freight_id | 766315 | Int | Freight id |
content.freight_order.freight_reference_number |
FR/2021/06/15/C9YS
|
String | Freight number |
content.freight_order.order_id |
349c6245-e004-4ab4-ac1d-c4e32f8cbde9
|
String | Transport order id |
content.freight_order.order_reference_number |
2021/06/15/5
|
String | Transport order number |
content.freight_order.vehicle | Object | Vehicle data | |
content.freight_order.vehicle.trailer_plate_number |
DW11111
|
Int | Trailer plate number |
content.freight_order.vehicle.truck_plate_number | DW11112 | Int | Truck plate number |
content.id |
5996
|
Int | Time window ID |
content.operation_type
|
Loading | String | Operation type can be one from the following: LOADING, UNLOADING, ANY |
content.range_type
|
Cycle | String | It can be set either to cycle or interval |
content.reference_number
|
DS/13752DF
|
String | Reference number assigned automatically during creation of a new time window |
content.route
|
Object | Route information | |
content.route.loading_place | Object |
Loading place address
|
|
content.route.loading_place.coordinates | Object | Loading place coordinates | |
content.route.loading_place.coordinates.latitude |
50.95
|
Float | Loading place latitude |
content.route.loading_place.coordinates.longitude |
17.29
|
Float | Loading place longitude |
content.route.loading_place.country | PL | String | Loading place country ISO value |
content.route.loading_place.locality | Wrocław | String | Loading place town |
content.route.loading_place.name | Magazine | String | Loading place name |
content.route.loading_place.number | 26 | String | Loading place number |
content.route.loading_place.postal.code | 55-200 | String | Loading place postal code |
content.route.loading_place.street | Street | String | Loading place street |
content.route.unloading_place | Object | Unloading place address | |
content.route.unloading_place.coordinates | Object | Unloading place coordinates | |
content.route.unloading_place.coordinates.latitude | 33 | Float |
Unloading place latitude
|
content.route.unloading_place.coordinates.longitude | 66 | Float |
Unloading place longitude
|
content.route.unloading_place.country | AF | String | Unloading place country ISO value |
content.route.unloading_place.locality | Kabul | String | Unloading place town |
content.route.unloading_place.name | Null | String | Unloading place name |
content.route.unloading_place.number | 12 | String | Unloading place number |
content.route.unloading_place.postal_code |
50-002
|
String | Unloading place postal code |
content.route.unloading_place.street | Street | String | Unloading place street |
content.start_time
|
12:30:00
|
Timestamp | Time slot begin hour |
content.status
|
OCCUPIED
|
String | Time slot status. Can be one from the following: OCCUPIED, DELETED, AVAILABLE, USED |
content.valid_from
|
2021-06-16
|
Timestamp | Time slot begin date |
content.valid_to
|
2021-06-16
|
Timestamp | Time slot end date |
content.warehouse
|
Object | Warehouse information | |
content.warehouse.id
|
2391
|
Int | Warehouse id number |
content.warehouse.name
|
Magazine | String | Warehouse name |
content.warehouse.time_zone
|
Object | Time zone information | |
content.warehouse.id.time_zone.id
|
Europe/Warsaw | String | Time zone name |
content.warehouse.id.time_zone.offset
|
+02:00
|
String | UTC offset |
Get time window by id
Json | Example | Type | Description |
carrier
|
Object | Carrier information | |
carrier.id
|
1111111 | Int | Identification number of carrier company |
carrier.legal_name | Test company | String | Company legal name |
created_at |
2020-09-29T08:54:24
|
Timestamp | Time window creation date |
end_time
|
18:00:00
|
Timestamp | Time slot end hour |
external_number
|
123xyz | String | Time window external number |
freight_order
|
Object | Data from freight and order based on which a time slot has been created automatically. Will be null if time slot was added manually. | |
freight_order.driver | Object | Driver data | |
freight_order.driver.document_type | Passport | String | Driver ID card, passport, driving licence, etc |
freight_order.driver.full_name |
Adam Kowalski
|
String | Driver first and last name |
freight_order.driver.id_number |
11111111
|
String |
Driver document number
|
freight_order.driver.phone_number | 11111111 | Int | Driver phone number |
freight_order.freight_id | 766315 | Int | Freight id |
freight_order.freight_reference_number |
FR/2021/06/15/C9YS
|
String | Freight number |
freight_order.order_id |
349c6245-e004-4ab4-ac1d-c4e32f8cbde9
|
String | Transport order id |
freight_order.order_reference_number |
2021/06/15/5
|
String | Transport order number |
freight_order.vehicle | Object | Vehicle data | |
freight_order.vehicle.trailer_plate_number |
DW11111
|
Int | Trailer plate number |
freight_order.vehicle.truck_plate_number | DW11112 | Int | Truck plate number |
id |
5996
|
Int | Time window ID |
operation_type
|
Loading | String | The first operation has to be of type loading and the last operation of type unloading |
ramps
|
Object | Information about ramps | |
ramps.id | 3223 | Int | Ramp id |
ramps.name | null | String | Ramp name |
ramps.operation_type | Any | String | It can be loading, unloading or any |
ramps.ramp_number | 3 | Int | Ramp number |
ramps.ramp_type | Ramp | String | It can be ramp, silo, gate or crane |
range_type
|
String | It can be set either to cycle or interval | |
reference_number
|
DS/13752DF
|
String | Reference number assigned automatically during creation of a new time window |
route
|
Object | Route information | |
route.spots
|
Object | Spots information | |
route.spots.address | Object |
Address
|
|
route.spots.address.coordinates | Object | Coordinates | |
route.spots.address.coordinates.latitude |
50.95
|
Float | Latitude |
route.spots.addresscoordinates.longitude |
17.29
|
Float | Longitude |
route.spots.address.country | PL | String | Country ISO value |
route.spots.address.locality | Wrocław | String | Town |
route.spots.address.name | Magazine | String | Name |
route.spots.address.number | 26 | String | Number |
route.spots.address.postal.code | 55-200 | String | Postal code |
route.spots.address.street | Street | String | Street |
route.spots.operations | Array | Operations in given spot | |
route.spots.operations.operation_type |
LOADING
|
String | Operation type can be one from the following: LOADING, UNLOADING, ANY |
route.spots.operations.order | 1 | Int | Operation order at a given spot |
route.spots.operations.time_window_id |
8582
|
Int | Time window id – it can be null if spot doesn’t belong to time window |
route.spots.order | 1 | Int | Information about the order of spot places – first spot always has spot_order set to 1 |
route.address | Object | Address | |
route.address.coordinates | Object | Coordinates | |
route.address.coordinates.latitude | 33 | Float | Latitude |
route.address.coordinates.longitude | 66 | Float | Longitude |
route.address.country | AF | String | Country ISO value |
route.address.locality | Kabul | String | Town |
route.address.name | Null | String | Name |
route.address.number | 12 | String | Number |
route.address.postal_code |
50-002
|
String | Postal code |
route.address.street | Street | String | Street |
route.spots.operations | Array | Operations in given spot | |
route.spots.operations.operation_type |
UNLOADING
|
String | Either loading or unloading |
route.spots.operations.order | 1 | Int | Operation order at a given spot |
route.spots.operations.time_window_id |
Null
|
Int | Time window id – it can be null if spot doesn’t belong to time window |
route.spots.order | 2 | Int | Information about the order of spot places – first spot always has spot_order set to 1 |
start_time
|
12:30:00
|
Timestamp | Time slot begin hour |
status
|
OCCUPIED
|
String | Time slot status. Can be one from the following: OCCUPIED, DELETED, AVAILABLE, USED |
valid_from
|
2021-06-16
|
Timestamp | Time slot begin date |
valid_to
|
2021-06-16
|
Timestamp | Time slot end date |
warehouse
|
Object | Warehouse information | |
warehouse.id
|
2391
|
Int | Warehouse id number |
warehouse.name
|
Magazine | String | Warehouse name |
warehouse.time_zone
|
Object | Time zone information | |
warehouse.id.time_zone.id
|
Europe/Warsaw | String | Time zone name |
warehouse.id.time_zone.offset
|
+02:00
|
String | UTC offset |
Get warehouses list
Json | Example | Type | Description |
address | Object | Address | |
address.coordinates | Object | Coordinates | |
address.coordinates.latitude |
37.73952
|
Float | Latitude of the point |
address.coordinates.longitude |
25.66874
|
Float | Longitude of the point |
address.country | PL | String | Country ISO value |
address.locality | Wrocław | String | Town |
address.name | Location 1 | String | Location name |
address.number | 1 | String | Number |
address.postal_code |
50-430
|
String | Postal code |
address.remarks | Address remarks | String | Address additional information |
address.street |
Brzeska
|
String | Street |
id |
2381
|
Int | Warehouse Id |
is_active | True | Boolean | Is warehouse active |
is_locked | False | Boolean | Is warehouse locked |
name | Magazine 1 | String | Warehouse name |
operation_time | 60 | Int | Single operation time |
time_zone | Object | Time zone information | |
time_zone.id |
Europe/Warsaw
|
String | Time zone name |
time_zone.offset |
+02:00
|
String | UTC offset |
Get announcements list
Json | Example | Type | Description |
content | Array of objects | List of announcements | |
content.arrival_delay | null | Int | Delay in minutes between scheduled arrival time and present time |
content.carrier | Object | Information about carrier | |
content.carrier.id | 11111 | Int | Identification number of company assigned to announcement |
content.carrier.legal_name | Konto testowe carrier | String | Assigned company name |
content.date_from | 2021-12-10 13:00:00 | Timestamp | Announcement date from |
content.date_to | 2021-12-10 13:30:00 | Timestamp | Announcement date to |
content.driver | Object | Information about driver | |
content.driver.document | Object | Information about driver’s document | |
content.driver.document.issuing_authority | Burmistrz | String | Driver’s document issuing authority |
content.driver.document.number | 31123 | String | Driver’s document number |
content.driver.document.type | IDENTITY CARD | String | Driver’s document type can be one from the following: IDENTITY_CARD, PASSPORT, DRIVING_LICENSE, RESIDENCE_CARD, OTHER |
content.driver.full_name | Jan Kowalski | String | Driver’s full name |
content.driver.phone_number | null | String | Driver’s phone number |
content.id | 24612 | Int | Announcement id |
content.notes | null | String | Notes |
content.operation_type | LOADING | String | Operation type. Can be either loading, unloading or undeclared |
content.order_reference_number |
2022/01/25/9
|
String | Reference number of order based on which an announcement was created |
content.ramp | Object | Ramp information | |
content.ramp.id | 834 | Int | Ramp id |
content.ramp.is_active | True | Boolean | Is ramp active |
content.ramp.is_locked | False | Boolean | Is ramp blocked |
content.ramp.name | Rampa | String | Ramp name |
content.ramp.warehouse | Object | Warehouse information | |
content.ramp.warehouse.address | Object | Warehouse address | |
content.ramp.warehouse.address.id | 259 | Int | Warehouse id |
content.ramp.warehouse.address.locality | Warszawa | String | Warehouse locality |
content.ramp.warehouse.address.name | Magazyn testowy | String | Warehouse name |
content.ramp.warehouse.id | 259 | Int | Warehouse id |
content.ramp.warehouse.is_active | True | Boolean | Is warehouse active |
content.ramp.warehouse.is_locked | False | Boolean | Is warehouse blocked |
content.ramp.warehouse.name | Magazyn testowy | String | Warehouse name |
content.ramp.warehouse.time_zone | Object | Warehouse timezone | |
content.ramp.warehouse.time_zone.id | Europe/Warsaw | String | Timezone id |
content.ramp.warehouse.time_zone.offset | “+01:00” | String | Timezone offset |
content.ramp.warehouse.time_zone.offset_minutes | 60 | Int | Timezone offset in minutes |
content.reference_number | DS/CD251D9/1 | String | Announcement reference number |
content.remarks | null | String | Remarks |
content.route | Object | Route informatiom | |
content.route.loading_place | Object | Loading place information | |
content.route.loading_place.country | PL | String | Loading place country using ISO values |
content.route.loading_place.locality | Warszawa | String | Loading place locality |
content.route.loading_place.name | Magazyn testowy | String | Loading place name |
content.route.loading_place.number | 19a | String | Loading place number |
content.route.loading_place.postal_code | 02-517 | String | Loading place postal code |
content.route.loading_place.street | Rakowiecka | String | Loading place street |
content.route.unloading_place | Object | Unloading place information | |
content.route.unloading_place.country | PL | String | Unloading place country using ISO values |
content.route.unloading_place.locality | Wrocław | String | Unloading place locality |
content.route.unloading_place.name | Rozładunek | String | Unloading place name |
content.route.unloading_place.number | null | String | Unloading place number |
content.route.unloading_place.postal_code | 50-001 | String | Unloading place postal code |
content.route.unloading_place.street | null | String | Unloading place street |
content.shipper | Object | Shipper information | |
content.shipper.id | 2222222 | Int | Shipper identification number |
content.shipper.legal_name | Konto testowe shipper | String | Shipper company name |
content.stage | null | String |
Announcement stage. Can be one from the following: INITIAL, CONFIRMED, VEHICLE_ARRIVED, LOADING_STARTED, UNLOADING_STARTED, LOADING_FINISHED, UNLOADING_FINISHED, VEHICLE_LEFT, NOT_LOADED, NOT_UNLOADED, LOADING_REFUSED, UNLOADING_REFUSED, NO_VEHICLE
|
content.status | CONFIRMED | String |
Announcement status. Can be one from the following: INITIAL, CONFIRMED, IN_PROGRESS, FINISHED, DELETED
|
content.template | Object | Information about announcement template | |
content.template.id | 1 | Int | Template id |
content.template.name | BASIC | String | Template name |
content.time_window | Object | Time window information | |
content.time_window.external_number | 123xyz | String | Time window external number |
content.time_window.id | 16611 | Int | Time window id |
content.time_window.reference_number | DS/CD251D9 | String | Time window reference number |
content.vehicle | Object | Vehicle information | |
content.vehicle.trailer_plate_number | 1234xyz | String | Trailer plate number |
content.vehicle.truck_plate_number | 123xyz | String | Truck plate number |
content.templates | Array of objects | Information about available templates | |
content.templates.id | 19 | Int | Template id |
content.templates.parameters | Array of objects | Template parameters | |
content.templates.parameters.default_value | null | String |
Can be null or one of the following for documents: IDENTITY_CARD, PASSPORT, DRIVING_LICENSE, RESIDENCE_CARD, OTHER
|
content.templates.parameters.group | DRIVER | String | Can be one from the following: DRIVER, VEHICLE, OTHER |
content.templates.parameters.is_mandatory | True | Boolean | Is parameter mandatory |
content.templates.parameters.name | DRIVER_NAME | String | Parameter name. For driver group: DRIVER_NAME, DRIVER_PHONE_NUMBER, DRIVER_COUNTRY, DRIVER_LANGUAGE, DRIVER_DOCUMENT_TYPE_AND_NUMBER, DRIVER_DOCUMENT_ISSUING_AUTHORITY, DRIVER_OTHER_DOCUMENT_TYPE_AND_NUMBER, DRIVER_OTHER_DOCUMENT_ISSUING_AUTHORITY For vehicle group: TRUCK_PLATE_NUMBER, TRAILER_PLATE_NUMBER, VEHICLE_MANUFACTURER, COMBUSTION_NORM For other group: REMARKS |