Cancel an order

Refused with 422 validation_error while any payment against the order still holds money, so a cancel can never orphan captured funds…

PATCH /api/v1/orders/{id}/cancel

cURL

curl --silent --show-error --fail-with-body --request PATCH \
  --url 'https://api.stateset.com/api/v1/orders/{id}/cancel' \
  --header 'Authorization: Bearer YOUR_API_KEY'

200

{
  "created_at": "2026-08-31T14:22:05Z",
  "currency": "USD",
  "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fulfillment_status": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 2,
      "shipped_quantity": 1,
      "sku": "SKU-TENT-2P-GRN",
      "total": "102.12",
      "unit_price": "49.00"
    }
  ],
  "order_number": "ORD-10042",
  "payment_status": "string",
  "status": "pending",
  "total_amount": "102.12",
  "updated_at": "2026-08-31T14:22:05Z"
}

Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Refused with 422 validation_error while any payment against the order still holds money, so a cancel can never orphan captured funds. Pass ?void_payments=true to void in-flight payments and cancel anyway; settled payments are left for an explicit refund.

Path parameters

id · string · required

Order ID (UUID)

Query parameters

void_payments · boolean

Void in-flight payments and cancel even if settled payments remain outstanding (default false: refuse while any payment holds money)

Request body

No request body.

Response

OrderResponse

created_at · string (date-time) · required

currency · string · required

customer_id · string (uuid) · required

fulfillment_status · string · required

id · string (uuid) · required

items · OrderItemResponse[] · required

Show OrderItemResponse

id · string (uuid) · required

name · string · required

product_id · string (uuid) · required

quantity · integer (int32) · required

shipped_quantity · integer (int32)

Units of this line that have shipped so far (<= quantity).

sku · string · required

total · string · required

unit_price · string · required

order_number · string · required

payment_status · string · required

status · string · required

total_amount · string · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	Order cancelled
400	Order cannot be cancelled
404	Order not found
422	Payments still hold money and void_payments was not set

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request PATCH \
  --url 'https://api.stateset.com/api/v1/orders/{id}/cancel' \
  --header 'Authorization: Bearer YOUR_API_KEY'

200

{
  "created_at": "2026-08-31T14:22:05Z",
  "currency": "USD",
  "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fulfillment_status": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 2,
      "shipped_quantity": 1,
      "sku": "SKU-TENT-2P-GRN",
      "total": "102.12",
      "unit_price": "49.00"
    }
  ],
  "order_number": "ORD-10042",
  "payment_status": "string",
  "status": "pending",
  "total_amount": "102.12",
  "updated_at": "2026-08-31T14:22:05Z"
}