Routes

Dispatch a Route

Dispatch a single optimised route. The route is flagged as dispatched, its orders move to ROUTED, customer tracking portals are minted, superseded notification tasks are cancelled (with SMS credit refunded), planned-start notifications are scheduled, and the route is pushed to the assigned driver's app.

The route must have a vehicle assigned — a route whose vehicle was unassigned after planning is rejected with 400. A routes.dispatched webhook is published for the route. If this route is the last undispatched route on its plan, the plan itself becomes dispatched and a plans.dispatched webhook is published.

Dispatch is synchronous and can take up to two minutes: the response is returned only once every side effect has run (order statuses, customer tracking portals, notification scheduling and SMS credit refunds, driver push, external-system export). A 200 means the dispatch is live — there is nothing to poll.

The request takes no body. Dispatch is as-planned: no vehicle, driver or date override, and no re-optimisation.

Dispatch is not idempotent and not reversible. A repeat call answers 409 ALREADY_DISPATCHED, and there is no endpoint to undispatch. If the call times out (503), re-post it: a 409 means the first attempt succeeded.

post/routes/{id}/dispatch

Request

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

Path parameters

idinteger required
Example:55123

ID of the route to dispatch.

Response

The route is dispatched.

Changes

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