Cancel an order
Cancels a completed order.
cancel_reason_id records why, from the store’s own cancellation-reason
vocabulary (/admin/order_cancellation_reasons), and cancel_note is a
staff-facing note; both are shown on the order afterwards.
Stock is always released — the goods are not going out either way — and every payment is settled at the gateway, which releases an authorization it never drew on and refunds a charge it cannot release.
refund_payments and refund_amount govern the shared payment of a
split checkout, where one payment covers several orders: they decide
whether this order’s share comes back, and how much of it. A
refund_amount on an ordinary order is refused with a 422.
Set notify_customer: true to send the order cancellation email.
Required scope: write_orders, plus write_refunds with refund_payments (for API-key authentication).
Authorizations
Headers
Body
Response
order canceled

