Cancel Order

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>'

const { order } = await client.vendor.orders.$id.cancel.mutate({
  $id: "order_01HXYZABCDEF",
})

{
  "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

string

required

The order’s ID.

string

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

object

Show properties

string

The order’s ID.

string

The order’s status, now canceled.

string

Cancellation timestamp.

object[]

The order’s line items.

object

Order totals summary.

curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/cancel' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { order } = await client.vendor.orders.$id.cancel.mutate({
  $id: "order_01HXYZABCDEF",
})

{
  "order": {
    "id": "order_01HXYZABCDEF",
    "display_id": 42,
    "status": "canceled",
    "canceled_at": "2026-06-05T10:00:00.000Z"
  }
}

curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/cancel' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { order } = await client.vendor.orders.$id.cancel.mutate({
  $id: "order_01HXYZABCDEF",
})

{
  "order": {
    "id": "order_01HXYZABCDEF",
    "display_id": 42,
    "status": "canceled",
    "canceled_at": "2026-06-05T10:00:00.000Z"
  }
}