ConfiguratorOption

A selectable choice within a product configurator field (e.g. a size, finish or add-on).

type ConfiguratorOption {
  colorHex: String
  id: ID!
  isDefault: Boolean!
  label: String!
  linkedVariant: LinkedVariantSummary
  sortOrder: Int!
  surchargeAmount: Int
  surchargeType: AttributeOptionSurchargeType
  value: String!
}

Fields

ConfiguratorOption.colorHex ● String scalar

Hex colour for swatch rendering (COLOR fields).

ConfiguratorOption.id ● ID! non-null scalar

Stable identifier of this choice.

ConfiguratorOption.isDefault ● Boolean! non-null scalar

Whether this choice is pre-selected by default.

ConfiguratorOption.label ● String! non-null scalar

Human-readable label shown to the shopper.

ConfiguratorOption.linkedVariant ● LinkedVariantSummary object

The stocked variant this choice maps to (used for inventory-backed components). Null when the choice maps to no variant or the variant no longer exists.

ConfiguratorOption.sortOrder ● Int! non-null scalar

Order in which to render this choice.

ConfiguratorOption.surchargeAmount ● Int scalar

Extra charge applied when this choice is selected. With surchargeType FIXED it is an amount in minor currency units (e.g. 500 = 5.00). With PERCENT it is thousandths of a percent (e.g. 1500 = 1.5%).

ConfiguratorOption.surchargeType ● AttributeOptionSurchargeType enum

How to interpret surchargeAmount — FIXED (a money amount) or PERCENT.

ConfiguratorOption.value ● String! non-null scalar

Machine value (slug-style) — use it for form state and when submitting the choice to the cart.

Member Of

ConfiguratorField object