Skip to main content

Interface: Category

Defined in: type/Category.ts:10

Object class for Category

Properties​

attributes?​

optional attributes?: AttributeResultResponse

Defined in: type/Category.ts:14

Lists attributes for this category based on the search input.

baseProducts​

baseProducts: BaseProductsResponse

Defined in: type/Category.ts:59

Products and clusters attached to the category, returned through a single page of results.

categories?​

optional categories?: Category[]

Defined in: type/Category.ts:16

categories field

categoryId​

categoryId: number

Defined in: type/Category.ts:12

categoryId field

categoryPath​

categoryPath: Category[]

Defined in: type/Category.ts:32

categoryPath field

createdAt​

createdAt: string

Defined in: type/Category.ts:55

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

defaultLanguage​

defaultLanguage: string

Defined in: type/Category.ts:20

defaultLanguage field

descriptions​

descriptions: LocalizedString[]

Defined in: type/Category.ts:49

Localized long-form descriptions shown on category landing surfaces.

hidden​

hidden: YesNo

Defined in: type/Category.ts:30

The hidden status of the category

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Category.ts:57

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

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/Category.ts:28

[SEO] Localized Metadata canonical url available in multiple languages

metadataDescriptions?​

optional metadataDescriptions?: LocalizedString[]

Defined in: type/Category.ts:24

[SEO] Localized Metadata description available in multiple languages

metadataKeywords?​

optional metadataKeywords?: LocalizedString[]

Defined in: type/Category.ts:26

[SEO] Localized Metadata keywords available in multiple languages

metadataTitles?​

optional metadataTitles?: LocalizedString[]

Defined in: type/Category.ts:22

[SEO] Localized Metadata title available in multiple languages

names​

names: LocalizedString[]

Defined in: type/Category.ts:47

Localized names shown to end users in catalog and navigation surfaces. The catalogue's default language must be present.

parent?​

optional parent?: Category

Defined in: type/Category.ts:18

The category's parent Category when available

parentUuid?​

optional parentUuid?: string

Defined in: type/Category.ts:43

Globally unique identifier of the parent category. Omitted for root categories.

products​

products: ProductsResponse

Defined in: type/Category.ts:36

products field

rootCategoryId​

rootCategoryId: number

Defined in: type/Category.ts:41

The ID of the root category this category belongs to

shortDescriptions​

shortDescriptions: LocalizedString[]

Defined in: type/Category.ts:51

Localized short descriptions surfaced in listings and tiles.

slugs​

slugs: LocalizedString[]

Defined in: type/Category.ts:53

URL-friendly identifiers, one per language, used in human-readable links.

sortOrder?​

optional sortOrder?: number

Defined in: type/Category.ts:45

Sort order within the parent category

sources​

sources: Source[]

Defined in: type/Category.ts:34

sources field

uuid​

uuid: string

Defined in: type/Category.ts:39

Globally unique identifier for the category.