@gradientedge/commercetools-utils
    Preparing search index...

    Interface Category

    interface Category {
        ancestors: CategoryReference[];
        assets?: Asset[];
        createdAt: string;
        createdBy?: CreatedBy;
        custom?: CustomFields;
        description?: LocalizedString;
        externalId?: string;
        id: string;
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        metaDescription?: LocalizedString;
        metaKeywords?: LocalizedString;
        metaTitle?: LocalizedString;
        name: LocalizedString;
        orderHint: string;
        parent?: CategoryReference;
        slug: LocalizedString;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ancestors assets? createdAt createdBy? custom? description? externalId? id key? lastModifiedAt lastModifiedBy? metaDescription? metaKeywords? metaTitle? name orderHint parent? slug version

    Properties

    ancestors: CategoryReference[]

    Contains the parent path towards the root Category.

    assets?: Asset[]

    Media related to the Category.

    createdAt: string

    Date and time (UTC) the Category was initially created.

    createdBy?: CreatedBy

    IDs and references that created the Category.

    custom?: CustomFields

    Custom Fields for the Category.

    description?: LocalizedString

    Description of the Category.

    externalId?: string

    Additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).

    id: string

    Unique identifier of the Category.

    key?: string

    User-defined unique identifier of the Category.

    lastModifiedAt: string

    Date and time (UTC) the Category was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Category.

    metaDescription?: LocalizedString

    Description of the Category used by external search engines for improved search engine performance.

    metaKeywords?: LocalizedString

    Keywords related to the Category for improved search engine performance.

    metaTitle?: LocalizedString

    Name of the Category used by external search engines for improved search engine performance.

    name: LocalizedString

    Name of the Category.

    orderHint: string

    Decimal value between 0 and 1. Frontend applications can use this value for ordering Categories within the same level in the category tree.

    parent?: CategoryReference

    Parent Category of this Category.

    slug: LocalizedString

    User-defined identifier used as a deep-link URL to the related Category per Locale. A Category can have the same slug for different Locales, but they are unique across the Project. Valid slugs match the pattern ^[A-Za-z0-9_-]{2,256}+$. For good performance, indexes are provided for the first 15 languages set in a Project.

    version: number

    Current version of the Category.

    Settings

    Member Visibility

    On This Page

    Properties