curl --request GET \
--url https://app.supercycle.com/api/v1/rentals/{rentalId} \
--header 'Authorization: Bearer <token>'
{
"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
},
"item": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"activeRentalId": 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>"
}
]
},
"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,
"timelineEvents": [
{
"id": 123,
"eventableId": 123,
"eventableType": "<string>",
"eventType": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"author": "<string>"
}
],
"tags": [
"<string>"
]
}
View information about a single rental. Can include timeline events if requested.
curl --request GET \
--url https://app.supercycle.com/api/v1/rentals/{rentalId} \
--header 'Authorization: Bearer <token>'
{
"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
},
"item": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"activeRentalId": 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>"
}
]
},
"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,
"timelineEvents": [
{
"id": 123,
"eventableId": 123,
"eventableType": "<string>",
"eventType": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"author": "<string>"
}
],
"tags": [
"<string>"
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Numeric ID of the rental to retrieve.
Expected response to a valid request
The response is of type object
.
Was this page helpful?