cancelSalesOrder

Requires permission sales:sales_order:cancel.

Cancel an order, optionally with a reason. Orders already shipped, delivered, cancelled or returned cannot be cancelled, and an order with a live invoice must have the invoice cancelled first.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CancelSalesOrder($id: ID!) {
  cancelSalesOrder(id: $id) {
    id
    customerPoNumber
    orderNumber
    sourceQuoteNumber
    trackingNumber
    creatorName
    billingAddress {
      postalCode
      city
      country
      state
      street1
      street2
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CancelSalesOrder($id: ID!) {\n  cancelSalesOrder(id: $id) {\n    id\n    customerPoNumber\n    orderNumber\n    sourceQuoteNumber\n    trackingNumber\n    creatorName\n    billingAddress {\n      postalCode\n      city\n      country\n      state\n      street1\n      street2\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "cancelSalesOrder": {
      "id": "id",
      "customerPoNumber": "string",
      "orderNumber": "string",
      "sourceQuoteNumber": "string",
      "trackingNumber": "string",
      "creatorName": "string",
      "billingAddress": {
        "postalCode": "string",
        "city": "string",
        "country": "string",
        "state": "string",
        "street1": "string",
        "street2": "string"
      }
    }
  }
}

Cancel a sales order with a reason:

GraphQL

mutation CancelSalesOrder($id: ID!, $reason: String) {
  cancelSalesOrder(id: $id, reason: $reason) {
    id
    orderNumber
    status
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CancelSalesOrder($id: ID!, $reason: String) {\n  cancelSalesOrder(id: $id, reason: $reason) {\n    id\n    orderNumber\n    status\n  }\n}",
  "variables": {
    "id": "SALES_ORDER_ID",
    "reason": "Customer request"
  }
}
EOF

Variables:

{
  "id": "SALES_ORDER_ID",
  "reason": "Customer request"
}

Response:

{
  "data": {
    "cancelSalesOrder": {
      "id": "SALES_ORDER_ID",
      "orderNumber": "ORDER_NUMBER",
      "status": "CANCELLED"
    }
  }
}

cancelSalesOrder(
  id: ID!
  reason: String
): SalesOrder!

Arguments

cancelSalesOrder.id ● ID! non-null scalar

The ID of the sales order.

cancelSalesOrder.reason ● String scalar

Why the order is being cancelled.

Type

SalesOrder object

A confirmed demand from a customer to ship goods, usually converted from a quote. Moves through confirmation, shipment, invoicing and payment.