Skip to main content
GET
/
v1
/
return_requests
List
curl --request GET \
  --url https://{defaultHost}/v1/return_requests \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/return_requests"
  },
  "data": [
    {
      "id": "bdc69ab1-66ef-4b95-b4db-5b6d33c487b6",
      "object": "return_request",
      "number": "0000-R",
      "status": "open",
      "order": "4099e4a3-b157-4fb1-997e-d249428a270e",
      "created_at": 1769674995,
      "updated_at": 1769674995
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
order_ids[]
string[]

Only return objects that belong to the given orders.

​
page
integer

The page of items you want returned.

​
status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.