Refund Order
POST/order/refund
Process a full or partial refund for an order.
Validation Rules
The refund request will be rejected if any of the following conditions are not met:
- Order Status: The order (
orderStatus) must be incompletedorpartially_refundedstatus. - Payment Status: The specified payment (
payments[].paymentStatus.status) must be incompletedorpartially_refundedstatus. - Order Balance: The refund amount (
cost.amount) cannot exceed the remaining unrefunded balance of the order. - Payment Balance: The refund amount (
cost.amount) cannot exceed the remaining unrefunded amount of the specific payment (payments[].cost.amount).
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 412
- 500
- 502
- 503
Refund operation in progress.
Invalid request parameters.
Authentication failed. Verify that a valid Api-Access-Token is provided in the request headers.
Access denied. The API token does not have permission to refund orders for the specified shop.
Resource not found.
Precondition failed.
Internal server error. An unexpected error occurred on the server side.
Service unavailable. The upstream service is temporarily unreachable.
Service unavailable. The server is temporarily unable to handle the request.