post admin api 2020 04 orders order id cancel json - admin-api API | Specway Docs

POST

Caution For multi-currency orders, the currency property is required whenever the amount property is provided. For more information, see Migrating to support multiple currencies. Cancels an order. Orders that have a fulfillment object can't be canceled.

https://shopify.com/admin/api/2020-04/orders/{order_id}/cancel.json

https://shopify.dev/docs/admin-api/rest/reference/orders/order#cancel-2020-04

Access Token Required: API Key

Path Parameters

order_idstringrequired

order_id

Query Params

amountstring

The amount to refund. If set, Shopify attempts to void or refund the payment, depending on its status. Shopify refunds through a manual gateway in cases where the original transaction was not made in Shopify. Refunds through a manual gateway are recorded as a refund on Shopify, but the customer is not refunded.

currencystring

The currency of the refund that's issued when the order is canceled. Required for multi-currency orders whenever the amount property is provided.

restock deprecatedstring

Whether to restock refunded items back to your store's inventory. (default: false)

reasonstring

The reason for the order cancellation. Valid values: customer, inventory, fraud, declined, and other.) (default: other)

emailstring

Whether to send an email to the customer notifying them of the cancellation. (default: false)

refundstring

The refund transactions to perform. Required for some more complex refund situations. For more information, see the Refund API.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request POST \
     --url 'https://shopify.com/admin/api/2020-04/orders/{order_id}/cancel.json' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}