Skip to main content
POST
Cancel an order

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Path Parameters

order_number
string
required

order number

Body

application/json
cancellation_reason
string
required

The reason for cancelling the order. Recorded on the order for reporting and customer communication.

refund_mode
enum<string>
required

How the refund is issued. Use original-payment-mode to refund back to the customer's original payment instrument, or bank-transfer to refund to a saved customer bank account.

Available options:
original-payment-mode,
bank-transfer
bank_account_id
string | null

The customer bank account to credit. Required when refund_mode is bank-transfer; omit or set to null for original-payment-mode.

Response

OK

message
string
required
success
boolean
required
content
object
required