Filter

A product listing filter, including its type, available values, and range information.

Type Definition


type Filter {
  label: String
  maxValue: FilterValue
  minValue: FilterValue
  paramName: String
  rangeMax: Float
  rangeMin: Float
  type: String
  values: [FilterValue]
  taxonomyAttribute: ProductTaxonomyAttribute
}

Fields

Field	Type	Description
label	String	The display name for this filter. Only attribute filters are localized. Useful for showing the filter’s label in the API.
maxValue	FilterValue	For range filters, provides the maximum selectable value for this filter.
minValue	FilterValue	For range filters, provides the minimum selectable value for this filter.
paramName	String	The handle used for this filter in GraphQL queries.
rangeMax	Float	The highest possible value for this filter if it is a range type.
rangeMin	Float	The lowest possible value for this filter if it is a range type.
type	String	The type of filter, such as ‘list’ or ‘range’.
values	[FilterValue]	The available values for this filter, such as selectable options or attribute values.
taxonomyAttribute	ProductTaxonomyAttribute	The taxonomy attribute associated with this filter, if applicable.

Relationships

The Filter type represents structured filtering options available for product listings. It relates to FilterValue objects which define the individual selectable options within a filter, and may reference a ProductTaxonomyAttribute to provide taxonomy context for attribute-based filters. Filters can be either list-type (with discrete values) or range-type (with minimum and maximum bounds).

Example


{
  label
  paramName
  type
  rangeMin
  rangeMax
  values {
    label
    value
  }
  minValue {
    label
    value
  }
  maxValue {
    label
    value
  }
}

Implements

This type does not implement any interfaces.