A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the SearchCatalogObjects endpoint.
<- Object
Object
A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the SearchCatalogObjects endpoint.
Although a query can have multiple filters, only one query is allowed per call to SearchCatalogObjects.
When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.
Searchable attribute and objects queryable by searchable attributes **
name: CatalogItem, CatalogItemVariation, CatelogCatogry, CatalogTax, CatalogDiscount, CatalogModifier, 'CatalogModifierList, CatalogItemOption, CatalogItemOptionValue`description: CatalogItem, CatalogItemOptionValueabbreviation: CatalogItemupc: CatalogItemVariationsku: CatalogItemVariationcaption: CatalogImagedisplay_name: CatalogItemOptionFor example, to search for CatalogItem objects by searchable attributes, you can use the "name", "description", or "abbreviation" attribute in an applicable query filter.
A query expression to sort returned query result by the given attribute.
An exact query expression to return objects with attribute name and value
matching the specified attribute name and value exactly. Value matching is case insensitive.
A prefix query expression to return objects with attribute values that have a prefix matching the specified string value. Value maching is case insensitive.
A range query expression to return objects with numberic values that lie in the specified range.
A text query expression to return objectd whose searchable attributes contain all of the given keywords, irrespective of their order. For example, if a CatalogItem contains custom attribute values of {"name": "t-shirt"} and {"description": "Small, Purple"}, the query filter of {"keywords": ["shirt", "sma", "purp"]} returns this item.
A query expression to return items that have any of the specified taxes (as identified by the corresponding CatalogTax object IDs) enabled.
A query expression to return items that have any of the given modifier list (as identifieid by the coresponding CatalogModifierLists IDs) enabled.
A query expression to return items that contains the specified item options (as identified the corresponding CatalogItemOption IDs).
A query expression to return item variations (of the CatalogItemVariation type) that contain all of the specified CatalogItemOption IDs.