List Return Reasons
List the active reasons a customer can pick when raising a return, filtered by the resolution type. Use a reason's id as the rma_reason_id when calling POST /api/shop/returns.
Endpoint
GET /api/shop/return-reasonsAuthentication
This endpoint requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.
Request Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Authorization | Yes | Bearer token (customer login required) |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
resolution_type | string | Yes | The resolution the reasons apply to — return or cancel_items. |
Response Fields (200 OK)
The response is a plain JSON array. Each item is a reason object.
| Field | Type | Description |
|---|---|---|
id | integer | Numeric reason id — use as rma_reason_id when raising a return. |
title | string | Reason label, e.g. Damaged product. |
position | integer | Display order position. |
Status Codes
| Status | Meaning |
|---|---|
200 OK | Reasons retrieved. |
400 Bad Request | resolution_type is missing or invalid. |
401 Unauthorized | Missing or invalid customer Bearer token. |
403 Forbidden | Missing or invalid storefront key. |