FilterableProductProps

The filters to apply on retrieved products.

$and(FilterableProductProps | BaseFilterable<FilterableProductProps>)[]

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.

$or(FilterableProductProps | BaseFilterable<FilterableProductProps>)[]

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.

statusProductStatus | ProductStatus[]

The status to filter products by

titlestring | string[]

The titles to filter products by.

handlestring | string[]

The handles to filter products by.

idstring | string[]

The IDs to filter products by.

is_giftcardboolean

Filters only or excluding gift card products

tagsobject

Filters on a product's tags.

tags.valuestring[]

Values to filter product tags by.

type_idstring | string[]

Filter a product by the ID of the associated type

category_idstring | string[] | OperatorMap<string>

Filters on a product's category_id.

collection_idstring | string[] | OperatorMap<string>

Filters a product by its associated collections.

created_atOperatorMap<string>

Filters a product based on when it was created

updated_atOperatorMap<string>

Filters a product based on when it was updated

deleted_atOperatorMap<string>

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