Interface ProductPriceChangedMessagePayload

Generated after a successful Change Price update action.

interface ProductPriceChangedMessagePayload {
    newPrice: Price;
    oldPrice: Price;
    oldStagedPrice?: Price;
    staged: boolean;
    type: "ProductPriceChanged";
    variantId: number;
}

Properties

newPrice oldPrice oldStagedPrice? staged type variantId

Properties

Readonly newPrice

newPrice: Price

The Embedded Price after the Change Embedded Price update action.

Readonly oldPrice

oldPrice: Price

The current Embedded Price before the Change Embedded Price update action.

Optional Readonly oldStagedPrice

oldStagedPrice?: Price

The staged Embedded Price before the Change Embedded Price update action.

Readonly staged

staged: boolean

Whether the update was only applied to the staged Product Projection.

Readonly type

type: "ProductPriceChanged"

Readonly variantId

variantId: number

Unique identifier of the ProductVariant for which the Price was changed.

Settings

Member Visibility

Theme

On This Page

newPriceoldPriceoldStagedPricestagedtypevariantId