CatalogQuery

Description

A query to be applied to a SearchCatalogObjectsRequest. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked "searchable" from the structured data types for the desired result object type(s) (CatalogItem, CatalogItemVariation, CatalogCategory, CatalogTax, CatalogDiscount, CatalogModifierList, CatalogModifier). For example, a query that should return Items may specify attribute names from any of the searchable fields of the CatalogItem data type, namely \"name\", \"description\", and \"abbreviation\".

Properties

Name	Type	Description	Notes
sortedAttributeQuery	CatalogQuerySortedAttribute	A query that returns all objects, sorted by the given attribute.	[optional]
exactQuery	CatalogQueryExact	A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.	[optional]
prefixQuery	CatalogQueryPrefix	A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.	[optional]
rangeQuery	CatalogQueryRange	A query that returns only objects for which the given (integer-valued) attribute lies in the given range.	[optional]
textQuery	CatalogQueryText	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"]}`.	[optional]
itemsForTaxQuery	CatalogQueryItemsForTax	A query that returns all `CatalogItem`s that have any of the given `CatalogTax`es enabled.	[optional]
itemsForModifierListQuery	CatalogQueryItemsForModifierList	A query that returns all `CatalogItem`s that have any of the given `CatalogModifierList`s enabled.	[optional]
itemsForItemOptionsQuery	CatalogQueryItemsForItemOptions	A query that returns all `CatalogItem`s that have all of the given `CatalogItemOption`s.	[optional]
itemVariationsForItemOptionValuesQuery	CatalogQueryItemVariationsForItemOptionValues	A query that returns all `CatalogItemVariation`s that have all of the given `CatalogItemOption` values.	[optional]