GET
/
rentals
curl --request GET \
  --url https://app.supercycle.com/api/v1/rentals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "customer": {
        "id": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "defaultAddress": null,
        "email": null,
        "firstName": null,
        "lastName": null,
        "shopifyId": 123
      },
      "fulfillAt": null,
      "fulfilledAt": null,
      "itemId": 123,
      "minimumRentalEnd": null,
      "originRentalIntentToken": null,
      "receiveAt": null,
      "receivedAt": null,
      "rentalStart": null,
      "rentalEnd": null,
      "restockBy": null,
      "restockedAt": null,
      "packingStatus": "pending",
      "sequentialId": null,
      "shopifyOrderName": "<string>",
      "shopifyOrderId": 123,
      "shopifyOrderLineId": 123,
      "status": "scheduled",
      "returnOrderId": null,
      "timeline_events": [
        {
          "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.

​
shopifyOrderId
string

Filter rentals by Shopify Order ID

​
itemId
integer

Filter by item ID

​
shopifyVariantId
integer

Filter by shopify variant ID

​
unfulfilled
boolean
default:false

When true, filter rentals to show only unfulfilled ones

​
created
object

Filter rentals by created at datetime (ISO 8601), using gt, lt, gte, lte operators which may be combined.

​
rentalStart
object

Filter rentals by rental start date (ISO 8601), using gt, lt, gte, lte operators which may be combined.

​
search
string

Filter rentals by titles and customer text

​
include
string

Comma-separated list of relations to include (e.g., item)

Example:

"item"

Response

200 - application/json

A paged array of rentals

The response is of type object.