GET
/
items
List all items
curl --request GET \
  --url https://app.supercycle.com/api/v1/items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "activeRentalId": null,
      "activeReturnId": null,
      "condition": null,
      "conditionId": null,
      "imageUrl": null,
      "location": null,
      "pickLocation": null,
      "productTitle": "<string>",
      "serial": null,
      "sequentialId": 123,
      "shopifyProductId": null,
      "shopifyVariantId": null,
      "status": "processed",
      "tags": [
        "<string>"
      ],
      "variantTitle": null,
      "visibility": "available",
      "timelineEvents": [
        {
          "id": 123,
          "eventableId": 123,
          "eventableType": "<string>",
          "eventType": "<string>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "author": "<string>"
        }
      ]
    }
  ],
  "nextPage": null
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x <= 100
​
page
string

Cursor token to fetch next page of results.

​
sku
string

Filter items by Shopify variant SKU

​
serial
string

Filter items by serial

​
search
string

Filter items by titles, serials and SKU

​
visibility
enum<string>

Filter items by visibility status

Available options:
available,
unavailable,
sold,
retired
​
withActiveRental
boolean
default:false

When true, filter rentals by ones with active rentals

​
activeReturnOrderStatus
string

Filter by return order status. Can be a comma-separated list of statuses.

Example:

"requested,expected,received,in_progress,completed,cancelled"

Response

200 - application/json

A paged array of items

The response is of type object.