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

    Interface ProductData

    Contains all the data of a Product and its Product Variants.

    interface ProductData {
        attributes: Attribute[];
        categories: CategoryReference[];
        categoryOrderHints?: CategoryOrderHints;
        description?: LocalizedString;
        masterVariant: ProductVariant;
        metaDescription?: LocalizedString;
        metaKeywords?: LocalizedString;
        metaTitle?: LocalizedString;
        name: LocalizedString;
        searchKeywords: SearchKeywords;
        slug: LocalizedString;
        variants: ProductVariant[];
    }
    Index

    Properties

    attributes categories categoryOrderHints? description? masterVariant metaDescription? metaKeywords? metaTitle? name searchKeywords slug variants

    Properties

    attributes: Attribute[]

    Attributes according to the respective AttributeDefinition.

    categories: CategoryReference[]

    Categories assigned to the Product.

    categoryOrderHints?: CategoryOrderHints

    Numerical values to allow ordering of Products within a specified Category.

    description?: LocalizedString

    Description of the Product.

    masterVariant: ProductVariant

    The Master Variant of the Product.

    metaDescription?: LocalizedString

    Description of the Product as used by search engines.

    metaKeywords?: LocalizedString

    Keywords that give additional information about the Product to search engines.

    metaTitle?: LocalizedString

    Title of the Product as used by search engines.

    name: LocalizedString

    Name of the Product.

    searchKeywords: SearchKeywords

    Used by Search Term Suggestions, but is also considered for a full text search in the Product Projection Search API.

    slug: LocalizedString

    User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

    variants: ProductVariant[]

    Additional Product Variants.

    Settings

    Member Visibility

    On This Page

    Properties