Docs
Dashboard

FacetField

Object

Fields returned for facet field.

#

Fields


attributeId
ID

The attribute id associated with this facet field.

excludedValues
[String!]!

The excluded values associated with this facet field.

key
String

The key associated with this facet field.

kind
FacetFieldKind!

The kind associated with this facet field.

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!]!

The known values associated with this facet field.

namespace
String

The namespace associated with this facet field.

owner
FacetMetafieldOwner

The owner associated with this facet field.

Possible enum values
  • PRODUCT

    Reads facet values from product metafields.

  • PRODUCT_VARIANT

    Reads facet values from product-variant metafields.

valueOrder
[String!]!

The value order associated with this facet field.

valueSelectionMode
FacetValueSelectionMode

The value selection mode associated with this facet field.

Possible enum values
  • AUTOMATIC

    Derives selectable values automatically from catalog data.

  • MANUAL

    Uses the explicitly configured set of selectable values.

values
[String!]!

The values associated with this facet field.