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

    Interface VariantProjection

    A lightweight, read-only projection of a single Variant with embedded Product data. Variant Projections are automatically created and updated when Variants or their parent Products change.

    interface VariantProjection {
        assets: Asset[];
        attributes: Attribute[];
        categories: CategoryReference[];
        categoryOrderHints?: CategoryOrderHints;
        createdAt: string;
        default: boolean;
        description?: LocalizedString;
        id: string;
        images: Image[];
        key?: string;
        name: LocalizedString;
        price?: Price;
        product: ProductReference;
        sku?: string;
        slug: LocalizedString;
        staged: boolean;
        variantId: number;
        version: number;
    }
    Index
    assets attributes categories categoryOrderHints? createdAt default description? id images key? name price? product sku? slug staged variantId version
    assets: Asset[]

    Assets of the Variant.

    attributes: Attribute[]

    Attributes of the Variant, including product-level Attributes merged at projection time.

    categories: CategoryReference[]

    Categories assigned to the parent Product.

    categoryOrderHints?: CategoryOrderHints

    Order of the parent Product in Categories.

    createdAt: string

    Date and time (UTC) the Variant Projection was initially created.

    default: boolean

    Whether this Variant is the default Variant of its Product (see Product.defaultVariant).

    description?: LocalizedString

    Description of the parent Product.

    id: string

    Unique identifier of the Variant within its parent Product.

    images: Image[]

    Images of the Variant.

    key?: string

    User-defined unique identifier of the Variant.

    name: LocalizedString

    Name of the parent Product.

    price?: Price

    The selected price based on the price selection query parameters. Only present when price selection parameters are provided.

    product: ProductReference

    Reference to the parent Product.

    sku?: string

    SKU of the Variant.

    slug: LocalizedString

    Slug of the parent Product.

    staged: boolean

    true for the staged (draft) projection, false for the current (published) projection.

    variantId: number

    The id of the Variant.

    version: number

    Current version of the Variant Projection.

    Settings
    Member Visibility

    On This Page
    Properties