Skip to main content

ClusterUpdateInput

Input for updating an existing product cluster.

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

input ClusterUpdateInput {
  names: [LocalizedStringInput!]
  descriptions: [LocalizedStringInput!]
  shortDescriptions: [LocalizedStringInput!]
  defaultLanguage: String
  parentId: Int
  code: String
  clusterConfigId: Int
  priority: Int
  metadataTitles: [LocalizedStringInput!]
  metadataDescriptions: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrls: [LocalizedStringInput!]
  defaultProductId: Int
  hidden: YesNo
}

Fields​

ClusterUpdateInput.names ● [LocalizedStringInput!] list input​

Localized names for the cluster in different languages.

Collection of cluster names translated into various languages for international support and multilingual storefronts.

ClusterUpdateInput.descriptions ● [LocalizedStringInput!] list input​

Detailed descriptions of the cluster in different languages.

Comprehensive cluster descriptions providing detailed information about the product group, features, and specifications in multiple languages.

ClusterUpdateInput.shortDescriptions ● [LocalizedStringInput!] list input​

Brief summaries of the cluster in different languages.

Concise cluster descriptions used in listings, previews, and search results where space is limited. Provides quick overview of the product group.

ClusterUpdateInput.defaultLanguage ● String scalar​

Default language code for the cluster.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE') that serves as the primary language for this cluster. Must be exactly 2 characters long.

ClusterUpdateInput.parentId ● Int scalar​

Parent cluster or category identifier for hierarchical organization.

ID of the parent cluster or category to create a hierarchical cluster structure. Used for organizing clusters into categories and subcategories.

ClusterUpdateInput.code ● String scalar​

Unique code identifier for the cluster.

Custom alphanumeric code used for cluster identification, integration with external systems, and business-specific referencing.

ClusterUpdateInput.clusterConfigId ● Int scalar​

Cluster configuration identifier.

ID of the cluster configuration that defines how this cluster behaves, including drill-down options, display settings, and product organization rules. Must be a valid configuration ID.

ClusterUpdateInput.priority ● Int scalar​

Display priority for cluster ordering.

Numeric value used for sorting clusters in listings and search results. Higher values appear first. Used for controlling cluster prominence and organization.

ClusterUpdateInput.metadataTitles ● [LocalizedStringInput!] list input​

SEO metadata titles for search engine optimization.

Localized title tags used by search engines and browsers for cluster pages. Optimized titles improve search visibility and click-through rates from search results.

ClusterUpdateInput.metadataDescriptions ● [LocalizedStringInput!] list input​

SEO metadata descriptions for search engine optimization.

Localized meta descriptions used by search engines to display cluster summaries in search results. Well-crafted descriptions improve search visibility and user engagement.

ClusterUpdateInput.metadataKeywords ● [LocalizedStringInput!] list input​

SEO metadata keywords for search engine optimization.

Localized meta keywords used by search engines for cluster indexing and categorization. Helps improve discoverability for relevant search terms.

ClusterUpdateInput.metadataCanonicalUrls ● [LocalizedStringInput!] list input​

SEO canonical URLs for duplicate content management.

Localized canonical URLs that specify the preferred version of cluster pages to search engines. Prevents duplicate content penalties and consolidates page authority.

ClusterUpdateInput.defaultProductId ● Int scalar​

Default product identifier for the cluster.

Sets which product should be displayed as the primary or default option when customers view this cluster. Must be a valid product ID that exists in the system.

ClusterUpdateInput.hidden ● YesNo enum​

Cluster visibility status for storefronts.

Controls whether the cluster is visible to customers in storefronts and search results. When set to 'Y', the cluster is visible; when set to 'N', it is hidden from customer view.

Member Of​

clusterUpdate mutation