filter_value

A specific value of a filter.

Properties

Type

Description

active

boolean

Returns true if the value is currently active. Returns false if not.

count

number

The number of results related to the filter value. Returns nil for price_range type filters.

label

string

The customer-facing label for the filter value. For example, Red or Rouge.

param_name

string

The 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_add

string

The current page URL with the filter value parameter added.

url_to_remove

string

The current page URL with the filter value parameter removed.

value

string

The 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": ""
}