Skip to main content

ClusterOption

No description

type ClusterOption implements IClusterOption {
  id: Int!
  clusterOptionId: Int!
  isRequired: YesNo
  hidden: YesNo
  defaultProduct(
    hidden: Boolean
  ): Product
  products(
    input: ClusterOptionProductSearchInput
  ): [Product!]
  names(
    language: String
  ): [LocalizedString!]!
  descriptions(
    language: String
  ): [LocalizedString!]!
  shortDescriptions(
    language: String
  ): [LocalizedString!]!
}

Fields​

ClusterOption.id ● Int! non-null scalar​

Unique identifier for the cluster option.

System-generated ID

ClusterOption.clusterOptionId ● Int! non-null scalar​

Cluster option unique identifier.

System-generated ID used for referencing this specific option within cluster configurations and customer selections.

ClusterOption.isRequired ● YesNo enum​

Requirement status for customer selection.

When 'Y', customers must select a product from this option to complete their configuration. When 'N', this option is optional and customers can skip it.

ClusterOption.hidden ● YesNo enum​

Visibility status for customer interfaces.

When 'Y', this option is hidden from customers and not displayed in configuration interfaces. When 'N', this option is visible and available for customer selection.

ClusterOption.defaultProduct ● Product object​

ClusterOption.defaultProduct.hidden ● Boolean scalar​

ClusterOption.products ● [Product!] list object​

ClusterOption.products.input ● ClusterOptionProductSearchInput input​

ClusterOption.names ● [LocalizedString!]! non-null object​

ClusterOption.names.language ● String scalar​

ClusterOption.descriptions ● [LocalizedString!]! non-null object​

ClusterOption.descriptions.language ● String scalar​

ClusterOption.shortDescriptions ● [LocalizedString!]! non-null object​

ClusterOption.shortDescriptions.language ● String scalar​

Interfaces​

IClusterOption interface​

Configurable option within a product cluster for customer selection.

Represents a selectable option that customers can choose when configuring a cluster product, such as size, color, or variant. Each option contains a set of products and configuration settings that define customer choices.

Returned By​

clusterOptionCreate mutation ● clusterOptionUpdate mutation

Member Of​

Cluster object ● ICluster interface