Typescript SDK Type Docs
    Preparing search index...

    Interface ChangeOrderStateChange

    Change triggered by the following update actions:

    - [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) on Orders.
- [Change OrderState](ctp:api:type:StagedOrderChangeOrderStateAction) on Staged Orders.
    interface ChangeOrderStateChange {
        change: string;
        nextValue: OrderState;
        previousValue: OrderState;
        type: "ChangeOrderStateChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change nextValue previousValue type

    Properties

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

    Value after the change.

    previousValue: OrderState

    Value before the change.

    type: "ChangeOrderStateChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties