Create a Refund

Prod Env

{{baseURL}}

POST

/admin/orders/{id}/refund

Refund an amount for an order. The amount must be less than or equal the refundable_amount of the order.

Request

Path Params

Query Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '{{baseURL}}/admin/orders//refund' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 0,
    "reason": "string",
    "note": "string",
    "no_notification": true
}'

Response Example

200 - Example 1

Modified at 2025-07-23 05:41:28

Add a Shipping Method