Skip to main content

ClusterUpdateInput

Input for updating an existing cluster (partial update)

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

Fields​

ClusterUpdateInput.names ● [LocalizedStringInput!] list input​

Localized names shown to end users in catalog and search surfaces. The catalogue's default language must be present.

ClusterUpdateInput.descriptions ● [LocalizedStringInput!] list input​

Localized long-form descriptions shown on product detail surfaces.

ClusterUpdateInput.shortDescriptions ● [LocalizedStringInput!] list input​

Localized short descriptions surfaced in listings and tiles.

ClusterUpdateInput.slugs ● [LocalizedStringInput!] list input​

URL-friendly identifiers, one per language, used in human-readable links.

ClusterUpdateInput.sku ● String scalar​

Stock keeping unit. Uniquely identifies a product within the catalogue.

ClusterUpdateInput.code ● String scalar​

Cluster code. Uniquely identifies a cluster within the catalogue and is only meaningful on cluster records.

ClusterUpdateInput.defaultLanguage ● String scalar​

Legacy single-language hint retained for backward compatibility; use the localized fields instead.

ClusterUpdateInput.parentId ● Int scalar​

Identifier of the category exposed as the default for federation purposes.

ClusterUpdateInput.clusterConfigId ● Int scalar​

Identifier of the configuration template applied to the cluster.

ClusterUpdateInput.defaultProductId ● Int scalar​

Default product ID for this cluster - Sets the default cluster-product relationship

ClusterUpdateInput.autoGenerateSlugs ● Boolean scalar​

Whether to auto-generate slugs from names. When true (default), slugs are always regenerated for languages with names unless explicitly provided. When false, slugs are only generated for languages without existing slugs in the database.

ClusterUpdateInput.hidden ● YesNo enum​

Hides the record from public catalog and search surfaces when set.

ClusterUpdateInput.priority ● Int scalar​

Relative ranking used when ordering records; higher values surface first.

ClusterUpdateInput.metadataTitles ● [LocalizedStringInput!] list input​

Localized titles surfaced in search engine result pages.

ClusterUpdateInput.metadataDescriptions ● [LocalizedStringInput!] list input​

Localized descriptive snippets surfaced in search engine result pages.

ClusterUpdateInput.metadataKeywords ● [LocalizedStringInput!] list input​

Localized keyword lists used by search engines, supplied as comma-separated values.

ClusterUpdateInput.metadataCanonicalUrls ● [LocalizedStringInput!] list input​

Localized canonical URLs that search engines should treat as the authoritative location.

ClusterUpdateInput.sources ● [SourceInput!] list input​

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

Member Of​

clusterUpdate mutation