Plans

Get Optimisation Job by ID

Check whether an optimisation started with POST /plans/optimise/orders or POST /plans/optimise/orders-for-ids is still running. Pass the optimisation.id (a UUID) that the call returned. The response has the same shape as that call's response: optimisation.in_progress, plus the plan the job writes into. plan.dispatched becomes true once the plan is dispatched, for example by auto_dispatch.

in_progress: false means the job has stopped, not that it succeeded. A failed optimisation also reports false, and this endpoint does not tell you which outcome you got. Fetch GET /plans/{id} with plan.id to see the result, and use the polling cadence and hard timeout described under POST /plans/optimise/orders. An optimisation id that does not exist, or that belongs to another depot, answers 404 RESOURCE_NOT_FOUND.

get/plans/optimise/{id}

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/plans/optimise/{id}
  • Auth: none declared

Path parameters

idstring required

ID of the current optimisation to retrieve.

Response

Successful response

Changes

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