List Returns

GET

/admin/returns

Returns

Retrieve a list of returns. The returns can be filtered by fields such as id. The returns can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "returns": [
        {
            "id": "string",
            "refund_amount": 0,
            "order_id": "string",
            "items": [
                {
                    "id": "string",
                    "quantity": 0,
                    "received_quantity": 0,
                    "damaged_quantity": 0,
                    "reason_id": "string",
                    "note": "string",
                    "item_id": "string",
                    "return_id": "string",
                    "metadata": {}
                }
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "canceled_at": "2019-08-24T14:15:22Z",
            "exchange_id": "string",
            "location_id": "string",
            "claim_id": "string",
            "order_version": 0,
            "display_id": 0,
            "no_notification": true,
            "received_at": "string",
            "status": "canceled"
        }
    ]
}

Request

Authorization

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

optional

One of

array[string]

Filter by a return's ID.

status

optional

One of

status

array[string]

Filter by a return status.

$and

array [object]

$and

optional

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

Example:

["",""]

$or

array [object]

$or

optional

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

Example:

["",""]

sales_channel_id

array[string]

optional

Filter by sales channel IDs to retrieve their associated returns.

region_id

optional

Filter by region IDs to retrieve their associated returns.

One of

region_id

array[string]

The return's region id.

string

optional

Search term to filter the return's searchable properties.

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["",""]

$eq

array[string]

optional

Example:

["",""]

$not

array[string]

optional

Example:

["",""]

customer_id

optional

One of

customer_id

array[string]

The return's customer id.

Responses

🟢200OK

application/json

Body

The paginated list of returns.

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.

returns

array[object (AdminReturn) {14}]

required

The return's returns.

string

required

The return's ID.

refund_amount

number

refund_amount

optional

The amount refunded by this return.

order_id

string

order_id

required

The ID of the associated order.

items

array[object (AdminReturnItem) {9}]

required

The return's items.

created_at

string <date-time>

created_at

required

The date the return was created.

canceled_at

string <date-time>

canceled_at

required

The date the return was canceled.

exchange_id

string

exchange_id

optional

The return's exchange id.

location_id

string

location_id

optional

The return's location id.

claim_id

string

claim_id

optional

The return's claim id.

order_version

number

order_version

required

The return's order version.

display_id

number

display_id

required

The return's display id.

no_notification

boolean

no_notification

optional

Whether the customer should receive notifications about the return's updates.

received_at

string

received_at

required

The date the return was received.

status

enum<string>

optional

The return's status.

Allowed values:

canceledrequestedreceivedpartially_received

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Create Return

Get Logged-In User