Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 2.65 KB

CatalogQuery.md

File metadata and controls

17 lines (13 loc) · 2.65 KB

CatalogQuery

Properties

Name Getter Setter Type Description Notes
sorted_attribute_query getSortedAttributeQuery() setSortedAttributeQuery($value) \SquareConnect\Model\CatalogQuerySortedAttribute A query that returns all objects, sorted by the given attribute. [optional]
exact_query getExactQuery() setExactQuery($value) \SquareConnect\Model\CatalogQueryExact A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value. [optional]
prefix_query getPrefixQuery() setPrefixQuery($value) \SquareConnect\Model\CatalogQueryPrefix A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. [optional]
range_query getRangeQuery() setRangeQuery($value) \SquareConnect\Model\CatalogQueryRange A query that returns only objects for which the given (integer-valued) attribute lies in the given range. [optional]
text_query getTextQuery() setTextQuery($value) \SquareConnect\Model\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 getItemsForTaxQuery() setItemsForTaxQuery($value) \SquareConnect\Model\CatalogQueryItemsForTax A query that returns all CatalogItems that have any of the given CatalogTaxes enabled. [optional]
items_for_modifier_list_query getItemsForModifierListQuery() setItemsForModifierListQuery($value) \SquareConnect\Model\CatalogQueryItemsForModifierList A query that returns all CatalogItems that have any of the given CatalogModifierLists enabled. [optional]

Note: All properties are protected and only accessed via getters and setters.

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