Typescript SDK Type Docs
    Preparing search index...

    Interface SetVariantAvailabilityChange

    This change is initiated by background processes after the Add Quantity, Remove Quantity, or Change Quantity update action is performed.

    interface SetVariantAvailabilityChange {
        catalogData: string;
        change: string;
        nextValue: ProductVariantAvailability;
        previousValue: ProductVariantAvailability;
        type: "SetVariantAvailabilityChange";
        variant: string;
    }

    Hierarchy (View Summary)

    • IChange
      • SetVariantAvailabilityChange
    Index

    Properties

    catalogData change nextValue previousValue 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: ProductVariantAvailability

    Value after the change.

    previousValue: ProductVariantAvailability

    Value before the change.

    type: "SetVariantAvailabilityChange"

    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