Object Index / Definition

You are viewing an old version of the API
CatalogQuery

A query to be applied to a SearchCatalogObjectsRequest.

Properties

Name Description
sorted_attribute_query
CatalogQuerySortedAttribute

A query that returns all objects, sorted by the given attribute.

exact_query
CatalogQueryExact

A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value.

prefix_query
CatalogQueryPrefix

A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix.

range_query
CatalogQueryRange

A query that returns only objects for which the given (integer-valued) attribute lies in the given range.

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"]}.

items_for_tax_query
CatalogQueryItemsForTax

A query that returns all CatalogItems that have any of the given CatalogTaxes enabled.

items_for_modifier_list_query
CatalogQueryItemsForModifierList

A query that returns all CatalogItems that have any of the given CatalogModifierLists enabled.

items_for_item_options_query
CatalogQueryItemsForItemOptions

Beta

A query that returns all CatalogItems that have all of the given CatalogItemOptions.

item_variations_for_item_option_values_query
CatalogQueryItemVariationsForItemOptionValues

Beta

A query that returns all CatalogItemVariations that have all of the given CatalogItemOption values.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?