Product Search Criteria reference¶
Product Search Criteria let you filter products by specific properties, for example, color, availability, or creation date.
You use them over the REST API, in the Filter or Query element of the payload of the
POST /product/catalog/products/view request,
or of the POST /product/catalog/catalogs/{identifier}/products/view request, which searches within a single catalog.
In the payload, the name of a Criterion has the Criterion suffix, for example, ProductCodeCriterion.
Criteria that you provide in one Filter or Query element are combined with a logical AND.
Products are content items, so you can also find them with a content search,
by using the POST /views request with, for example, the
ContentTypeIdentifier Criterion.
Such a search returns content items instead of products, and it doesn't accept Product Search Criteria.
In the same way, the product endpoints don't accept content Search Criteria.
Catalog Criteria (CatalogIdentifier, CatalogName, and CatalogStatus) are used with the
POST /product/catalog/catalogs/view request,
and attribute definition Criteria (AttributeName and AttributeGroupIdentifier) with the
POST /product/catalog/attributes/view request.
Product Search Criteria¶
To query for products coming from Quable, see Quable for details about the integration.
| Search Criterion | Search based on | Local product catalog | Quable |
|---|---|---|---|
| AttributeGroupIdentifier | Value of product's attribute group identifier | ✔ | |
| AttributeName | Value of product's attribute name | ✔ | |
| CatalogIdentifier | Catalog's identifier | ✔ | |
| CatalogName | Catalog's name | ✔ | |
| CatalogStatus | Catalog's status | ✔ | |
| ColorAttribute | Value of product's color attribute | ✔ | |
| CreatedAt | Date and time when product was created | ✔ | ✔ |
| CreatedAtRange | Date and time range when product was created | ✔ | |
| FloatAttribute | Value of product's float attribute | ✔ | |
| FloatAttributeRange | Value of product's float attribute | ✔ | |
| IntegerAttribute | Value of product's integer attribute | ✔ | |
| IntegerAttributeRange | Value of product's integer attribute | ✔ | |
| IsVirtual | Product type (virtual or physical) | ✔ | |
| ProductAvailability | Product's availability | ✔ | |
| ProductCategory | Product category assigned to product | ✔ | ✔ |
| ProductCode | Product's code | ✔ | ✔ |
| ProductName | Product's name | ✔ | ✔ |
| ProductType | Product type | ✔ | ✔ |
| SelectionAttribute | Value of product's selection attribute | ✔ | |
| UpdatedAt | Product modification date | ✔ | ✔ |
| UpdatedAtRange | Product modification date range | ✔ |