Typescript SDK Type Docs
    Preparing search index...

    Interface SetPricesChange

    Change triggered by the Set Prices update action.

    interface SetPricesChange {
        addedItems: Price[];
        catalogData: string;
        change: string;
        nextValue: Price[];
        previousValue: Price[];
        removedItems: Price[];
        type: "SetPricesChange";
        variant: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addedItems catalogData change nextValue previousValue removedItems type variant

    Properties

    addedItems: Price[]

    Elements added to the array.

    catalogData: string

    Product data that was updated.

    - `staged`, if the staged [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
- `current`, if the current [ProductCatalogData](ctp:api:type:ProductCatalogData) was updated.
    change: string

    Change type on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

    [Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.
    nextValue: Price[]

    Value after the change.

    previousValue: Price[]

    Value before the change.

    removedItems: Price[]

    Elements removed from the array.

    type: "SetPricesChange"

    Unique discriminator value to reliably deserialize the data type.

    variant: string

    Identifier of the updated Product Variant.

    This field holds the SKU, if defined; otherwise the key; otherwise the ID.

    Settings

    Member Visibility

    On This Page

    Properties