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

    Interface ProductVariant

    Represents a Product Variant embedded in a Product.

    Only available for Projects with the [ProductCatalogModel](ctp:api:type:ProductCatalogModel) `Classic`.
When the Project has the `Modular` catalog model, use the [Variants API](/projects/variants) instead.
    interface ProductVariant {
        assets?: Asset[];
        attributes?: Attribute[];
        availability?: ProductVariantAvailability;
        id: number;
        images?: Image[];
        isMatchingVariant?: boolean;
        key?: string;
        price?: Price;
        prices?: Price[];
        recurrencePrices?: Price[];
        scopedPrice?: ScopedPrice;
        scopedPriceDiscounted?: boolean;
        sku?: string;
    }
    Index
    assets? attributes? availability? id images? isMatchingVariant? key? price? prices? recurrencePrices? scopedPrice? scopedPriceDiscounted? sku?
    assets?: Asset[]

    Media assets of the Product Variant.

    attributes?: Attribute[]

    Variant Attributes according to the respective AttributeDefinition.

    availability?: ProductVariantAvailability

    Set if the Product Variant is tracked by Inventory. Can be used as an optimization to reduce calls to the Inventory service. May not contain the latest Inventory State (it is eventually consistent).

    id: number

    A unique, sequential identifier of the Product Variant within the Product.

    images?: Image[]

    Images of the Product Variant.

    isMatchingVariant?: boolean

    Whether the Product Variant matches the search query. Only available in response to a Product Projection Search request.

    key?: string

    User-defined identifier of the ProductVariant. Unique among ProductVariants in the same Product.

    This is different from [Product](ctp:api:type:Product) `key`.
    price?: Price

    Only present when price selection is applied. Cannot be used in a Query Predicate.

    prices?: Price[]

    If the Product is projected by Store, this field only contains Embedded Prices that are valid for that Store.

    Cannot contain two Embedded Prices with the same scopes (currency, country, Customer Group, Channel, `validFrom` and `validUntil`).
    recurrencePrices?: Price[]

    Only available when Product price selection is used. Cannot be used in a Query Predicate.

    scopedPrice?: ScopedPrice

    Only available in response to a Product Projection Search request with Product price selection. Can be used to sort, filter, and facet.

    scopedPriceDiscounted?: boolean

    Only available in response to a Product Projection Search request with Product price selection.

    sku?: string

    User-defined SKU of the Product Variant. Unique across all ProductVariants in a Project.

    Settings
    Member Visibility

    On This Page
    Properties