Object Index

You are viewing an old version of the API

All Versions

CatalogQuery

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
sortedattributequery
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.

Properties

Name	Description
`sorted_attribute_query CatalogQuerySortedAttribute`	A query expression to sort returned query result by the given attribute.
`exact_query 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 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 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 CatalogQueryRange`	A range query expression to return objects with numeric values that lie in the specified range.
`text_query 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 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 CatalogQueryItemsForModifierList`	A query expression to return items that have any of the given modifier list (as identified by the corresponding `CatalogModifierList`s IDs) enabled.
`items_for_item_options_query CatalogQueryItemsForItemOptions` Beta	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 CatalogQueryItemVariationsForItemOptionValues` Beta	A query expression to return item variations (of the CatalogItemVariation type) that contain all of the specified `CatalogItemOption` IDs.

Object Index You are viewing an old version of the API 2021-01-21 Version 2021-01-21 All Versions CatalogQuery

Properties

Share Feedback

Object Index

You are viewing an old version of the API

All Versions

CatalogQuery