List all rentals

GET

rentals

Authorizations

Authorization

string

headerrequired

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

Query Parameters

limit

integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x < 100

page

string

Cursor token to fetch next page of results.

shopifyOrderId

string

Filter rentals by Shopify Order ID

created

object

Filter rentals by created at datetime (ISO 8601), using gt, lt, gte, lte operators which may be combined.

rentalStart

object

Filter rentals by rental start date (ISO 8601), using gt, lt, gte, lte operators which may be combined.

Response

200 - application/json

data

object[]

data.id

integer

required

Numeric ID of the rental.

data.createdAt

string

required

data.customer

object

required

data.fulfillAt

string | null

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

data.fulfilledAt

string | null

Date and time the rental was dispatched to the customer.

data.itemId

integer

required

data.minimumRentalEnd

string | null

data.originRentalIntentToken

string | null

data.receiveAt

string | null

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

data.receivedAt

string | null

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

data.rentalStart

string | null

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

data.rentalEnd

string | null

Date and time the rental period is due to end.

data.restockBy

string | null

Date and time the item is due to be restocked.

data.restockedAt

string | null

Date and time the item was restocked.

data.packingStatus

enum<string>

required

Status of the packing process.

Available options:

pending,

printed,

packed

data.sequentialId

integer | null

Sequential ID of the rental.

data.shopifyOrderName

string

data.shopifyOrderId

integer

required

data.shopifyOrderLineId

integer

required

string | null

Import products Retrieve a rental

API Reference

Items

Products

Rentals

ReturnOrders

Authorizations

Query Parameters

Response