Skip to main content

Interface: IBaseProduct

Defined in: type/IBaseProduct.ts:8

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

Extended by​

Properties​

categoryId​

categoryId: number

Defined in: type/IBaseProduct.ts:24

categoryId field

categoryIds​

categoryIds: number[]

Defined in: type/IBaseProduct.ts:45

All category IDs this base product belongs to

createdAt​

createdAt: string

Defined in: type/IBaseProduct.ts:47

Timestamp marking when the record was created, in UTC ISO 8601 format.

defaultLanguage​

defaultLanguage: string

Defined in: type/IBaseProduct.ts:26

The default language for this product or cluster

descriptions​

descriptions: LocalizedString[]

Defined in: type/IBaseProduct.ts:16

The descriptions of this product per language

hidden​

hidden: YesNo

Defined in: type/IBaseProduct.ts:12

The hidden status of this resource.

id​

id: number

Defined in: type/IBaseProduct.ts:10

Resource primary identifier

lastModifiedAt​

lastModifiedAt: string

Defined in: type/IBaseProduct.ts:49

Timestamp marking the last modification of the record, in UTC ISO 8601 format.

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/IBaseProduct.ts:36

[SEO] Localized Metadata canonical url available in multiple languages

metadataDescriptions?​

optional metadataDescriptions?: LocalizedString[]

Defined in: type/IBaseProduct.ts:32

[SEO] Localized Metadata description available in multiple languages

metadataKeywords?​

optional metadataKeywords?: LocalizedString[]

Defined in: type/IBaseProduct.ts:34

[SEO] Localized Metadata keywords available in multiple languages

metadataTitles?​

optional metadataTitles?: LocalizedString[]

Defined in: type/IBaseProduct.ts:30

[SEO] Localized Metadata title available in multiple languages

names​

names: LocalizedString[]

Defined in: type/IBaseProduct.ts:14

The names of this product per language

priority?​

optional priority?: number

Defined in: type/IBaseProduct.ts:28

priority field

shortDescriptions​

shortDescriptions: LocalizedString[]

Defined in: type/IBaseProduct.ts:18

The short descriptions of this product per language

sku​

sku: string

Defined in: type/IBaseProduct.ts:22

The SKU (stock keeping unit) of this product

slugs​

slugs: LocalizedString[]

Defined in: type/IBaseProduct.ts:20

The slugs for this product per language

sources​

sources: Source[]

Defined in: type/IBaseProduct.ts:38

sources field

type​

type: ProductClass

Defined in: type/IBaseProduct.ts:43

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

uuid​

uuid: string

Defined in: type/IBaseProduct.ts:41

Globally unique identifier for the product or cluster.