Delivery routes
E-mail the route sheet to the assigned driver and mark the route DISPATCHED. 409 ROUTE_NOT_PLANNED; 422 NO_DRIVER, DRIVER_NO_EMAIL, NO_STOPS. The public driver page link is sent only to the driver, never returned. Requires Idempotency-Key. (scope: delivery:dispatch)
POST
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
id*stringDelivery route id
Format
uuidIdempotency-Key*stringRequired. Retries with the same key replay the first response instead of starting a second job (24 h).
Length
length <= 200OK
application/json- response
data*error*nullcurl -X POST "https://example.com/delivery-routes/497f6eca-6276-4993-bfeb-53cbbbba6f08/dispatch" \ -H "Idempotency-Key: string"{ "data": { "route_id": "dd833dbc-f3c5-44d9-98a2-7ba12ebc8160", "status": "DISPATCHED", "dispatched_at": "2019-08-24T14:15:22Z", "stop_count": 0, "sent_to_driver": true }, "error": null}