Object Index
/ Definition
You are viewing an old version of the API
CatalogQuery
Object Index / Definition
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 | Description |
|---|---|
exact_query
|
A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value. |
item_variations_for_item_option_values_query
Beta
|
A query that returns all CatalogItemVariations that have all of the given |
items_for_item_options_query
Beta
|
A query that returns all |
items_for_modifier_list_query
|
A query that returns all |
items_for_tax_query
|
A query that returns all |
prefix_query
|
A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. |
range_query
|
A query that returns only objects for which the given (integer-valued) attribute lies in the given range. |
sorted_attribute_query
|
A query that returns all objects, sorted by the given attribute. |
text_query
|
A query that returns only objects whose searchable attributes contain all of the given
keywords as prefixes. For example, if a |