Skip to main content

IClusterOption

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.

interface IClusterOption {
  id: Int!
  clusterOptionId: Int!
  isRequired: YesNo
  hidden: YesNo
  defaultProduct: Product
  products: [Product!]
  names: [LocalizedString!]!
  descriptions: [LocalizedString!]!
  shortDescriptions: [LocalizedString!]!
}

Fields​

IClusterOption.id ● Int! non-null scalar​

Unique identifier for the cluster option.

System-generated ID

IClusterOption.clusterOptionId ● Int! non-null scalar​

Cluster option unique identifier.

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

IClusterOption.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.

IClusterOption.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.

IClusterOption.defaultProduct ● Product object​

Default product selection for this option.

Product that is pre-selected when customers first view this option, providing a recommended or the first choice to streamline the configuration process.

IClusterOption.products ● [Product!] list object​

Available products for customer selection within this option.

Collection of products that customers can choose from when configuring this cluster option. Each product represents a different variant or choice within the option category.

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

Localized names for the cluster option in different languages.

Collection of option names translated into various languages for international support and multilingual storefronts. Used for displaying option labels to customers.

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

Detailed descriptions of the cluster option in multiple languages.

Comprehensive option descriptions providing detailed information about what this option represents and how it affects the final product configuration.

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

Brief summaries of the cluster option in different languages.

Concise option descriptions used in configuration interfaces where space is limited, providing quick explanations of the option's purpose and impact.

Implemented By​

ClusterOption object