This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of up to 1,000 inventory items, given the provided filtering, sorting, and cursor paging.
For field support for filters and sorting, see Inventory Items: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
inStock | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
quantity | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
_id | eq(),ne(),exists(),in(),hasSome(),startsWith() |
_createdDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
_updatedDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
variantId | eq(),ne(),exists(),in(),hasSome(),startsWith() |
locationId | eq(),ne(),exists(),in(),hasSome(),startsWith() |
productId | eq(),ne(),exists(),in(),hasSome(),startsWith() |
preorderInfo.enabled | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |