Admin API/Orders/Mutations

orderCancel

mutation

Cancels an order that hasn't shipped. Reserved or committed stock goes back to available.

mutation OrderCancel($orderId: ID!, $reason: OrderCancelReason!) {
  orderCancel(orderId: $orderId, reason: $reason) {
    order {
      id
      name
      email
      phone
      displayFinancialStatus
      createdAt
    }
    userErrors {
      code
      message
      field
    }
  }
}

# Variables
{
  "orderId": "gid://ostorya/Order/0f8c5b1e-…",
  "reason": "CUSTOMER"
}

Arguments

orderIdID!required
reasonOrderCancelReason!required
restockBooleandefault true
staffNoteString

Payload

orderOrder
userErrors[UserError!]!required

mutation OrderCancel($orderId: ID!, $reason: OrderCancelReason!) { orderCancel(orderId: $orderId, reason: $reason) { order { id name email phone displayFinancialStatus createdAt } userErrors { code message field } } } # Variables { "orderId": "gid://ostorya/Order/0f8c5b1e-…", "reason": "CUSTOMER" }