Skip to main content
Skip to main content

FilterableProductProps

The filters to apply on retrieved products.

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
qstring
Search through the products' attributes, such as titles and descriptions, using this search term.
handlestring | string[]
The handles to filter products by.
idstring | string[]
The IDs to filter products by.
tagsobject
Filters on a product's tags.
tags.valuestring[]
Values to filter product tags by.
categoriesobject
Filters on a product's categories.
categories.idstring | string[] | OperatorMap<string>
IDs to filter categories by.
categories.is_internalboolean
Filter categories by whether they're internal
categories.is_activeboolean
Filter categories by whether they're active.
category_idstring | string[] | OperatorMap<string>
Filter a product by the IDs of their associated categories.
collection_idstring | string[] | OperatorMap<string>
Filters a product by its associated collections.
Was this section helpful?