ICluster

The interface for the Cluster type

interface ICluster {
  id: Int!
  language: String
  class: ProductClass!
  hidden: YesNo!
  names(
    language: String
  ): [LocalizedString!]!
  descriptions(
    language: String
  ): [LocalizedString!]!
  shortDescriptions(
    language: String
  ): [LocalizedString!]!
  slugs(
    language: String
  ): [LocalizedString!]!
  sku: String!
  categoryId: Int!
  defaultLanguage: String!
  priority: Int
  metadataTitles: [LocalizedString!]
  metadataDescriptions: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrls: [LocalizedString!]
  sources: [Source!]!
  clusterId: Int!
  products: [Product!]
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  options: [ClusterOption!]
  drillDowns: [ClusterDrillDown!] @deprecated
  defaultProduct: Product
  config: ClusterConfig
}

Fields

`ICluster.id` ● `Int!` non-null scalar

Resource primary identifier

`ICluster.language` ● `String` scalar

The requested language for this this resource, default to the products default language. ISO 639-1 format.

`ICluster.class` ● `ProductClass!` non-null enum

The class of the request resource

`ICluster.hidden` ● `YesNo!` non-null enum

The hidden status of this resource.

`ICluster.names` ● `[LocalizedString!]!` non-null object

Localized product names for different languages.

Collection of product names in various languages for international markets and multilingual storefronts.

`ICluster.names.language` ● `String` scalar

Language code to filter names.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE'). If provided, returns only names for that language.

`ICluster.descriptions` ● `[LocalizedString!]!` non-null object

Detailed product descriptions in multiple languages.

Comprehensive product information including features, specifications, and benefits for each supported language.

`ICluster.descriptions.language` ● `String` scalar

Language code to filter descriptions.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE'). If provided, returns only descriptions for that language.

`ICluster.shortDescriptions` ● `[LocalizedString!]!` non-null object

Brief product summaries for listings and previews.

Concise product descriptions suitable for category pages, search results, and product cards where space is limited.

`ICluster.shortDescriptions.language` ● `String` scalar

`ICluster.slugs` ● `[LocalizedString!]!` non-null object

URL-friendly product identifiers for each language.

SEO-optimized URL segments used in product page URLs for better search engine visibility and user-friendly links.

`ICluster.slugs.language` ● `String` scalar

`ICluster.sku` ● `String!` non-null scalar

Stock Keeping Unit for inventory management.

Unique alphanumeric code used for inventory tracking, order processing, and product identification across all systems and channels.

`ICluster.categoryId` ● `Int!` non-null scalar

`ICluster.defaultLanguage` ● `String!` non-null scalar

The default language for this product or cluster, this is the language to fall back too, when there is no translation available in a specific language.