Typescript SDK Type Docs
    Preparing search index...

    Interface SetPriceKeyChange

    Change triggered by the Set Price Key update action.

    interface SetPriceKeyChange {
        catalogData: string;
        change: string;
        nextValue: string;
        previousValue: string;
        priceId: string;
        type: "SetPriceKeyChange";
        variant: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    catalogData change nextValue previousValue priceId type variant

    Properties

    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: string

    Value after the change.

    previousValue: string

    Value before the change.

    priceId: string

    id of the Embedded Price.

    type: "SetPriceKeyChange"

    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