Delivery routes
Get a delivery route (scope: delivery:read)
GET
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
id*stringDelivery route id
Format
uuidOK
application/json- response
data*error*nullcurl -X GET "https://example.com/delivery-routes/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": "string", "name": "string", "status": "DRAFT", "route_date": "2019-08-24T14:15:22Z", "start_location_id": "7694f743-6daf-4514-8e49-2c201e61b66d", "start_address": {}, "start_latitude": 0, "start_longitude": 0, "round_trip": true, "vehicle_id": "e57c411b-caf2-4a2e-b2e8-e232824b6ddf", "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2", "capacity_kg": 0, "capacity_parcels": 0, "total_distance_km": 0, "total_duration_minutes": 0, "optimized_at": "2019-08-24T14:15:22Z", "optimizer": "string", "dispatched_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "gate_visit_id": "75f6ef13-3183-433b-95d7-bbf0a6ac5bf4", "notes": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "error": null}E-mail the route sheet to the assigned driver and mark the route DISPATCHED. 409 ROUTE_NOT_PLANNED; 422 NO_DRIVER, DRIVER_NO_EMAIL, NO_STOPS. The public driver page link is sent only to the driver, never returned. Requires Idempotency-Key. (scope: delivery:dispatch) POST
Previous Page
Own fleet vs courier over the last 30 or 90 days, from the snapshots stored when routes were completed: totals, saving, verdict counts, hybrid saving, CO2, break-even stop count and the routes that lost money. (scope: delivery:read) GET
Next Page