Skip to main content
PUT
/
rentals
/
{rentalId}
Update a rental
curl --request PUT \
  --url https://app.supercycle.com/api/v1/rentals/{rentalId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fulfillAt": "2023-11-07T05:31:56Z",
  "fulfilledAt": "2023-11-07T05:31:56Z",
  "itemId": 123,
  "reallocateConflictingRentals": true,
  "minimumRentalEnd": "2023-11-07T05:31:56Z",
  "receiveAt": "2023-11-07T05:31:56Z",
  "receivedAt": "2023-11-07T05:31:56Z",
  "rentalEnd": {
    "before": "2023-11-07T05:31:56Z",
    "after": "2023-11-07T05:31:56Z"
  },
  "rentalStart": {
    "before": "2023-11-07T05:31:56Z",
    "after": "2023-11-07T05:31:56Z"
  },
  "tagsAttributes": [
    {
      "title": "<string>",
      "id": 123,
      "_destroy": true
    }
  ]
}
'
{
  "id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "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,
  "shopifyOrderId": 123,
  "shopifyOrderLineId": 123,
  "item": {
    "id": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "activeRentalId": 123,
    "productTitle": "<string>",
    "serial": "<string>",
    "sequentialId": 123,
    "shopifyVariantId": 123,
    "tags": [
      "<string>"
    ],
    "variantTitle": "<string>",
    "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,
        "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>",
  "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,
      "definitionId": 123,
      "key": "<string>",
      "value": "<string>",
      "valueJson": "<unknown>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.supercycle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
rentalId
integer
required

Numeric ID of the rental to retrieve.

Body

application/json
​
fulfillAt
string<date-time>
​
fulfilledAt
null | string<date-time>
​
itemId
integer<int64>
​
reallocateConflictingRentals
boolean

When true and itemId is changed, all other rentals on the newly assigned item are re-allocated to resolve conflicts.

​
minimumRentalEnd
string<date-time>
​
packingStatus
enum<string>

Status of the packing process.

Available options:
pending,
printed,
packed
​
receiveAt
string<date-time>
​
receivedAt
null | string<date-time>
​
rentalEnd
object
​
rentalStart
object
​
tagsAttributes
object[]

Response

Expected response to a valid request

​
id
integer<int64>
required

Numeric ID of the rental.

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required

When this rental was last updated in Supercycle. Use with the list endpoint's updated filter to sync only rentals that changed since your last request.

​
customer
object
required
​
itemId
integer<int64>
required
​
packingStatus
enum<string>
required

Status of the packing process.

Available options:
pending,
printed,
packed
​
shopifyOrderId
integer<int64>
required
​
shopifyOrderLineId
integer<int64>
required
​
methodType
enum<string>

Method type of the rental.

Available options:
calendar,
subscription,
membership,
resale
​
item
object
​
fulfillAt
null | string<date-time>

Date and time the rental is due to be dispatched to the customer.

​
fulfilledAt
null | string<date-time>

Date and time the rental was dispatched to the customer.

​
minimumRentalEnd
null | string<date-time>
​
originRentalIntentToken
null | string
​
receiveAt
null | string<date-time>

Date and time the rental is due to be received back from the customer.

​
receivedAt
null | string<date-time>

Date and time the rental was received back from the customer.

​
rentalStart
null | string<date-time>

Date and time the item was received by the customer and the rental period started.

​
rentalEnd
null | string<date-time>

Date and time the rental period is due to end.

​
restockBy
null | string<date-time>

Date and time the item is due to be restocked.

​
restockedAt
null | string<date-time>

Date and time the item was restocked.

​
sequentialId
null | integer<int32>

Sequential ID of the rental.

​
shopifyOrderName
string
​
status
enum<string>

Status of the rental.

Available options:
scheduled,
unfulfilled,
fulfilled,
unreceived,
received,
cancelled
​
fulfillmentStatus
enum<string>

Current fulfillment status of the rental. Indicates whether the item is due to be sent, scheduled, in progress, overdue, or has been dispatched.

Available options:
pending,
scheduled,
in_progress,
overdue,
complete
​
receivalStatus
enum<string>

Current receival status of the rental. Indicates whether the item is due to be returned, scheduled for return, overdue for return, or has been received back.

Available options:
pending,
scheduled,
in_progress,
overdue,
complete
​
returnOrderId
null | integer<int64>

ID of the return order associated with this rental.

​
timelineEvents
object[]

Timeline events for this rental

​
tags
string[]
​
customFields
object[]

Custom fields attached to this rental