This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Request a Return

Production Env

http://127.0.0.1:3658/m1/543334-505232-default

POST

/admin/orders/{id}/return

Request and create a Return for items in an order. If the return shipping method is specified, it will be automatically fulfilled.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://127.0.0.1:3658/m1/543334-505232-default/admin/orders//return' \
--header 'Content-Type: application/json' \
--data-raw '{
    "note": "string",
    "receive_now": false,
    "no_notification": true,
    "refund": 0,
    "return_shipping": {
        "option_id": "string",
        "price": 0
    },
    "items": [
        {
            "item_id": "string",
            "reason_id": "string",
            "note": "string",
            "quantity": 0
        }
    ]
}'

Response Example

200 - Example 1

Request

Path Params

Query Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2024-05-20 07:45:58

Update a Claim

Create a Claim Fulfillment