• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
CustomAttributeFilter

Supported custom attribute query expressions for calling the SearchCatalogItems endpoint to search for items or item variations.

Properties

Name Description
custom_attribute_definition_id
string

A query expression to filter items or item variations by matching their custom attributes' custom_attribute_definition_id property value against the the specified id. Exactly one of custom_attribute_definition_id or key must be specified.

key
string

A query expression to filter items or item variations by matching their custom attributes' key property value against the specified key. Exactly one of custom_attribute_definition_id or key must be specified.

string_filter
string

A query expression to filter items or item variations by matching their custom attributes' string_value property value against the specified text. Exactly one of string_filter, number_filter, selection_uids_filter, or bool_filter must be specified.

number_filter
Range

A query expression to filter items or item variations with their custom attributes containing a number value within the specified range. Exactly one of string_filter, number_filter, selection_uids_filter, or bool_filter must be specified.

selection_uids_filter
string [ ]

A query expression to filter items or item variations by matching their custom attributes' selection_uid_values values against the specified selection uids. Exactly one of string_filter, number_filter, selection_uids_filter, or bool_filter must be specified.

bool_filter
boolean

A query expression to filter items or item variations by matching their custom attributes' boolean_value property values against the specified Boolean expression. Exactly one of string_filter, number_filter, selection_uids_filter, or bool_filter must be specified.