Skip to navigation

Mark Ready for Collection

View as Markdown

Send the second signal when the goods for a non-dedicated order are ready for collection. Use the UUID returned as data.id when creating the order, not its short code. Only orders created with requires_ready_for_collection: true support this operation. Send an empty request body; do not send an order payload, readiness flag or timestamp. Include Authorization: Bearer YOUR_API_TOKEN and Accept: application/json. The server records the readiness timestamp.

Returns 202 Accepted after recording readiness; scheduling and route planning happen asynchronously. Acceptance does not confirm driver assignment or physical collection. Repeating the call for an eligible, non-terminal order preserves the original readiness timestamp and does not restart an operational order. Completed, cancelled or otherwise terminal orders return 409, including after a previously successful signal.

Authentication

AuthorizationBearer

Path parameters

idstringRequiredformat: "uuid"
The order UUID returned as data.id when the order was created.

Response

Readiness recorded; scheduling and route planning proceed asynchronously.

dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error