Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.76 KB

File metadata and controls

21 lines (15 loc) · 1.76 KB

CatalogQuery

squareconnect.models.catalog_query

Description

A query to be applied to a SearchCatalogObjectsRequest request. 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, or CatalogModifier). For example, a query that should return Items may specify an attribute names from any of the searchable fields of the CatalogItem data type, namely \"name\", \"description\", and \"abbreviation\".

Properties

Name Type Notes
sorted_attribute_query CatalogQuerySortedAttribute [optional]
exact_query CatalogQueryExact [optional]
prefix_query CatalogQueryPrefix [optional]
range_query CatalogQueryRange [optional]
text_query CatalogQueryText [optional]
items_for_tax_query CatalogQueryItemsForTax [optional]
items_for_modifier_list_query CatalogQueryItemsForModifierList [optional]

[Back to Model list] [Back to API list] [Back to README]