Skip to main content

IClusterOption

Container for a set of options belonging to a configurable cluster

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

IClusterOption.clusterOptionId ● Int! non-null scalar

The classID of the cluster that represents this cluster

IClusterOption.isRequired ● YesNo enum

Indicates whether an option is required or not

IClusterOption.hidden ● YesNo enum

Indicates whether an option is hidden or not

IClusterOption.defaultProduct ● Product object

The default product that should be selected for this option

IClusterOption.products ● [Product!] list object

The products that can be added as this typed of option.

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

Localized product name as it is available in the supported language defaults to the product's default language.

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

The long description for this product, this field can contain html formatting, this field can be translated is case of multilingual catalog

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

The short description for this product, this field can contain html formatting, this field can be translated is case of multilingual catalog

Implemented By

ClusterOption object