Skip to main content

ClusterOptionUpdateInput

Input for updating an existing cluster option.

Contains partial cluster option information for updates. Only provided fields will be modified, others remain unchanged. Inherits all validation constraints from cluster option creation with additional update-specific fields.

input ClusterOptionUpdateInput {
  names: [LocalizedStringInput!]
  descriptions: [LocalizedStringInput!]
  shortDescriptions: [LocalizedStringInput!]
  defaultLanguage: String
  isRequired: YesNo
  defaultProductId: Int
  hidden: YesNo
}

Fields​

ClusterOptionUpdateInput.names ● [LocalizedStringInput!] list input​

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 choices to customers.

ClusterOptionUpdateInput.descriptions ● [LocalizedStringInput!] list input​

Detailed descriptions of the cluster option in different languages.

Comprehensive option descriptions providing detailed information about the choice, features, and specifications in multiple languages.

ClusterOptionUpdateInput.shortDescriptions ● [LocalizedStringInput!] list input​

Brief summaries of the cluster option in different languages.

Concise option descriptions used in selection interfaces and previews where space is limited. Provides quick overview of the option choice.

ClusterOptionUpdateInput.defaultLanguage ● String scalar​

Default language code for the cluster option.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE') that serves as the primary language for this option. Used for fallback content when specific language translations are not available.

ClusterOptionUpdateInput.isRequired ● YesNo enum​

Whether this option is required for cluster selection.

When set to 'Y', customers must select this option to complete their product configuration. When set to 'N' or not specified, the option is optional.

ClusterOptionUpdateInput.defaultProductId ● Int scalar​

Default product identifier for the cluster option.

Sets which product should be displayed as the primary or default choice when customers select this option. Must be a valid product ID that exists in the system and is associated with this cluster.

ClusterOptionUpdateInput.hidden ● YesNo enum​

Cluster option visibility status for storefronts.

Controls whether the option is visible to customers in cluster configuration interfaces. When set to 'Y', the option is hidden from customer view; when set to 'N', it is visible.

Member Of​

clusterOptionUpdate mutation