Get Plan by ID
Fetch a plan in your depot with its full routes and its unserved stops (the stops the optimiser could not fit on any route). Each route includes its vehicle, timings and stops in visiting order. Each stop includes its orders and line items, live progress and proof of delivery, in the same shape as GET /routes/{id}. A plan's routes are the routes from its current optimisation, plus any route dispatched from an earlier optimisation of the same plan.
While the optimisation started by POST /plans/optimise/orders is still running on a new plan, routes and unserved are both empty arrays. See that endpoint for polling guidance and its limits on failure signals, or poll GET /plans/optimise/{id}. To list plans without their stops, use GET /plans.
Request
- Base URL: https://api.smartroutes.io/v2
- URL: https://api.smartroutes.io/v2/plans/{id}
- Auth: none declared
Path parameters
ID of the plan to retrieve.
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.