Add a Refund Request.

POST

/v1/orders/refund

This endpoint allows you to add a refund request for a specific order in the system.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params

application/json

Examples

Responses

🟢204

No Content

This response does not have a body.

🟠400

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.ordermesh.io/order/v1/orders/refund' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "orderId": "b234ee56-7890-4f12-a123-fake",
    "refunds": [
        {
            "itemId": "b234ee56-7890-fake",
            "isShippingRefund": true,
            "amount": 4,
            "reason": "Never arrived"
        },
        {
            "itemId": "b234ee56-7890-fake2",
            "isShippingRefund": false,
            "amount": 10,
            "reason": "Poor quality."
        }
    ]
}'

Response Example

400 - Success

{
    "errorCode": "ValidationError",
    "requestId": "224b67bd-02e2-4b0c-9eef-2559e51d1866",
    "errors": [
        {
            "errorMessage": "'Title' must not be empty.",
            "propertyName": "Title",
            "attemptedValue": ""
        }
    ]
}

Modified at 2026-09-10 16:13:19

Retrieve audit logs for a specific order item.

Create a New Note