Docs
Dashboard

FacetFieldInput

Input

Configures the source field and optional included values for a facet.

#

Fields


attributeId
ID

The product attribute ID when kind is attribute.

excludedValues
[String!]

Values excluded while using automatic selection.

key
String

The metafield key when kind is metafield.

kind
FacetFieldKind!

The facet field kind.

Possible enum values
  • ATTRIBUTE

    Uses values from a configured product attribute.

  • AVAILABILITY

    Uses purchasing availability as the facet value.

  • METAFIELD

    Uses values from a configured metafield.

  • PRICE

    Uses product prices to create facet ranges.

  • TAG

    Uses product tags as facet values.

  • VENDOR

    Uses product vendors as facet values.

knownValues
[String!]

Values previously observed for this facet field.

namespace
String

The metafield namespace when kind is metafield.

owner
FacetMetafieldOwner

The metafield owner when kind is metafield. Defaults to the facet association.

Possible enum values
  • PRODUCT

    Reads facet values from product metafields.

  • PRODUCT_VARIANT

    Reads facet values from product-variant metafields.

valueOrder
[String!]

The preferred display order of active values.

valueSelectionMode
FacetValueSelectionMode

Whether new values are included automatically or selected manually.

Possible enum values
  • AUTOMATIC

    Derives selectable values automatically from catalog data.

  • MANUAL

    Uses the explicitly configured set of selectable values.

values
[String!]

The explicitly included values when selection mode is manual.