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.
Learn more about the differences between Query and Search methods.
| Field | Supported Filters | Sort |
|---|---|---|
id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
variantId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
locationId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
createdDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
updatedDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
trackQuantity | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
inStock | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
quantity | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
availabilityStatus | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
productId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
preorderInfo.enabled | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
product.name | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
product.directCategoryIds | $eq, $ne, $exists, $in, $any, $all | Sort: ASC, DESC |
product.variantName | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
product.variantSku | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.