GET
/
store
/
return-reasons
cURL
curl '{backend_url}/store/return-reasons' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "return_reasons": [
    {
      "id": "<string>",
      "value": "<string>",
      "label": "<string>",
      "description": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Query Parameters

​
fields
string

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

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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 -.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of return reasons.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total number of items.

​
return_reasons
object[]
required

The list of return reasons.