POST

Query Inventory Items


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.

FieldSupported FiltersSort
id$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ✗
variantId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ✗
locationId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ✗
createdDate$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSort: ASC, DESC
updatedDate$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSort: ASC, DESC
trackQuantity$eq, $ne, $exists, $in, $anySort: ASC, DESC
inStock$eq, $ne, $exists, $in, $anySort: ASC, DESC
quantity$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSort: ASC, DESC
availabilityStatus$eq, $ne, $exists, $in, $anySort: ASC, DESC
productId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
preorderInfo.enabled$eq, $ne, $exists, $in, $anySort: ASC, DESC
product.name$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
product.directCategoryIds$eq, $ne, $exists, $in, $any, $allSort: ASC, DESC
product.variantName$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
product.variantSku$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
Permissions
Read inventory in v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/inventory-items/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?