Struct square_api_client::models::CatalogQuery

pub struct CatalogQuery {
    pub sorted_attribute_query: Option<CatalogQuerySortedAttribute>,
    pub exact_query: Option<CatalogQueryExact>,
    pub set_query: Option<CatalogQuerySet>,
    pub prefix_query: Option<CatalogQueryPrefix>,
    pub range_query: Option<CatalogQueryRange>,
    pub text_query: Option<CatalogQueryText>,
    pub items_for_tax_query: Option<CatalogQueryItemsForTax>,
    pub items_for_modifier_list_query: Option<CatalogQueryItemsForModifierList>,
    pub items_for_item_options_query: Option<CatalogQueryItemsForItemOptions>,
    pub item_variations_for_item_option_values_query: Option<CatalogQueryItemVariationsForItemOptionValues>,
}

A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the SearchCatalogObjects endpoint.

Although a query can have multiple filters, only certain query types can be combined per call to SearchCatalogObjects. Any combination of the following types may be used together:

• exact_query
• prefix_query
• range_query
• sorted_attribute_query
• text_query All other query types cannot be combined with any others.

When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.

• Searchable attribute and objects queryable by searchable attributes **
• name: CatalogItem, CatalogItemVariation, CatalogCategory, CatalogTax, CatalogDiscount, CatalogModifier, CatalogModifierList, CatalogItemOption, CatalogItemOptionValue
• description: CatalogItem, CatalogItemOptionValue
• abbreviation: CatalogItem
• upc: CatalogItemVariation
• sku: CatalogItemVariation
• caption: CatalogImage
• display_name: CatalogItemOption

For example, to search for [CatalogItem] objects by searchable attributes, you can use the "name", "description", or "abbreviation" attribute in an applicable query filter.

Fields

sorted_attribute_query: Option<CatalogQuerySortedAttribute>

A query expression to sort returned query result by the given attribute.

exact_query: Option<CatalogQueryExact>

An exact query expression to return objects with attribute name and value matching the specified attribute name and value exactly. Value matching is case insensitive.

set_query: Option<CatalogQuerySet>

A set query expression to return objects with attribute name and value matching the specified attribute name and any of the specified attribute values exactly. Value matching is case insensitive.

prefix_query: Option<CatalogQueryPrefix>

A prefix query expression to return objects with attribute values that have a prefix matching the specified string value. Value matching is case insensitive.

range_query: Option<CatalogQueryRange>

A range query expression to return objects with numeric values that lie in the specified range.

text_query: Option<CatalogQueryText>

A text query expression to return objects whose searchable attributes contain all of the given keywords, irrespective of their order. For example, if a CatalogItem contains custom attribute values of {"name": "t-shirt"} and {"description": "Small, Purple"}, the query filter of {"keywords": ["shirt", "sma", "purp"]} returns this item.

items_for_tax_query: Option<CatalogQueryItemsForTax>

A query expression to return items that have any of the specified taxes (as identified by the corresponding CatalogTax object IDs) enabled.

items_for_modifier_list_query: Option<CatalogQueryItemsForModifierList>

A query expression to return items that have any of the given modifier list (as identified by the corresponding CatalogModifierLists IDs) enabled.

items_for_item_options_query: Option<CatalogQueryItemsForItemOptions>

A query expression to return items that contains the specified item options (as identified the corresponding CatalogItemOption IDs).

item_variations_for_item_option_values_query: Option<CatalogQueryItemVariationsForItemOptionValues>

A query expression to return item variations (of the CatalogItemVariation type) that contain all of the specified CatalogItemOption IDs.

Trait Implementations

impl Clone for CatalogQuery

fn clone(&self) -> CatalogQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogQuery

fn default() -> CatalogQuery

Returns the “default value” for a type.

impl PartialEq<CatalogQuery> for CatalogQuery

fn eq(&self, other: &CatalogQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CatalogQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CatalogQuery

impl StructuralEq for CatalogQuery

impl StructuralPartialEq for CatalogQuery