Filter

Represents a filter used to refine product listings, such as by price, manufacturer, or attribute.

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 refinement options for product listings and maintains relationships with other filtering-related types. It contains FilterValue objects that define the selectable options within each filter, and can reference a ProductTaxonomyAttribute when the filter is based on product taxonomy classifications. Filters are typically returned as part of product browsing queries to enable client applications to present filtering options to users.

Example


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

Implements

None