cancelOrder

Cancel an existing order. Only an `OPEN` order can be marked as canceled. Set `force: true` to cancel a `COMPLETED` order.

mutation

Requires one of commerce.order:create, commerce.order:update, commerce.order:cancel, or commerce.order:complete (use the scope that matches the operation).

Cancel an existing order. Only an OPEN order can be marked as canceled. Set force: true to cancel a COMPLETED order.

Required headers

Header	Required	Description
`x-store-id`	Yes	ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`.

Go to Authentication for credential setup.

Arguments

id ID! required
force Boolean optional Default: false.

Possible returns

Order Order

mutation RunCancelOrder($id: ID!) {  cancelOrder(id: $id) {    id    createdAt    updatedAt    externalId    cartId    number  }}

{  "data": {    "cancelOrder": {      "id": "ID_VALUE",      "createdAt": "2026-01-15T12:00:00.000Z",      "updatedAt": "2026-01-15T12:00:00.000Z",      "externalId": "EXTERNAL_ID",      "cartId": "CART_ID",      "number": "NUMBER_VALUE"    }  }}

Last updated on