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

Object Index

You are viewing an old version of the API
CustomAttributeFilter BETA

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.

key
string

A query expression to filter items or item variations by matching their custom attributes' key property value against the specified key.

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.

number_filter
Range

A query expression to filter items or item variations with their custom attributes containing a number value within the specified range.

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.

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?