POST

Search Inventory Items


Retrieves a list of inventory items, given the provided filtering, sorting, and cursor paging.

Search Inventory Items runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100

For field support for filters and sorting, see Inventory Items: Supported Filters and Sorting.

To learn about working with Search endpoints, see API Query Language, and Sorting and Paging.

Learn more about the differences between Query and Search methods.

PropertyCapabilitiesFilters
idSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
locationIdSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
variantIdSearch: ✗
Aggregate:
Sort: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
product.directCategoryIdsSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
createdDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
updatedDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
availabilityStatusSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
inStockSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
preorderInfo.enabledSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
product.nameSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
product.variantNameSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
product.variantSkuSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
productIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
quantitySearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
trackQuantitySearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
Permissions
Read inventory in v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/inventory-items/search

Errors

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

Did this help?