Admin API
Conditions
TimelineComments
List all rentals
Returns a list of rentals given parameters. Used by merchants to see rentals due for dispatch, return etc.
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,
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
x <= 100Cursor token to fetch next page of results.
Filter rentals by Shopify Order ID
Filter rentals by created at datetime (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter rentals by rental start date (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Response
Numeric ID of the rental.
Numeric ID of the customer.
Default address of the customer.
Numeric ID of the customer.
Status of the packing process.
pending, printed, packed Date and time the rental is due to be dispatched to the customer.
Date and time the rental was dispatched to the customer.
Date and time the rental is due to be received back from the customer.
Date and time the rental was received back from the customer.
Date and time the item was received by the customer and the rental period started.
Date and time the rental period is due to end.
Date and time the item is due to be restocked.
Date and time the item was restocked.
Sequential ID of the rental.
Timeline events for this rental
Numeric ID of the timeline event.
Numeric ID of the resource associated with the event.
Type of the resource (e.g., Item, Rental, ReturnOrder).
Type of the timeline event.
Additional data associated with the timeline event.
Timestamp when the event was created.
Timestamp when the event was last updated.
Author of the timeline event.
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,
"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
}