Interface: Cluster

Defined in: type/Cluster.ts:19

Object class for Cluster

Extends

• IBaseProduct

Properties

attributes?

optional attributes?: AttributeResultResponse

Defined in: type/Cluster.ts:27

Lists attributes for this cluster based on the search input.

---

categories?

optional categories?: CategoryResponse

Defined in: type/Cluster.ts:29

All the categories the cluster belongs to

---

category

category: Category

Defined in: type/Cluster.ts:31

category field

---

categoryId

categoryId: number

Defined in: type/Cluster.ts:25

categoryId field

Overrides

IBaseProduct.categoryId

---

categoryIds

categoryIds: number[]

Defined in: type/Cluster.ts:84

Identifiers of every category the product belongs to.

Overrides

IBaseProduct.categoryIds

---

categoryPath

categoryPath: Category[]

Defined in: type/Cluster.ts:33

categoryPath field

---

categoryRelations

categoryRelations: BaseProductCategoryRelationship[]

Defined in: type/Cluster.ts:90

categoryRelations field

---

clusterConfig?

optional clusterConfig?: ClusterConfig

Defined in: type/Cluster.ts:88

clusterConfig field

---

clusterId

clusterId: number

Defined in: type/Cluster.ts:23

The classID of this cluster

---

code?

optional code?: string

Defined in: type/Cluster.ts:86

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

---

config?

optional config?: ClusterConfig

Defined in: type/Cluster.ts:53

config field

---

createdAt

createdAt: string

Defined in: type/Cluster.ts:45

The creation date of this product

Overrides

IBaseProduct.createdAt

---

crossupsellsFrom

crossupsellsFrom: CrossupsellsResponse

Defined in: type/Cluster.ts:35

crossupsellsFrom field

---

crossupsellsTo

crossupsellsTo: CrossupsellsResponse

Defined in: type/Cluster.ts:37

crossupsellsTo field

---

defaultLanguage

defaultLanguage: string

Defined in: type/IBaseProduct.ts:26

The default language for this product or cluster

Inherited from

IBaseProduct.defaultLanguage

---

defaultProduct?

optional defaultProduct?: Product

Defined in: type/Cluster.ts:51

defaultProduct field

---

descriptions

descriptions: LocalizedString[]

Defined in: type/Cluster.ts:57

descriptions field

Overrides

IBaseProduct.descriptions

---

favoriteLists?

optional favoriteLists?: FavoriteListsResponse

Defined in: type/Cluster.ts:39

favoriteLists field

---

hidden

hidden: YesNo

Defined in: type/Cluster.ts:77

The hidden status of this resource.

Overrides

IBaseProduct.hidden

---

id

id: number

Defined in: type/Cluster.ts:21

Resource primary identifier

Overrides

IBaseProduct.id

---

lastModifiedAt

lastModifiedAt: string

Defined in: type/Cluster.ts:47

The last modified date of this product

Overrides

IBaseProduct.lastModifiedAt

---

metadataCanonicalUrls?

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/Cluster.ts:71

[SEO] Localized Metadata canonical url available in multiple languages

Overrides

IBaseProduct.metadataCanonicalUrls

---

metadataDescriptions?

optional metadataDescriptions?: LocalizedString[]

Defined in: type/Cluster.ts:67

[SEO] Localized Metadata description available in multiple languages

Overrides

IBaseProduct.metadataDescriptions

---

metadataKeywords?

optional metadataKeywords?: LocalizedString[]

Defined in: type/Cluster.ts:69

[SEO] Localized Metadata keywords available in multiple languages

Overrides

IBaseProduct.metadataKeywords

---

metadataTitles?

optional metadataTitles?: LocalizedString[]

Defined in: type/Cluster.ts:65

[SEO] Localized Metadata title available in multiple languages

Overrides

IBaseProduct.metadataTitles

---

names

names: LocalizedString[]

Defined in: type/Cluster.ts:55

names field

Overrides

IBaseProduct.names

---

options

options: ClusterOption[]

Defined in: type/Cluster.ts:49

options field

---

orderlists

orderlists: OrderlistsResponse

Defined in: type/Cluster.ts:41

orderlists field

---

priority?

optional priority?: number

Defined in: type/Cluster.ts:63

priority field

Overrides

IBaseProduct.priority

---

products

products: Product[]

Defined in: type/Cluster.ts:43

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

---

shortDescriptions

shortDescriptions: LocalizedString[]

Defined in: type/Cluster.ts:59

shortDescriptions field

Overrides

IBaseProduct.shortDescriptions

---

shortNames

shortNames: LocalizedString[]

Defined in: type/Cluster.ts:73

Short names for this cluster per language

---

sku

sku: string

Defined in: type/IBaseProduct.ts:22

The SKU (stock keeping unit) of this product

Inherited from

IBaseProduct.sku

---

slugs

slugs: LocalizedString[]

Defined in: type/Cluster.ts:61

slugs field

Overrides

IBaseProduct.slugs

---

sources

sources: Source[]

Defined in: type/Cluster.ts:75

sources field

Overrides

IBaseProduct.sources

---

type

type: ProductClass

Defined in: type/Cluster.ts:82

Discriminator that distinguishes between a product and a cluster within the shared catalogue.

Overrides

IBaseProduct.type

---

uuid

uuid: string

Defined in: type/Cluster.ts:80

Globally unique identifier for the product or cluster.

Overrides

IBaseProduct.uuid