Skip to main content
POST
Cancels an order and, if it was paid from your Business wallet, refunds the cost to that wallet. Requires scope: orders:write
An order can only be cancelled while its status is one of:
  • PENDING
  • ASSIGNED
  • ACCEPTED
  • START_TRIP
Any other status (for example HEADING_TO_PICKUP, PICKED_UP, HEADING_TO_DELIVERY, or DELIVERED) is rejected with 400.Only single-order cancellation is supported — there is no bulk cancel.
See Shipment statuses for the full lifecycle.

Headers

string
required
Bearer API key (Bearer <api_key>).
string
application/json when sending a body.

Path parameters

string
required
MongoDB document id of the order (not the order_id display code). Same id as Get order.

Body

string
Optional cancel reason (max 500 characters).

Response

string
Success message.
string
Human-readable order code.
string
Always CANCELLED on success.
boolean
Always true on success.