order_cancel

Cancels an order and, by default, also cancels it on the connected sales platform. Orders with valid shipping labels can only be canceled with force.

Arguments

ArgumentTypeRequiredDefaultDescription
dataCancelOrderInput!Yes

Return Type

OrderMutationOutput

Mutation

mutation order_cancel(
  $data: CancelOrderInput!
) {
  order_cancel(
    data: $data
  ) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}

Variables

{
  "data": {
    "customer_account_id": "QWNjb3VudDoxMjM0",
    "order_id": "T3JkZXI6MTIzNA==",
    "reason": "Customer requested expedited handling.",
    "cancel_on_platform": true,
    "void_on_platform": true,
    "force": true
  }
}

Response

{
  "data": {
    "order_cancel": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "order": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}
    }
  }
}