Skip to main content

ClusterCreateInput

Input for creating a new product cluster.

Contains all necessary information to establish a new cluster including localized content, configuration settings, hierarchy relationships, and SEO metadata. Clusters group related products and enable configurable product options.

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

Fields​

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

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

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

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

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

ClusterCreateInput.code ● String scalar​

Unique code identifier for the cluster.

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

ClusterCreateInput.clusterConfigId ● Int! non-null 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.

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

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

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

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

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

ClusterCreateInput.hidden ● YesNo! non-null enum​

Cluster visibility status for storefronts.

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

Member Of​

clusterCreate mutation