Typescript SDK Type Docs
    Preparing search index...

    Interface Product

    interface Product {
        createdAt: string;
        createdBy?: CreatedBy;
        id: string;
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        masterData: ProductCatalogData;
        priceMode?: ProductPriceModeEnum;
        productType: ProductTypeReference;
        reviewRatingStatistics?: ReviewRatingStatistics;
        state?: StateReference;
        taxCategory?: TaxCategoryReference;
        version: number;
        warnings?: ImageProcessingOngoingWarning[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt createdBy? id key? lastModifiedAt lastModifiedBy? masterData priceMode? productType reviewRatingStatistics? state? taxCategory? version warnings?

    Properties

    createdAt: string

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

    createdBy?: CreatedBy

    IDs and references that created the Product.

    id: string

    Unique identifier of the Product.

    key?: string

    User-defined unique identifier of the Product.

    This is different from the `key` of a [ProductVariant](ctp:api:type:ProductVariant).
    lastModifiedAt: string

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

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Product.

    masterData: ProductCatalogData

    Contains the current and the staged representation of the product information.

    priceMode?: ProductPriceModeEnum

    Type of Price to be used when looking up a price for the Product.

    productType: ProductTypeReference

    The Product Type defining the Attributes of the Product. Cannot be changed.

    reviewRatingStatistics?: ReviewRatingStatistics

    Review statistics of the Product.

    state?: StateReference

    State of the Product.

    taxCategory?: TaxCategoryReference

    The TaxCategory of the Product.

    version: number

    Current version of the Product.

    warnings?: ImageProcessingOngoingWarning[]

    Warnings about processing of a request. Appears in response to requests with response status code 202 Accepted.

    Settings

    Member Visibility

    On This Page

    Properties