List all rentals
Returns a list of rentals given parameters. Used by merchants to see rentals due for dispatch, return etc.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
x <= 100
Cursor token to fetch next page of results.
Filter rentals by Shopify Order ID
Filter by item ID
Filter by shopify variant ID
When true, filter rentals to show only unfulfilled ones
Filter rentals by created at datetime (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter rentals by rental start date (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter rentals by titles and customer text
Comma-separated list of relations to include (e.g., item)
"item"
Response
The response is of type object
.