Skip to main content

ClusterCreateInput

Input for creating a new cluster

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

Fields​

ClusterCreateInput.names ● [LocalizedStringInput!] list input​

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

ClusterCreateInput.descriptions ● [LocalizedStringInput!] list input​

Localized long-form descriptions shown on product detail surfaces.

ClusterCreateInput.shortDescriptions ● [LocalizedStringInput!] list input​

Localized short descriptions surfaced in listings and tiles.

ClusterCreateInput.slugs ● [LocalizedStringInput!] list input​

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

ClusterCreateInput.metadataTitles ● [LocalizedStringInput!] list input​

Localized titles surfaced in search engine result pages.

ClusterCreateInput.metadataDescriptions ● [LocalizedStringInput!] list input​

Localized descriptive snippets surfaced in search engine result pages.

ClusterCreateInput.metadataKeywords ● [LocalizedStringInput!] list input​

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

ClusterCreateInput.metadataCanonicalUrls ● [LocalizedStringInput!] list input​

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

ClusterCreateInput.code ● String scalar​

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

ClusterCreateInput.parentId ● Int scalar​

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

ClusterCreateInput.clusterConfigId ● Int! non-null scalar​

Identifier of the configuration template applied to the cluster.

ClusterCreateInput.defaultProductId ● Int scalar​

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

ClusterCreateInput.hidden ● YesNo! non-null enum​

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

ClusterCreateInput.priority ● Int scalar​

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

ClusterCreateInput.autoGenerateSlugs ● Boolean scalar​

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

ClusterCreateInput.sources ● [SourceInput!] list input​

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

Member Of​

clusterCreate mutation