Object Index / Definition

You are viewing an old version of the API

2020-01-22

Version 2020-01-22

• All Versions

CatalogQuery

A query that returns all objects, sorted by the given attribute.

A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.

A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.

A query that returns only objects for which the given (integer-valued) attribute lies in the given range.

A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a CatalogItem contains attributes {"name": "t-shirt"} and {"description": "Small, Purple"}, it will be matched by the query {"keywords": ["shirt", "sma", "purp"]}.

A query that returns all CatalogItems that have any of the given CatalogTaxes enabled.

A query that returns all CatalogItems that have any of the given CatalogModifierLists enabled.

A query that returns all CatalogItems that have all of the given CatalogItemOptions.

A query that returns all CatalogItemVariations that have all of the given CatalogItemOption values.