Skip to main content

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!
  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​

The names of this product per language

ICluster.names.language ● String scalar​

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

The descriptions of this product per language

ICluster.descriptions.language ● String scalar​

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

The short descriptions of this product per language

ICluster.shortDescriptions.language ● String scalar​

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

The slugs for this product per language

ICluster.slugs.language ● String scalar​

ICluster.sku ● String! non-null scalar​

The SKU (stock keeping unit) of this product

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.

ICluster.clusterId ● Int! non-null scalar​

The classID of this cluster

ICluster.products ● [Product!] list object​

Array of selectable main products for this cluster, when the array contains more than one. Only one can be added per cart/order item

ICluster.createdAt ● DateTime! non-null scalar​

The creation date of this product

ICluster.lastModifiedAt ● DateTime! non-null scalar​

The last modified date of this product

ICluster.options ● [ClusterOption!] list object​

The configuration options for this cluster

ICluster.drillDowns ● [ClusterDrillDown!] deprecated list object​

DEPRECATED

Use config.setting instead

The drilldown configuration for this cluster

ICluster.defaultProduct ● Product object​

The default product that should be selected for this option

ICluster.config ● ClusterConfig object​

Implemented By​

Cluster object