Skip to main content

Cluster

No description

type Cluster implements ICluster, IBaseProduct, IResource {
  id: Int!
  clusterId: Int!
  categoryId: Int!
  attributes(
    input: AttributeResultSearchInput
  ): AttributeResultResponse
  category: Category!
  categoryPath: [Category!]!
  favoriteLists(
    input: FavoriteListsSearchInput
  ): FavoriteListsResponse
  orderlists(
    input: OrderlistSearchInput
  ): OrderlistsResponse!
  products: [Product!]
  options: [ClusterOption!]
  drillDowns: [ClusterDrillDown!] @deprecated
  defaultProduct: Product
  config: ClusterConfig
  names(
    language: String
  ): [LocalizedString!]!
  descriptions(
    language: String
  ): [LocalizedString!]!
  shortDescriptions(
    language: String
  ): [LocalizedString!]!
  slugs(
    language: String
  ): [LocalizedString!]!
  sku: String!
  defaultLanguage: String!
  language: String
  class: ProductClass!
  hidden: YesNo!
}

Fields​

Cluster.id ● Int! non-null scalar​

Resource primary identifier

Cluster.clusterId ● Int! non-null scalar​

The classID of this cluster

Cluster.categoryId ● Int! non-null scalar​

Cluster.attributes ● AttributeResultResponse object​

Lists attributes for this cluster based on the search input.

Cluster.attributes.input ● AttributeResultSearchInput input​

Cluster.category ● Category! non-null object​

Cluster.categoryPath ● [Category!]! non-null object​

Cluster.favoriteLists ● FavoriteListsResponse object​

Cluster.favoriteLists.input ● FavoriteListsSearchInput input​

Cluster.orderlists ● OrderlistsResponse! non-null object​

Cluster.orderlists.input ● OrderlistSearchInput input​

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

Cluster.options ● [ClusterOption!] list object​

The configuration options for this cluster

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

DEPRECATED

Use config.setting instead

The drilldown configuration for this cluster

Cluster.defaultProduct ● Product object​

Cluster.config ● ClusterConfig object​

Cluster.names ● [LocalizedString!]! non-null object​

Cluster.names.language ● String scalar​

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

Cluster.descriptions.language ● String scalar​

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

Cluster.shortDescriptions.language ● String scalar​

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

Cluster.slugs.language ● String scalar​

Cluster.sku ● String! non-null scalar​

The SKU (stock keeping unit) of this product

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

Cluster.language ● String scalar​

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

Cluster.class ● ProductClass! non-null enum​

The class of the request resource

Cluster.hidden ● YesNo! non-null enum​

The hidden status of this resource.

Interfaces​

ICluster interface​

The interface for the Cluster type

IBaseProduct interface​

Interface for the BaseProduct Type, where both Products and clusters derive from

IResource interface​

Returned By​

cluster query

Member Of​

Product object