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

    Interface ProductProjection

    interface ProductProjection {
        attributes: Attribute[];
        categories: CategoryReference[];
        categoryOrderHints?: CategoryOrderHints;
        createdAt: string;
        description?: LocalizedString;
        hasStagedChanges?: boolean;
        id: string;
        key?: string;
        lastModifiedAt: string;
        masterVariant: ProductVariant;
        metaDescription?: LocalizedString;
        metaKeywords?: LocalizedString;
        metaTitle?: LocalizedString;
        name: LocalizedString;
        priceMode?: ProductPriceModeEnum;
        productType: ProductTypeReference;
        published?: boolean;
        reviewRatingStatistics?: ReviewRatingStatistics;
        searchKeywords?: SearchKeywords;
        slug: LocalizedString;
        state?: StateReference;
        taxCategory?: TaxCategoryReference;
        variants: ProductVariant[];
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes categories categoryOrderHints? createdAt description? hasStagedChanges? id key? lastModifiedAt masterVariant metaDescription? metaKeywords? metaTitle? name priceMode? productType published? reviewRatingStatistics? searchKeywords? slug state? taxCategory? variants version

    Properties

    attributes: Attribute[]

    Attributes according to the respective AttributeDefinition.

    categories: CategoryReference[]

    Categories assigned to the Product.

    categoryOrderHints?: CategoryOrderHints

    Order of Product in Categories.

    createdAt: string

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

    description?: LocalizedString

    Description of the Product.

    hasStagedChanges?: boolean

    true if the staged data is different from the current data.

    id: string

    Unique identifier of the Product.

    key?: string

    User-defined unique identifier of the Product.

    lastModifiedAt: string

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

    masterVariant: ProductVariant

    The Master Variant of the Product.

    metaDescription?: LocalizedString

    Description of the Product displayed in search results below the meta title.

    metaKeywords?: LocalizedString

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

    metaTitle?: LocalizedString

    Title of the Product displayed in search results.

    name: LocalizedString

    Name of the Product.

    priceMode?: ProductPriceModeEnum

    Indicates whether the Prices of the Product Projection are embedded or standalone. Projecting Prices only works with Embedded, there is currently no support for Standalone.

    productType: ProductTypeReference

    The ProductType defining the Attributes of the Product.

    published?: boolean

    true if the Product is published.

    reviewRatingStatistics?: ReviewRatingStatistics

    Review statistics 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}. For good performance, indexes are provided for the first 15 languages set in the Project.

    state?: StateReference

    State of the Product.

    taxCategory?: TaxCategoryReference

    The TaxCategory of the Product.

    variants: ProductVariant[]

    Additional Product Variants.

    version: number

    Current version of the Product.

    Settings

    Member Visibility

    On This Page

    Properties