Openapi
Cancel an order and release its reserved stock. A partly shipped order keeps what shipped and cancels the remainder. Returns 409 `APPROVAL_REQUIRED` with an `approvalId` when an approval policy wants a decision first.
sb-auth-token<token>Supabase browser session cookie. Supabase may split larger session values into chunked cookies like sb-auth-token.0.
orderId*stringuuidorganizationId*stringuuidAn optional reason.
application/jsonreason*|length <= 1000Returns the order after cancelling.
application/jsoncanceledAt*string|nullchannel*orderChannelSchema"manual""quote""inbox""api""integration"completedAt*string|nullconfirmedAt*string|nullcreatedAt*stringcurrency*stringcustomer*deliveryMethod*orderDeliveryMethodSchema"pickup""own_delivery""carrier""digital""none"formattedNumber*stringid*stringuuidinvoicingPolicy*orderInvoicingPolicySchema"before_fulfillment""on_fulfillment""manual"number*integerquoteId*|uuidquoteNumber*integer|nullrequestedDeliveryDate*|nullstatus*orderStatusSchema"draft""confirmed""on_hold""completed""canceled"subtotalExcl*numbertotalIncl*numberupdatedAt*stringvatTotal*numberbuyerEmail*string|nullbuyerName*string|nullbuyerPhone*string|nullcancelReason*string|nullcreatedBy*|uuidcustomerContactId*|uuidcustomerNote*string|nulldiscountDescription*string|nulldiscountKind*orderDiscountKindSchema"none""percentage""fixed"discountValue*numberexternalId*string|nullfulfillmentStatus*orderFulfillmentStatusSchema"unfulfilled""partial""fulfilled"invoices*array<>lines*array<>notes*string|nullpaymentRequired*booleanpaymentStatus*orderPaymentStatusSchema"none""unpaid""partial""paid"promotionId*|uuidquoteInvoice*|nullshippingAddress*source*string|nulltemplateId*|uuidvatInclusive*booleanvatRegime*orderVatRegimeSchema"standard""reverse_charge""exempt""kor""margin_scheme"curl -X POST 'https://app.localhost/api/v1/organizations/123/orders/123e4567-e89b-12d3-a456-426614174000/cancel' \ -H 'Content-Type: application/json' \ -d '{ "reason": "string"}'{ "canceledAt": "string", "channel": "manual", "completedAt": "string", "confirmedAt": "string", "createdAt": "string", "currency": "string", "customer": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "deliveryMethod": "pickup", "formattedNumber": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoicingPolicy": "before_fulfillment", "number": 0, "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7", "quoteNumber": 0, "requestedDeliveryDate": "2019-08-24", "status": "draft", "subtotalExcl": 0, "totalIncl": 0, "updatedAt": "string", "vatTotal": 0, "buyerEmail": "string", "buyerName": "string", "buyerPhone": "string", "cancelReason": "string", "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e", "customerContactId": "94bcd060-4a66-4a44-96c9-7a2da2955e96", "customerNote": "string", "discountDescription": "string", "discountKind": "none", "discountValue": 0, "externalId": "string", "fulfillmentStatus": "unfulfilled", "invoices": [ { "amountDueCents": 0, "amountPaidCents": 0, "createdAt": "string", "displayNumber": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "status": "string", "totalIncl": 0 } ], "lines": [ { "allocated": 0, "backordered": 0, "description": "string", "discountKind": "none", "discountValue": 0, "fulfilled": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoiced": 0, "lineType": "product", "position": 0, "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "productType": "string", "promotionId": "3eaf888b-516c-4eac-ac00-1312640986a2", "quantity": 0, "quantityCanceled": 0, "returned": 0, "sku": "string", "title": "string", "trackInventory": true, "unit": "string", "unitPrice": 0, "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf", "vatRate": 0 } ], "notes": "string", "paymentRequired": true, "paymentStatus": "none", "promotionId": "3eaf888b-516c-4eac-ac00-1312640986a2", "quoteInvoice": { "amountDueCents": 0, "amountPaidCents": 0, "createdAt": "string", "displayNumber": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "status": "string", "totalIncl": 0 }, "shippingAddress": { "city": "string", "country": "string", "line1": "string", "line2": "string", "name": "string", "phone": "string", "postalCode": "string" }, "source": "string", "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d", "vatInclusive": true, "vatRegime": "standard"}