This method is in Alpha and may change in the future.
Retrieves a list of products, given the provided filtering, search expression, sorting, and cursor paging.
Provides eventually consistent results optimized for product discovery and browsing. Search supports full-text queries, filters, sorting, and aggregations for faceted search.
Use Search Products for user-facing product catalogs and discovery features. For real-time accuracy in operational tasks, use Query Products instead.
| Property | Capabilities | Filters |
|---|---|---|
allCategories | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
directCategories | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
options | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
options.values | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
shippingDestinations | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
printOnDemandOptions.printTechnologies | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
types | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
brand | Search: ✓ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
inventory.tier | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
name | Search: ✓ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
productOrigin | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
providerInfo.appId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
providerInfo.productId | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
supplierInfo.id | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
supplierInfo.verified | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
visible | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any |
wholesaleOptions.minimumOrderQuantity | Search: ✗ Aggregate: ✓ Sort: ✗ | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
minimumPrice | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
supplierInfo.rating | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
description | Search: ✓ Aggregate: ✗ Sort: ✗ |
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.