Tentative/Final Planning
GET Tentative planning¶
curl 'https://{root_url}/bucket-planning/v2/buckets/362d95f9-963b-49cf-b00a-aa5c4ac2d497/routes/?tentative=true' \
-H 'apikey: {YOUR_API_KEY}'
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "b2ad0d19-4361-4bcc-b156-96400250a215",
"algorithm_fields": {
"departure_stop": {
"min_time": "2020-11-13T16:55:00Z",
"max_time": "2020-11-13T17:00:00Z",
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"stop_time": 299.0
},
"arrival_stop": {
"min_time": "2020-11-13T17:00:00Z",
"max_time": "2020-11-14T00:00:00Z",
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"stop_time": 900.0
},
"timeslot_windows": [
{
"min_time": "2020-11-13T16:55:00Z",
"max_time": "2020-11-13T17:00:00Z"
},
{
"min_time": "2020-11-13T18:00:00Z",
"max_time": "2020-11-13T19:00:00Z"
},
{
"min_time": "2020-11-13T19:00:00Z",
"max_time": "2020-11-13T20:00:00Z"
},
{
"min_time": "2020-11-13T22:00:00Z",
"max_time": "2020-11-14T00:00:00Z"
}
],
"break_duration": 1800,
"break_interval": 10000
},
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"resource": "bce90ae0-3fa3-4307-8c51-0e74d152900b",
"events": [
{
"id": "3fdc56eb-2955-4a01-bcd0-293ff3d4c579",
"algorithm_fields": {
"stop_time": 299.0,
"capacity": 0.0,
"eta": "2020-11-13T16:55:00Z",
"time_to_next": 0.0,
"dist_to_next": 0.0
},
"event_type": "depot",
"address": null,
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T16:55:00Z",
"max_time": "2020-11-13T17:00:00Z",
"sort_key": 0,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": null,
"modified": "2020-11-13T10:31:29Z",
"external_data": null
},
{
"id": "32979a54-91cd-4595-99b6-fe5ed48a6f39",
"algorithm_fields": {
"stop_time": 540.0,
"capacity": 14.0,
"eta": "2020-11-13T18:00:00Z",
"time_to_next": 424.0,
"dist_to_next": 4055.0,
"frozen_window": null
},
"event_type": "delivery",
"address": {
"street": "Eerstestraat",
"postalcode": "1111AA",
"house_number": 1,
"city": "Stad",
"country": "Netherlands",
"region": "Europe"
},
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T18:00:00Z",
"max_time": "2020-11-13T20:00:00Z",
"sort_key": 1,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "initialized",
"state_reason": "_/32979a54-91cd-4595-99b6-fe5ed48a6f39",
"created": "2020-11-13T10:27:37Z",
"modified": "2020-11-13T10:31:29Z",
"external_data": {}
},
{
"id": "502bf132-85db-4949-9975-07a39f082f89",
"algorithm_fields": {
"stop_time": 1800.0,
"capacity": 0.0,
"eta": "2020-11-13T18:16:39Z",
"frozen_window": null
},
"event_type": "break",
"address": null,
"geo_point": null,
"min_time": null,
"max_time": null,
"sort_key": 2,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": null,
"modified": "2020-11-13T10:31:29Z",
"external_data": null
},
{
"id": "f62112f9-6ed2-401e-94df-0042f312d7ed",
"algorithm_fields": {
"stop_time": 690.0,
"capacity": 4.9,
"eta": "2020-11-13T18:46:04Z",
"time_to_next": 162.0,
"dist_to_next": 1607.0,
"frozen_window": null
},
"event_type": "delivery",
"address": {
"street": "Tweedestraat",
"postalcode": "2222BB",
"house_number": 2,
"city": "Dorp",
"country": "Netherlands",
"region": "Europe"
},
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T18:00:00Z",
"max_time": "2020-11-13T20:00:00Z",
"sort_key": 3,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "initialized",
"state_reason": "_/f62112f9-6ed2-401e-94df-0042f312d7ed",
"created": "2020-11-13T10:27:39Z",
"modified": "2020-11-13T10:31:29Z",
"external_data": {}
},
{
"id": "2f3ec672-af64-43bd-8fe8-f6262cefcd33",
"algorithm_fields": {
"stop_time": 900.0,
"capacity": 0.0,
"eta": "2020-11-13T20:40:06Z"
},
"event_type": "depot",
"address": null,
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T17:00:00Z",
"max_time": "2020-11-14T00:00:00Z",
"sort_key": 4,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": null,
"modified": "2020-11-13T10:31:29Z",
"external_data": null
}
],
"current_state": "planned",
"old_state": "new",
"state_reason": null,
"created": "2020-11-13T10:27:36Z",
"modified": "2020-11-13T10:31:29Z",
"external_data": null,
"capacity_threshold": 0.3,
"time_threshold": 1.0,
"minimum_trip_length": 900,
"intermediate_depot_duration": 1800
}
]
}
GET Final planning¶
curl 'https://{root_url}/bucket-planning/v2/buckets/362d95f9-963b-49cf-b00a-aa5c4ac2d497/routes/?event__order_by=sort_key \
-H 'apikey: {YOUR_API_KEY}'
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "b2ad0d19-4361-4bcc-b156-96400250a215",
"algorithm_fields": {
"departure_stop": {
"min_time": "2020-11-13T16:55:00Z",
"max_time": "2020-11-13T17:00:00Z",
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"stop_time": 299.0
},
"arrival_stop": {
"min_time": "2020-11-13T17:00:00Z",
"max_time": "2020-11-14T00:00:00Z",
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"stop_time": 900.0
},
"timeslot_windows": [
{
"min_time": "2020-11-13T16:55:00Z",
"max_time": "2020-11-13T17:00:00Z"
},
{
"min_time": "2020-11-13T18:00:00Z",
"max_time": "2020-11-13T19:00:00Z"
},
{
"min_time": "2020-11-13T19:00:00Z",
"max_time": "2020-11-13T20:00:00Z"
},
{
"min_time": "2020-11-13T22:00:00Z",
"max_time": "2020-11-14T00:00:00Z"
}
],
"break_duration": 1800,
"break_interval": 10000
},
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"resource": "bce90ae0-3fa3-4307-8c51-0e74d152900b",
"events": [
{
"id": "3fdc56eb-2955-4a01-bcd0-293ff3d4c579",
"algorithm_fields": {
"stop_time": 299.0,
"capacity": 0.0,
"eta": "2020-11-13T16:55:00Z",
"time_to_next": 0.0,
"dist_to_next": 0.0
},
"event_type": "depot",
"address": null,
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T16:55:00Z",
"max_time": "2020-11-13T17:00:00Z",
"sort_key": 0,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": null,
"modified": "2020-11-13T10:31:29Z",
"external_data": null
},
{
"id": "32979a54-91cd-4595-99b6-fe5ed48a6f39",
"algorithm_fields": {
"stop_time": 540.0,
"capacity": 14.0,
"eta": "2020-11-13T18:00:00Z",
"time_to_next": 424.0,
"dist_to_next": 4055.0,
"frozen_window": null
},
"event_type": "delivery",
"address": {
"street": "Eerstestraat",
"postalcode": "1111AA",
"house_number": 1,
"city": "Stad",
"country": "Netherlands",
"region": "Europe"
},
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T18:00:00Z",
"max_time": "2020-11-13T20:00:00Z",
"sort_key": 1,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "initialized",
"state_reason": "_/32979a54-91cd-4595-99b6-fe5ed48a6f39",
"created": "2020-11-13T10:27:37Z",
"modified": "2020-11-13T10:31:29Z",
"external_data": {}
},
{
"id": "502bf132-85db-4949-9975-07a39f082f89",
"algorithm_fields": {
"stop_time": 1800.0,
"capacity": 0.0,
"eta": "2020-11-13T18:16:39Z"
},
"event_type": "break",
"address": null,
"geo_point": null,
"min_time": null,
"max_time": null,
"sort_key": 2,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": null,
"modified": "2020-11-13T10:31:29Z",
"external_data": null
},
{
"id": "f62112f9-6ed2-401e-94df-0042f312d7ed",
"algorithm_fields": {
"stop_time": 690.0,
"capacity": 4.9,
"eta": "2020-11-13T18:46:04Z",
"time_to_next": 162.0,
"dist_to_next": 1607.0,
"frozen_window": null
},
"event_type": "delivery",
"address": {
"street": "Tweedestraat",
"postalcode": "2222BB",
"house_number": 2,
"city": "Dorp",
"country": "Netherlands",
"region": "Europe"
},
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T18:00:00Z",
"max_time": "2020-11-13T20:00:00Z",
"sort_key": 3,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "initialized",
"state_reason": "_/f62112f9-6ed2-401e-94df-0042f312d7ed",
"created": "2020-11-13T10:27:39Z",
"modified": "2020-11-13T10:31:29Z",
"external_data": {}
},
{
"id": "2f3ec672-af64-43bd-8fe8-f6262cefcd33",
"algorithm_fields": {
"stop_time": 900.0,
"capacity": 0.0,
"eta": "2020-11-13T20:40:06Z"
},
"event_type": "depot",
"address": null,
"geo_point": {
"latitude": 52.010285,
"longitude": 4.375604
},
"min_time": "2020-11-13T17:00:00Z",
"max_time": "2020-11-14T00:00:00Z",
"sort_key": 4,
"bucket": "362d95f9-963b-49cf-b00a-aa5c4ac2d497",
"route": "b2ad0d19-4361-4bcc-b156-96400250a215",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": null,
"modified": "2020-11-13T10:31:29Z",
"external_data": null
}
],
"current_state": "planned",
"old_state": "new",
"state_reason": null,
"created": "2020-11-13T10:27:36Z",
"modified": "2020-11-13T10:31:29Z",
"external_data": null,
"capacity_threshold": 0.3,
"time_threshold": 1.0,
"minimum_trip_length": 900,
"intermediate_depot_duration": 1800
}
]
}
GET Final planning: response from a bucket went through frozen state¶
curl 'https://{root_url}/bucket-planning/v2/buckets/362d95f9-963b-49cf-b00a-aa5c4ac2d497/routes/?event__order_by=sort_key \
-H 'apikey: {YOUR_API_KEY}'
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "2f7d8166-ab25-423a-a32d-e412c575ae75",
"algorithm_fields": {
"departure_stop": {
"min_time": "2017-11-13T15:29:59Z",
"max_time": "2017-11-13T17:00:00Z",
"geo_point": {
"latitude": 52.3968885,
"longitude": 4.789829
},
"stop_time": 1500
},
"arrival_stop": {
"min_time": "2017-11-13T17:00:00Z",
"max_time": "2017-11-14T00:00:00Z",
"geo_point": {
"latitude": 52.294429,
"longitude": 4.958761
},
"stop_time": 900
},
"timeslot_windows": [
{
"min_time": "2017-11-13T15:29:59Z",
"max_time": "2017-11-13T17:00:00Z"
},
{
"min_time": "2017-11-13T17:00:00Z",
"max_time": "2017-11-13T17:30:00Z"
},
{
"min_time": "2017-11-13T17:30:00Z",
"max_time": "2017-11-13T18:00:00Z"
},
{
"min_time": "2017-11-13T18:00:00Z",
"max_time": "2017-11-13T19:00:00Z"
},
{
"min_time": "2017-11-13T19:00:00Z",
"max_time": "2017-11-13T20:00:00Z"
},
{
"min_time": "2017-11-13T20:00:00Z",
"max_time": "2017-11-13T21:00:00Z"
},
{
"min_time": "2017-11-13T21:00:00Z",
"max_time": "2017-11-13T21:30:00Z"
},
{
"min_time": "2017-11-13T21:30:00Z",
"max_time": "2017-11-13T22:00:00Z"
},
{
"min_time": "2017-11-13T22:00:00Z",
"max_time": "2017-11-14T00:00:00Z"
}
],
"break_duration": 1,
"break_interval": 36000
},
"bucket": "a1648770-8fa7-4c7b-8d4e-8ee538cd42d9",
"resource": "c1f61470-b1c8-411e-82b3-78823a337194",
"events": [
{
"id": "89ab1f9c-30ca-46d9-88ef-af5e3b29ba4e",
"algorithm_fields": {
"stop_time": 1500,
"capacity": 0,
"eta": "2017-11-13T16:11:26Z",
"time_to_next": 1414,
"dist_to_next": 42438
},
"event_type": "depot",
"address": null,
"geo_point": {
"latitude": 52.3968885,
"longitude": 4.789829
},
"min_time": "2017-11-13T15:29:59Z",
"max_time": "2017-11-13T17:00:00Z",
"sort_key": 0,
"bucket": "a1648770-8fa7-4c7b-8d4e-8ee538cd42d9",
"route": "2f7d8166-ab25-423a-a32d-e412c575ae75",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": "2022-09-09T15:07:34Z",
"modified": "2022-09-09T15:07:34Z",
"external_data": null,
"capacity_vector": null
},
{
"id": "87c67059-2afb-4f96-80a5-617666e4cd2c",
"algorithm_fields": {
"stop_time": 540,
"capacity": 1.4,
"eta": "2017-11-13T17:00:00Z",
"time_to_next": 1771,
"dist_to_next": 49820,
"frozen_window": {
"max_time": "2017-11-13T17:05:00Z",
"min_time": "2017-11-13T17:00:00Z"
}
},
"event_type": "delivery",
"address": {
"street": "t Boonrak",
"postalcode": "2235EH",
"house_number": 70,
"city": "Valkenburg",
"country": "NL",
"region": "Europe"
},
"geo_point": {
"latitude": 52.1785388,
"longitude": 4.4361823
},
"min_time": "2017-11-13T17:00:00Z",
"max_time": "2017-11-13T22:00:00Z",
"sort_key": 1,
"bucket": "a1648770-8fa7-4c7b-8d4e-8ee538cd42d9",
"route": "2f7d8166-ab25-423a-a32d-e412c575ae75",
"current_state": "planned",
"old_state": "initialized",
"state_reason": "_/87c67059-2afb-4f96-80a5-617666e4cd2c",
"created": "2022-09-09T09:14:13Z",
"modified": "2022-09-09T15:07:34Z",
"external_data": {
"3s-codes": [
"3SVERS0202260",
"3SVERS0225897"
],
"ShipmentId": "127221",
"CustomerName": "Hoogvliet",
"RecipientName": "Hoogvliet Test"
},
"capacity_vector": null
},
{
"id": "fe961971-7b7e-4b4a-bbc4-68902ef2216f",
"algorithm_fields": {
"stop_time": 900,
"capacity": 0,
"eta": "2017-11-13T17:38:31Z"
},
"event_type": "depot",
"address": null,
"geo_point": {
"latitude": 52.294429,
"longitude": 4.958761
},
"min_time": "2017-11-13T17:00:00Z",
"max_time": "2017-11-14T00:00:00Z",
"sort_key": 2,
"bucket": "a1648770-8fa7-4c7b-8d4e-8ee538cd42d9",
"route": "2f7d8166-ab25-423a-a32d-e412c575ae75",
"current_state": "planned",
"old_state": "empty",
"state_reason": null,
"created": "2022-09-09T15:07:34Z",
"modified": "2022-09-09T15:07:34Z",
"external_data": null,
"capacity_vector": null
}
],
"current_state": "planned",
"old_state": "new",
"state_reason": null,
"created": "2022-09-09T09:06:38Z",
"modified": "2022-09-09T15:07:34Z",
"external_data": null,
"capacity_threshold": null,
"capacity_threshold_vector": null,
"time_threshold": null,
"minimum_trip_length": 0,
"intermediate_depot_duration": 0,
"resource_route_tag": null
}
]
}