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 products with filtering, sorting, and cursor-based pagination.
Provides real-time, strongly consistent results with filtering, sorting, and pagination.
Use Query Products when you need accurate, up-to-date data such as for operational tasks or inventory checks. For product discovery and browsing with full-text search capabilities, use Search Products instead.
| Property | Filters | Sort |
|---|---|---|
directCategories | $matchItems | None |
allCategories | $matchItems | None |
options | $matchItems | None |
options.values | $matchItems | None |
shippingDestinations | $matchItems | None |
id | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
name | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
providerInfo.appId | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
providerInfo.productId | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
supplierInfo.id | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
supplierInfo.verified | $eq, $ne, $exists, $in, $hasSome | None |
directCategories.id | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
allCategories.id | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
visible | $eq, $ne, $exists, $in, $hasSome | None |
types | None | |
brand | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
inventory.tier | $eq, $ne, $exists, $in, $hasSome | None |
productOrigin | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | None |
wholesaleOptions.minimumOrderQuantity | $eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte | None |
printOnDemandOptions.printTechnologies | None | |
createdDate | $eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
minimumPrice | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
directCategories.index | $eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
allCategories.index | $eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
supplierInfo.rating | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.