Get Route by ID
Fetch a single route in your depot with everything on it: the vehicle and driver, planned and actual times and distances, and its stops in visiting order. Each stop includes:
- its orders, with their line items and current status
- live progress once the route is under way: actual arrival and completion, failure reason, check-ins and driver phone calls
- proof of delivery (signature and photo URLs) once the driver has recorded it
The route's start and end points are not listed as stops. start_time is the departure from the start point and end_time is the arrival at the end point. If your depot uses partial orders, each stop lists only the line items delivered on that stop.
Any route in your depot can be fetched by id, including a route that is no longer part of its plan's current optimisation. plan_id links the route back to its plan. To discover route ids, use GET /routes. To get all of a plan's current routes in one call, use GET /plans/{id}.
Request
- Base URL: https://api.smartroutes.io/v2
- URL: https://api.smartroutes.io/v2/routes/{id}
- Auth: none declared
Path parameters
ID of the route to retrieve.
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.