Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.79 KB

custom-attribute-filter.md

File metadata and controls

40 lines (31 loc) · 1.79 KB
Raw

Custom Attribute Filter

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

Structure

Custom Attribute Filter

Fields

Name Type Tags Description
custom_attribute_definition_id string 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.
key string Optional A query expression to filter items or item variations by matching their custom attributes'
key property value against
the specified key.
string_filter string Optional A query expression to filter items or item variations by matching their custom attributes'
string_value property value
against the specified text.
number_filter Range Optional The range of a number value between the specified lower and upper bounds.
selection_uids_filter List of string Optional A query expression to filter items or item variations by matching their custom attributes'
selection_uid_values
values against the specified selection uids.
bool_filter bool Optional A query expression to filter items or item variations by matching their custom attributes'
boolean_value property values
against the specified Boolean expression.

Example (as JSON)

{
  "custom_attribute_definition_id": "custom_attribute_definition_id2",
  "key": "key0",
  "string_filter": "string_filter2",
  "number_filter": {
    "min": "min8",
    "max": "max4"
  },
  "selection_uids_filter": [
    "selection_uids_filter4",
    "selection_uids_filter5"
  ]
}