List Return Reasons

GET

/partner/v1/return-reasons

Reasons the store accepts — the same set the customer portal shows — with the return types each one can be used for in this store. Filter with type; use an id from ?type=return as products[].reason_id when creating a return.

Scope: refunds:read.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠422Validation failed

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/partner/v1/return-reasons?type=return' \
--header 'X-Store-Id: {{partner_store_id}}' \
--header 'Accept-Language: en' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": {
                "en": "string",
                "ar": "string"
            },
            "return_types": [
                "return"
            ]
        }
    ]
}

Get Product

Create Return Reason