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.

qstringOptional

Search through the products' attributes, such as titles and descriptions, using this search term.

The status to filter products by

titlestring | string[]Optional

The titles to filter products by.

handlestring | string[]Optional

The handles to filter products by.

skustring | string[]Optional

The skus to filter products by.

idstring | string[]Optional

The IDs to filter products by.

external_idstring | string[]Optional

The external IDs to filter products by.

is_giftcardbooleanOptional

Filters only or excluding gift card products

tagsobjectOptional

Filters on a product's tags.

variantsobjectOptional

Filters on a product's variant properties.

type_idstring | string[]Optional

Filter a product by the ID of the associated type

categoriesobject | objectOptional

Filter a product by the IDs of their associated categories.

collection_idstring | string[] | OperatorMap<string>Optional

Filters a product by its associated collections.

created_atOperatorMap<string>Optional

Filters a product based on when it was created

updated_atOperatorMap<string>Optional

Filters a product based on when it was updated

deleted_atOperatorMap<string>Optional

Filters soft-deleted products based on the date they were deleted at.

Was this page helpful?