Skip to main content
GET
/
v1
/
return_items
List
curl --request GET \
  --url https://{defaultHost}/v1/return_items \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/return_items"
  },
  "data": [
    {
      "id": "aded5937-22e3-4336-bd50-98bb62be9e67",
      "object": "return_item",
      "note": null,
      "return_reason": "wrong_item",
      "return_reason_description": "Received the wrong item",
      "quantity": 1,
      "return_request": "5b01e226-1e40-4db8-b4b2-fb33de1ed334",
      "line_item": "104957d6-5e45-4a64-b9da-2243b5bb46ed",
      "created_at": 1780925593,
      "updated_at": 1780925593
    }
  ]
}

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.

​
page
integer

The page of items you want returned.

​
return_request_ids[]
string[]

Only return objects that belong to the given return requests.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.