Create Return

POST

/store/returns

Create a return for an order's items. The admin receives the return and process it from their side.

Request Example

Shell

JavaScript

Java

Swift

curl -X POST '{backend_url}/store/returns' \
-H 'x-publishable-api-key: {your_publishable_api_key}' \
-H 'Content-Type: application/json' \
--data-raw '{
  "order_id": "order_123",
  "items": [
    {
      "id": "id_XbfptxUVo2io9EI",
      "quantity": 7916429753974784,
      "reason_id": "{value}",
      "note": "{value}"
    }
  ],
  "return_shipping": {
    "option_id": "{value}",
    "price": 1068364080349184
  },
  "note": "{value}",
  "location_id": "{value}"
}'

Response Example

200 - Example 1

{
    "return": {
        "id": "string",
        "display_id": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "order_id": "string",
        "location_id": "string",
        "canceled_at": "string",
        "exchange_id": "string",
        "claim_id": "string",
        "refund_amount": 0,
        "received_at": "string",
        "status": "received",
        "items": [
            {
                "id": "string",
                "quantity": 0,
                "received_quantity": 0,
                "damaged_quantity": 0,
                "reason_id": "string",
                "note": "string",
                "item_id": "string",
                "return_id": "string",
                "metadata": {}
            }
        ]
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

Get a Product Tag

Get a Product Type