filter_value

A specific value of a filter.

PropertiesTypeDescription
activebooleanReturns true if the value is currently active. Returns false if not.
countnumberThe number of results related to the filter value. Returns nil for price_range type filters.
labelstringThe customer-facing label for the filter value. For example, Red or Rouge.
param_namestringThe URL parameter for the parent filter of the filter value. For example, filter.v.option.color.

Filters of type price_range include an extra component depending on whether the filter value is for the filtermin_value or max_value. The param_name of the min_value is filter.v.price.lte. The param_name of the max_value is filter.v.price.gte.
url_to_addstringThe current page URL with the filter value parameter added.
url_to_removestringThe current page URL with the filter value parameter removed.
valuestringThe value.
{
  "active": true,
  "count": null,
  "label": "To",
  "param_name": "filter.v.price.lte",
  "url_to_add": "/collections/all-collections?=&filter.v.price.lte=",
  "url_to_remove": "/collections/all-collections?=",
  "value": ""
}