Interface: Cluster

Defined in: type/Cluster.ts:18

Object class for Cluster

Extends

• IBaseProduct

Properties

attributes?

optional attributes?: AttributeResultResponse

Defined in: type/Cluster.ts:26

Lists attributes for this cluster based on the search input.

---

categories?

optional categories?: CategoryResponse

Defined in: type/Cluster.ts:28

All the categories the cluster belongs to

---

category

category: Category

Defined in: type/Cluster.ts:30

category field

---

categoryId

categoryId: number

Defined in: type/Cluster.ts:24

categoryId field

Overrides

IBaseProduct.categoryId

---

categoryPath

categoryPath: Category[]

Defined in: type/Cluster.ts:32

categoryPath field

---

class

class: ProductClass

Defined in: type/Cluster.ts:84

The class of the request resource

Overrides

IBaseProduct.class

---

clusterId

clusterId: number

Defined in: type/Cluster.ts:22

The classID of this cluster

---

config?

optional config?: ClusterConfig

Defined in: type/Cluster.ts:52

config field

---

createdAt

createdAt: string

Defined in: type/Cluster.ts:44

The creation date of this product

---

crossupsellsFrom

crossupsellsFrom: CrossupsellsResponse

Defined in: type/Cluster.ts:34

crossupsellsFrom field

---

crossupsellsTo

crossupsellsTo: CrossupsellsResponse

Defined in: type/Cluster.ts:36

crossupsellsTo field

---

defaultLanguage

defaultLanguage: string

Defined in: type/Cluster.ts:64

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.

Overrides

IBaseProduct.defaultLanguage

---

defaultProduct?

optional defaultProduct?: Product

Defined in: type/Cluster.ts:50

defaultProduct field

---

descriptions

descriptions: LocalizedString[]

Defined in: type/Cluster.ts:56

descriptions field

Overrides

IBaseProduct.descriptions

---

favoriteLists?

optional favoriteLists?: FavoriteListsResponse

Defined in: type/Cluster.ts:38

favoriteLists field

---

hidden

hidden: YesNo

Defined in: type/Cluster.ts:86

The hidden status of this resource.

Overrides

IBaseProduct.hidden

---

id

id: number

Defined in: type/Cluster.ts:20

Resource primary identifier

Overrides

IBaseProduct.id

---

language?

optional language?: string

Defined in: type/Cluster.ts:82

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

Overrides

IBaseProduct.language

---

lastModifiedAt

lastModifiedAt: string

Defined in: type/Cluster.ts:46

The last modified date of this product

---

metadataCanonicalUrls?

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/Cluster.ts:74

[SEO] Localized Metadata canonical url available in multiple languages

Overrides

IBaseProduct.metadataCanonicalUrls

---

metadataDescriptions?

optional metadataDescriptions?: LocalizedString[]

Defined in: type/Cluster.ts:70

[SEO] Localized Metadata description available in multiple languages

Overrides

IBaseProduct.metadataDescriptions

---

metadataKeywords?

optional metadataKeywords?: LocalizedString[]

Defined in: type/Cluster.ts:72

[SEO] Localized Metadata keywords available in multiple languages

Overrides

IBaseProduct.metadataKeywords

---

metadataTitles?

optional metadataTitles?: LocalizedString[]

Defined in: type/Cluster.ts:68

[SEO] Localized Metadata title available in multiple languages

Overrides

IBaseProduct.metadataTitles

---

names

names: LocalizedString[]

Defined in: type/Cluster.ts:54

names field

Overrides

IBaseProduct.names

---

options

options: ClusterOption[]

Defined in: type/Cluster.ts:48

options field

---

orderlists

orderlists: OrderlistsResponse

Defined in: type/Cluster.ts:40

orderlists field

---

priority?

optional priority?: number

Defined in: type/Cluster.ts:66

priority field

Overrides

IBaseProduct.priority

---

products

products: Product[]

Defined in: type/Cluster.ts:42

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:58

shortDescriptions field

Overrides

IBaseProduct.shortDescriptions

---

shortNames

shortNames: LocalizedString[]

Defined in: type/Cluster.ts:76

Short names for this cluster per language

---

sku

sku: string

Defined in: type/Cluster.ts:62

The SKU (stock keeping unit) of this product

Overrides

IBaseProduct.sku

---

slugs

slugs: LocalizedString[]

Defined in: type/Cluster.ts:60

slugs field

Overrides

IBaseProduct.slugs

---

sources

sources: Source[]

Defined in: type/Cluster.ts:78

sources field

Overrides

IBaseProduct.sources