Przejdź do głównej zawartości

ConfiguratorField

A single field of a product configurator — an input the shopper sees on the product page.

type ConfiguratorField {
  description: String
  filledBy: AttributeFillingMode!
  handle: String!
  id: ID!
  isVisible: Boolean!
  maxValue: Float
  minValue: Float
  name: String!
  options: [ConfiguratorOption!]!
  pricingMode: AttributeBillingMode
  required: Boolean!
  sortOrder: Int!
  type: AttributeType!
  visibleIf: [ConfiguratorFieldCondition!]
}

Fields​

ConfiguratorField.description ● String scalar​

Optional help text shown beneath the field.

ConfiguratorField.filledBy ● AttributeFillingMode! non-null enum​

Who provides the value — CUSTOMER (the shopper fills it in) or BOTH (seller sets a default the shopper can change). Seller-only metadata fields are not returned here.

ConfiguratorField.handle ● String! non-null scalar​

URL-friendly key for the field.

ConfiguratorField.id ● ID! non-null scalar​

Stable identifier of this field.

ConfiguratorField.isVisible ● Boolean! non-null scalar​

Whether this field should be shown on the storefront.

ConfiguratorField.maxValue ● Float scalar​

Upper bound — maximum value (NUMBER) or maximum length (TEXT).

ConfiguratorField.minValue ● Float scalar​

Lower bound — minimum value (NUMBER) or minimum length (TEXT).

ConfiguratorField.name ● String! non-null scalar​

Field label shown to the shopper (e.g. "Finish").

ConfiguratorField.options ● [ConfiguratorOption!]! non-null object​

Selectable choices for SELECT / RADIO / CHECKBOX fields; empty for free-input types (TEXT, NUMBER, …).

ConfiguratorField.pricingMode ● AttributeBillingMode enum​

If a choice adds cost, how it is billed — BUNDLED (folded into the product price) or SEPARATE_LINE (its own order line). Null when the field has no price impact.

ConfiguratorField.required ● Boolean! non-null scalar​

Whether the shopper must provide a value before adding the product to the cart.

ConfiguratorField.sortOrder ● Int! non-null scalar​

Order in which to render this field.

ConfiguratorField.type ● AttributeType! non-null enum​

Input type — controls how to render the field (TEXT, TEXTAREA, SELECT, RADIO, CHECKBOX, NUMBER, COLOR, …).

ConfiguratorField.visibleIf ● [ConfiguratorFieldCondition!] list object​

Visibility rules (AND). Null/absent = always visible. Render the field only when every rule is met against the current selections; when it becomes hidden, clear its value — the server rejects selections for hidden fields. Use this to render dependent sub-components indented under their parent.

Member Of​

Product object