Object Index
You are viewing an old version of the API
CatalogQuery
Object Index
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 one query is allowed per call to SearchCatalogObjects.
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,CatelogCatogry,CatalogTax,CatalogDiscount,CatalogModifier, 'CatalogModifierList,CatalogItemOption,CatalogItemOptionValue`description:CatalogItem,CatalogItemOptionValueabbreviation:CatalogItemupc:CatalogItemVariationsku:CatalogItemVariationcaption:CatalogImagedisplay_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
|
A query expression to sort returned query result by the given attribute. |
exact_query
|
An exact query expression to return objects with attribute name and value |
prefix_query
|
A prefix query expression to return objects with attribute values that have a prefix matching the specified string value. Value maching is case insensitive. |
range_query
|
A range query expression to return objects with numberic values that lie in the specified range. |
text_query
|
A text query expression to return objectd whose searchable attributes contain all of the given
keywords, irrespective of their order. For example, if a |
items_for_tax_query
|
A query expression to return items that have any of the specified taxes (as identified by the corresponding |
items_for_modifier_list_query
|
A query expression to return items that have any of the given modifier list (as identifieid by the coresponding |
items_for_item_options_query
Beta
|
A query expression to return items that contains the specified item options (as identified the corresponding |
item_variations_for_item_option_values_query
Beta
|
A query expression to return item variations (of the CatalogItemVariation type) that
contain all of the specified |