Skip to main content
POST
/
vendor
/
orders
/
{id}
/
cancel
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/cancel' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'
{
  "order": {
    "id": "order_01HXYZABCDEF",
    "display_id": 42,
    "status": "canceled",
    "canceled_at": "2026-06-05T10:00:00.000Z"
  }
}
Cancels the order on behalf of the seller and returns the updated order.
An order can only be canceled if it has no fulfillments or captured payments that block cancellation.

Path parameters

id
string
required
The order’s ID.

Query parameters

fields
string
Comma-separated list of fields to include in the returned order, prefix with +/- to add or remove from defaults.

Response

order
object
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/cancel' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'
{
  "order": {
    "id": "order_01HXYZABCDEF",
    "display_id": 42,
    "status": "canceled",
    "canceled_at": "2026-06-05T10:00:00.000Z"
  }
}