SquareConnect::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
sorted_attribute_query	CatalogQuerySortedAttribute	A query that returns all objects, sorted by the given attribute.	[optional]
exact_query	CatalogQueryExact	A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.	[optional]
prefix_query	CatalogQueryPrefix	A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.	[optional]
range_query	CatalogQueryRange	A query that returns only objects for which the given (integer-valued) attribute lies in the given range.	[optional]
text_query	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]
items_for_tax_query	CatalogQueryItemsForTax	A query that returns all CatalogItems that have any of the given CatalogTaxes enabled.	[optional]
items_for_modifier_list_query	CatalogQueryItemsForModifierList	A query that returns all CatalogItems that have any of the given CatalogModifierLists enabled.	[optional]
items_for_item_options_query	CatalogQueryItemsForItemOptions	A query that returns all CatalogItems that have all of the given CatalogItemOptions.	[optional]
item_variations_for_item_option_values_query	CatalogQueryItemVariationsForItemOptionValues	A query that returns all CatalogItemVariations that have all of the given CatalogItemOption values.	[optional]