searchProducts( )

Developer Preview

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 up to 100 products, given the provided filtering, search expression, sorting, and cursor paging. Pass supported values to the fields array in the request to include those fields in the response.

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

Notes:

This method does not return variantsInfo. To retrieve product variants, use the Get Product method.
To retrieve a non-visible product (visible: false), your app must have the required SCOPE.STORES.PRODUCT_READ_ADMIN permission scope.

Property	Capabilities	Filters
`allCategoriesInfo.categories`	Search: ✗ Aggregate: ✓ Sort: ✗	`$matchItems`
`directCategoriesInfo.categories`	Search: ✗ Aggregate: ✓ Sort: ✗	`$matchItems`
`variantsInfo.variants`	Search: ✗ Aggregate: ✓ Sort: ✗	`$matchItems`
`infoSections._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`infoSections.uniqueName`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`modifiers._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`modifiers.choicesSettings.choices.choiceId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`modifiers.choicesSettings.choices.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`modifiers.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`options._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`options.choicesSettings.choices.choiceId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`options.choicesSettings.choices.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`options.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`_id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`brand._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`brand.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`flattenModifiers`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$all`
`flattenOptions`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$all`
`handle`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`importId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`inventory.availabilityStatus`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`inventory.preorderAvailability`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`inventory.preorderStatus`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`physicalProperties.deliveryProfileId`	Search: ✓ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`physicalProperties.fulfillerId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`physicalProperties.shippingGroupId`	Search: ✓ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`productType`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`ribbon._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`ribbon.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`slug`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`subscriptionDetails.allowOneTimePurchases`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`taxGroupId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`visible`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`visibleInPos`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`_createdDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`_updatedDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`actualPriceRange.maxValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`actualPriceRange.minValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`compareAtPriceRange.maxValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`compareAtPriceRange.minValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`minVariantPriceInfo.sku`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`name`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`numericId`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`physicalProperties.shippingWeightRange.maxValue`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`physicalProperties.shippingWeightRange.minValue`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

searchCommonCursorSearchRequired

Search options.

optionsSearchProductsOptions

Returns

Return Type:Promise<V3SearchProductsResponse>

Errors

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

Did this help?