List all items
Returns a list of items and their details given parameters. Used by merchants to view their inventory.
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 <= 100Cursor token to fetch next page of results.
Filter items by Shopify variant SKU
Filter items by serial
Filter items by titles, serials and SKU
Filter items by visibility status
available, unavailable, sold, retired When true, filter rentals by ones with active rentals
Filter by return order status. Can be a comma-separated list of statuses.
"requested,expected,received,in_progress,completed,cancelled"
Filter items by published date (ISO 8601), using gt, lt, gte, lte operators which may be combined. This is when utilization and ROI tracking starts.
Filter by custom field values, keyed by the definition's key, for definitions with "Filter in the table and the API" turned on.
Each key takes an object of operators, which may be combined: eq, notEq, in, notIn (comma-separated values, or item keys for a Choice list), gt, gte, lt, lte, contains, blank, present, withinDays (a date within the next N days, or the last N when negative) and olderThanMonths (a date more than N months ago).
Numbers, dates and booleans compare by type; money is in cents; Choice list values are item keys.
Example: customFields[battery][in]=full,medium&customFields[serviced_on][olderThanMonths]=6.
A definition that is unknown, archived or not enabled for filtering is refused with a 422.