FilterValue
object

Choose a version:

Requires unauthenticated_read_product_listings access scope.

A selectable value within a filter.

Fields

Anchor to FilterValue.count count Int! non-null: The number of results that match this filter value.
Anchor to FilterValue.id id String! non-null: A unique identifier.
Anchor to FilterValue.image image MediaImage: The visual representation when the filter's presentation is IMAGE.
Anchor to FilterValue.input input JSON! non-null: An input object that can be used to filter by this value on the parent field.

The value is provided as a helper for building dynamic filtering UI. For example, if you have a list of selected FilterValue objects, you can combine their respective input values to use in a subsequent query.
Anchor to FilterValue.label label String! non-null: A human-friendly string for this filter value.
Anchor to FilterValue.swatch swatch Swatch: The visual representation when the filter's presentation is SWATCH.

Was this section helpful?