POST

Search Products

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.

Learn more about the differences between Query and Search methods.

Notes:

When using free-text search, you must specify which fields to search using the search.fields parameter.
To retrieve a non-visible product (visible: false), your app must have the 'Product v3 read admin' (SCOPE.STORES.PRODUCT_READ_ADMIN) permission scope.
This method does not return variant data. To retrieve variant data, call Get Product or Get Product By Slug for each product individually, or use the Read-Only Variants API for variant-centric queries.

Property	Capabilities	Filters
`allCategoriesInfo.categories`	Search: ✗ Aggregate: ✓ Sort: ✗	`$matchItems`
`directCategoriesInfo.categories`	Search: ✗ Aggregate: ✓ Sort: ✗	`$matchItems`
`variantsInfo.variants`	Search: ✗ Aggregate: ✓ Sort: ✗	`$matchItems`
`additionalRibbons._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`additionalRibbons.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`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`
`tags.privateTags.tagIds`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`tags.publicTags.tagIds`	Search: ✗ Aggregate: ✓ Sort: ✗	`$hasAll`, `$hasSome`
`_id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`brand._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`brand.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`handle`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`inventory.availabilityStatus`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`inventory.preorderAvailability`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`inventory.preorderStatus`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`physicalProperties.deliveryProfileId`	Search: ✓ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`physicalProperties.fulfillerId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`productType`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`ribbon._id`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`ribbon.name`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`slug`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`subscriptionDetails.allowOneTimePurchases`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`taxGroupId`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`visible`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`visibleInPos`	Search: ✗ Aggregate: ✓ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`_createdDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`_updatedDate`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`actualPriceRange.maxValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`actualPriceRange.minValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`compareAtPriceRange.maxValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`compareAtPriceRange.minValue.amount`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`name`	Search: ✓ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`physicalProperties.shippingWeightRange.maxValue`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`physicalProperties.shippingWeightRange.minValue`	Search: ✗ Aggregate: ✓ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`description`	Search: ✓ Aggregate: ✗ Sort: ✗
`directCategoryIdsInfo.categoryIds`	Search: ✓ Aggregate: ✗ Sort: ✗
`minVariantPriceInfo.sku`	Search: ✓ Aggregate: ✗ Sort: ✗
`variantsInfo.variants.sku`	Search: ✓ Aggregate: ✗ Sort: ✗

Permissions

Learn more about app permissions.

Method Declaration

Copy

Errors

403Permission Denied

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?