Plans

Get Plans Page

Page through the plans in your depot, most recently updated first. Each plan carries its dispatched flag, total_time, created and updated timestamps, and a summary of each of its routes: the routes from its current optimisation, plus any route dispatched from an earlier optimisation of the same plan. Route summaries give a stop count, not the stops themselves. To get stops, orders and proof of delivery, call GET /plans/{id} or GET /routes/{id}.

Results are paged with the Link header and limit (1–100, default 100). See Paging. Keep following the rel=next URL until a response has none. updated_at_min returns only plans whose own updated timestamp is at or after the given time, and the rel=next URL carries it forward. A malformed page_info is rejected with 400 INVALID_INPUT. An updated_at_min in an unrecognised format, or a limit outside 1–100, is ignored rather than rejected.

A plan whose optimisation has not produced a result yet is listed with only id, total_time: 0 and an empty routes array. Deleted plans drop out of the list; the plans.deleted webhook tells you when a plan is deleted.

get/plans

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/plans
  • Auth: none declared

Query parameters

page_infostring

Information about the page for pagination. Generated by the OpenAPI

updated_at_minstring date-time

Minimum updated date and time for filtering.

limitinteger

Maximum number of plans to retrieve per page.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.