ClusterOptionCreateInput

Input for creating a new cluster option

input ClusterOptionCreateInput {
  isRequired: YesNo
  hidden: YesNo!
  defaultProductId: Int
  names: [LocalizedStringInput!]
  descriptions: [LocalizedStringInput!]
  shortDescriptions: [LocalizedStringInput!]
  productIds: [Int!]
  sources: [SourceInput!]
}

Fields

ClusterOptionCreateInput.isRequired ● YesNo enum

Indicates whether the customer must choose a value for the option to complete the cluster configuration.

ClusterOptionCreateInput.hidden ● YesNo! non-null enum

Hides the option from public catalog and configuration surfaces when set.

ClusterOptionCreateInput.defaultProductId ● Int scalar

Identifier of the product preselected as the default choice for the option.

ClusterOptionCreateInput.names ● [LocalizedStringInput!] list input

Localized names shown to end users when presenting the option. The catalogue's default language must be present.

ClusterOptionCreateInput.descriptions ● [LocalizedStringInput!] list input

Localized long-form descriptions shown when the customer explores the option.

ClusterOptionCreateInput.shortDescriptions ● [LocalizedStringInput!] list input

Localized short descriptions shown next to the option in listings and configurators.

ClusterOptionCreateInput.productIds ● [Int!] list scalar

Products that the customer can pick from for the option.

ClusterOptionCreateInput.sources ● [SourceInput!] list input

Pairs of external system names and the identifiers each system assigned to the cluster option.

Member Of

clusterOptionCreate mutation