Skip to main content
Skip to main content

FilterableProductProps

Filters to apply on retrieved products.

constructor


Properties

category_idstring[]
Filter products by their associated product category's ID.
collection_idstring[]
Filter products by their associated product collection's ID.
Date filters to apply on the products' created_at date.
Date filters to apply on the products' deleted_at date.
descriptionstring
Description to filter products by.
discount_condition_idstring
Filter products by their associated discount condition's ID.
handlestring
Handle to filter products by.
idstring | string[]
IDs to filter products by.
include_category_childrenboolean
Whether to include product category children in the response.
is_giftcardboolean
Filter products by whether they're gift cards.
price_list_idstring[]
Filter products by their associated price lists' ID.
qstring
Search term to search products' title, description, variants' title and sku, and collections' title.
sales_channel_idstring[]
Filter products by their associated sales channels' ID.
Statuses to filter products by.
tagsstring[]
Filter products by their associated tags' value.
titlestring
Title to filter products by.
type_idstring[]
Filter products by their associated product type's ID.
Date filters to apply on the products' updated_at date.
Was this section helpful?