Plans

Optimise Orders For IDs

Async optimisation for a specific set of order IDs. Same lifecycle and polling semantics as POST /plans/optimise/orders — see that endpoint's description for completion detection, polling cadence, and the failure-signal gap. Supports the idempotency-key request header for safe retries.

post/plans/optimise/orders-for-ids

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/plans/optimise/orders-for-ids
  • Auth: none declared

Headers

idempotency-keystring

Optional idempotency key for safe retries. See Idempotency for behaviour. 1–255 characters; UUID recommended.

Request body

zone_group_idinteger

The ID of the zone group for optimization.

Response

Optimisation accepted and Plan created. The optimisation runs asynchronously; poll GET /plans/{id} for completion. With settings.maintain_upload_sequence the body contains only plan.

OR

Changes

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