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

    Interface ProductData

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

    Product Attributes according to the respective AttributeDefinition. Not supported by Product Projection Search.

    categories: CategoryReference[]

    Categories assigned to the Product.

    categoryOrderHints?: CategoryOrderHints

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

    defaultVariant?: VariantReference

    Reference to the default Variant of the Product. Only available for Projects with productCatalogModel set to Modular. The reference is automatically cleared when the referenced Variant is deleted; in that case, the response of the Delete Variant request includes a DefaultVariantDeleted warning.

    description?: LocalizedString

    Description of the Product.

    masterVariant: ProductVariant

    The Master Variant of the Product.

    Omitted when the Project has the [ProductCatalogModel](ctp:api:type:ProductCatalogModel) `Modular`. Use the [Variants API](/projects/variants) instead.
    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.

    Empty when the Project has the [ProductCatalogModel](ctp:api:type:ProductCatalogModel) `Modular`. Use the [Variants API](/projects/variants) instead.

    Settings
    Member Visibility

    On This Page
    Properties