Skip to main content

Interface: Category

Defined in: type/Category.ts:9

Object class for Category

Properties​

attributes?​

optional attributes?: AttributeResultResponse

Defined in: type/Category.ts:13

Lists attributes for this category based on the search input.

categories?​

optional categories?: Category[]

Defined in: type/Category.ts:32

categories field

categoryId​

categoryId: number

Defined in: type/Category.ts:11

categoryId field

categoryPath​

categoryPath: Category[]

Defined in: type/Category.ts:48

categoryPath field

defaultLanguage​

defaultLanguage: string

Defined in: type/Category.ts:36

defaultLanguage field

description​

description: LocalizedString[]

Defined in: type/Category.ts:20

The long description for this category, this field can contain html formatting, this field can be translated is case of multilingual catalog

hidden​

hidden: YesNo

Defined in: type/Category.ts:46

The hidden status of the category

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/Category.ts:44

[SEO] Localized Metadata canonical url available in multiple languages

metadataDescriptions?​

optional metadataDescriptions?: LocalizedString[]

Defined in: type/Category.ts:40

[SEO] Localized Metadata description available in multiple languages

metadataKeywords?​

optional metadataKeywords?: LocalizedString[]

Defined in: type/Category.ts:42

[SEO] Localized Metadata keywords available in multiple languages

metadataTitles?​

optional metadataTitles?: LocalizedString[]

Defined in: type/Category.ts:38

[SEO] Localized Metadata title available in multiple languages

name​

name: LocalizedString[]

Defined in: type/Category.ts:16

Localized category name as it is available in the supported language defaults to the category's default language.

parent?​

optional parent?: Category

Defined in: type/Category.ts:34

The category's parent Category when available

path​

path: string

Defined in: type/Category.ts:30

The path in id's to the root of the inheritance tree, can be passed as parameter to the productsearch API

products​

products: ProductsResponse

Defined in: type/Category.ts:52

products field

shortDescription​

shortDescription: LocalizedString[]

Defined in: type/Category.ts:24

The short description for this category, this field can contain html formatting, this field can be translated is case of multilingual catalog

slug​

slug: LocalizedString[]

Defined in: type/Category.ts:27

The slug for this category, each available language contains a different slug

sources​

sources: Source[]

Defined in: type/Category.ts:50

sources field