POST /admin/api/{api_version}/orders/{order_id}/refunds.json
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.
Creates a refund. Use the calculate endpoint to produce the transactions to submit.
Note
When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
order_id |
String | Yes | |
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-shopify-access-token |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
refund |
Object | No | |
refund.transactions[] |
Array | No | |
refund.transactions[].gateway |
String | No | |
refund.transactions[].parent_id |
Number | No | |
refund.transactions[].amount |
Number | No | |
refund.transactions[].kind |
String | No | |
refund.shipping |
Object | No | |
refund.shipping.amount |
Number | No | |
refund.currency |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.