GET
/
admin
/
return-reasons
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.returnReason.list()
.then(({ return_reasons, count, limit, offset }) => {
  console.log(return_reasons)
})
{
  "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"
    }
  ],
  "estimate_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

​
q
string

Search term to filter the return reason's searchable properties.

​
id

Filter by a return reason ID.

​
value

Filter by a return reason's value.

​
label

Filter by a return reason's label.

​
description

Filter by a description. This filter looks for an exact match of the return reason's description. To search by a term or keywords, use the q query parameter instead.

​
parent_return_reason_id

Filter by a return reason's ID to retrieve its child return reasons.

​
created_at
object

Filter by a return reason's creation date.

​
updated_at
object

Filter by a return reason's update date.

​
deleted_at
object

Filter by a return reason's deletion date.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

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

​
estimate_count
number

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.