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",
"shopifyId": 123,
"defaultAddress": {
"customerId": 123,
"default": true,
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>",
"phone": "<string>",
"name": "<string>",
"provinceCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>"
},
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"itemId": 123,
"packingStatus": "pending",
"shopifyOrderId": 123,
"shopifyOrderLineId": 123,
"methodType": "calendar",
"item": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"activeRentalId": 123,
"productTitle": "<string>",
"serial": "<string>",
"sequentialId": 123,
"shopifyVariantId": 123,
"status": "processed",
"tags": [
"<string>"
],
"variantTitle": "<string>",
"visibility": "available",
"activeReturnId": 123,
"condition": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"severityKey": "<string>",
"severityTone": "<string>",
"title": "<string>"
},
"conditionId": 123,
"imageUrl": "<string>",
"location": {
"shopifyId": 123,
"name": "<string>"
},
"pickLocation": "<string>",
"shopifyProductId": 123,
"timelineEvents": [
{
"id": 123,
"eventableId": 123,
"eventableType": "<string>",
"eventType": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"author": "<string>"
}
],
"customFields": [
{
"id": 123,
"ownerId": 123,
"ownerType": "Item",
"definitionId": 123,
"key": "<string>",
"value": "<string>",
"valueJson": "<unknown>"
}
]
},
"fulfillAt": "2023-11-07T05:31:56Z",
"fulfilledAt": "2023-11-07T05:31:56Z",
"minimumRentalEnd": "2023-11-07T05:31:56Z",
"originRentalIntentToken": "<string>",
"receiveAt": "2023-11-07T05:31:56Z",
"receivedAt": "2023-11-07T05:31:56Z",
"rentalStart": "2023-11-07T05:31:56Z",
"rentalEnd": "2023-11-07T05:31:56Z",
"restockBy": "2023-11-07T05:31:56Z",
"restockedAt": "2023-11-07T05:31:56Z",
"sequentialId": 123,
"shopifyOrderName": "<string>",
"status": "scheduled",
"returnOrderId": 123,
"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>"
],
"customFields": [
{
"id": 123,
"ownerId": 123,
"ownerType": "Item",
"definitionId": 123,
"key": "<string>",
"value": "<string>",
"valueJson": "<unknown>"
}
]
}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",
"shopifyId": 123,
"defaultAddress": {
"customerId": 123,
"default": true,
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"zip": "<string>",
"phone": "<string>",
"name": "<string>",
"provinceCode": "<string>",
"countryCode": "<string>",
"countryName": "<string>"
},
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"itemId": 123,
"packingStatus": "pending",
"shopifyOrderId": 123,
"shopifyOrderLineId": 123,
"methodType": "calendar",
"item": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"activeRentalId": 123,
"productTitle": "<string>",
"serial": "<string>",
"sequentialId": 123,
"shopifyVariantId": 123,
"status": "processed",
"tags": [
"<string>"
],
"variantTitle": "<string>",
"visibility": "available",
"activeReturnId": 123,
"condition": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"severityKey": "<string>",
"severityTone": "<string>",
"title": "<string>"
},
"conditionId": 123,
"imageUrl": "<string>",
"location": {
"shopifyId": 123,
"name": "<string>"
},
"pickLocation": "<string>",
"shopifyProductId": 123,
"timelineEvents": [
{
"id": 123,
"eventableId": 123,
"eventableType": "<string>",
"eventType": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"author": "<string>"
}
],
"customFields": [
{
"id": 123,
"ownerId": 123,
"ownerType": "Item",
"definitionId": 123,
"key": "<string>",
"value": "<string>",
"valueJson": "<unknown>"
}
]
},
"fulfillAt": "2023-11-07T05:31:56Z",
"fulfilledAt": "2023-11-07T05:31:56Z",
"minimumRentalEnd": "2023-11-07T05:31:56Z",
"originRentalIntentToken": "<string>",
"receiveAt": "2023-11-07T05:31:56Z",
"receivedAt": "2023-11-07T05:31:56Z",
"rentalStart": "2023-11-07T05:31:56Z",
"rentalEnd": "2023-11-07T05:31:56Z",
"restockBy": "2023-11-07T05:31:56Z",
"restockedAt": "2023-11-07T05:31:56Z",
"sequentialId": 123,
"shopifyOrderName": "<string>",
"status": "scheduled",
"returnOrderId": 123,
"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>"
],
"customFields": [
{
"id": 123,
"ownerId": 123,
"ownerType": "Item",
"definitionId": 123,
"key": "<string>",
"value": "<string>",
"valueJson": "<unknown>"
}
]
}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
Numeric ID of the rental.
Show child attributes
Status of the packing process.
pending, printed, packed Method type of the rental.
calendar, subscription, membership, resale Show child attributes
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.
Status of the rental.
scheduled, unfulfilled, fulfilled, unreceived, received, cancelled ID of the return order associated with this rental.
Timeline events for this rental
Show child attributes
Custom fields attached to this rental
Show child attributes
Was this page helpful?