Supported custom attribute query expressions for calling the SearchCatalogItems endpoint to search for items or item variations.
CustomAttributeFilter
| Name | Type | Tags | Description |
|---|---|---|---|
customAttributeDefinitionId |
string | undefined |
Optional | 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 | undefined |
Optional | 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. |
stringFilter |
string | undefined |
Optional | 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. |
numberFilter |
Range | undefined |
Optional | The range of a number value between the specified lower and upper bounds. |
selectionUidsFilter |
string[] | undefined |
Optional | 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. |
boolFilter |
boolean | undefined |
Optional | 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. |
{
"custom_attribute_definition_id": null,
"key": null,
"string_filter": null,
"number_filter": null,
"selection_uids_filter": null,
"bool_filter": null
}