PUT
/
rentals
/
{rental_id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

rental_id
integer
required

Numeric ID of the rental to retrieve.

Body

application/json
fulfillAt
string
fulfilledAt
string | null
itemId
integer
minimumRentalEnd
string
packingStatus
enum<string>

Status of the packing process.

Available options:
pending,
printed,
packed
receiveAt
string
receivedAt
string | null
rentalEnd
object
rentalStart
object

Response

200 - application/json
id
integer
required

Numeric ID of the rental.

createdAt
string
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
fulfillAt
string | null

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

fulfilledAt
string | null

Date and time the rental was dispatched to the customer.

minimumRentalEnd
string | null
originRentalIntentToken
string | null
receiveAt
string | null

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

receivedAt
string | null

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

rentalStart
string | null

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

rentalEnd
string | null

Date and time the rental period is due to end.

restockBy
string | null

Date and time the item is due to be restocked.

restockedAt
string | null

Date and time the item was restocked.

sequentialId
integer | null

Sequential ID of the rental.

shopifyOrderName
string