Medusa

List Return Reasons

GET

/store/return-reasons

Return Reasons

Retrieve a list of return reasons. The return reasons can be sorted or paginated.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/store/return-reasons' \
--header 'x-publishable-api-key;'

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "return_reasons": [
        {
            "id": "string",
            "value": "string",
            "label": "string",
            "description": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ]
}

Request

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The paginated list of return reasons.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

return_reasons

array[object (StoreReturnReason) {7}]

required

The list of return reasons.

string

required

The return reason's ID.

value

string

value

required

The return reason's value.

label

string

label

required

The return reason's label.

description

string

description

optional

The return reason's description.

metadata

object

optional

The return reason's metadata, can hold custom key-value pairs.

created_at

string <date-time>

created_at

required

The date the return reason was created.

updated_at

string <date-time>

updated_at

required

The date the return reason was updated.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

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

List Payment Providers

Get a Return Reason