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": null,
  "itemId": 123,
  "minimumRentalEnd": "2023-11-07T05:31:56Z",
  "packingStatus": "pending",
  "receiveAt": "2023-11-07T05:31:56Z",
  "receivedAt": null,
  "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",
  "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,
    "activeReturnId": 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>"
  ]
}

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
string<date-time> | null
​
itemId
integer
​
minimumRentalEnd
string<date-time>
​
packingStatus
enum<string>

Status of the packing process.

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

Response

Expected response to a valid request

​
id
integer
required

Numeric ID of the rental.

​
createdAt
string<date-time>
required
​
customer
object
required
​
itemId
integer
required
​
packingStatus
enum<string>
required

Status of the packing process.

Available options:
pending,
printed,
packed
​
shopifyOrderId
integer
required
​
shopifyOrderLineId
integer
required
​
item
object
​
fulfillAt
string<date-time> | null

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

​
fulfilledAt
string<date-time> | null

Date and time the rental was dispatched to the customer.

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

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

​
receivedAt
string<date-time> | null

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

​
rentalStart
string<date-time> | null

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

​
rentalEnd
string<date-time> | null

Date and time the rental period is due to end.

​
restockBy
string<date-time> | null

Date and time the item is due to be restocked.

​
restockedAt
string<date-time> | null

Date and time the item was restocked.

​
sequentialId
integer | null

Sequential ID of the rental.

​
shopifyOrderName
string
​
status
enum<string>

Status of the rental.

Available options:
scheduled,
unfulfilled,
fulfilled,
unreceived,
received,
cancelled
​
returnOrderId
integer | null

ID of the return order associated with this rental.

​
timelineEvents
object[]

Timeline events for this rental

​
tags
string[]