Typescript SDK Type Docs
    Preparing search index...

    Interface TransitionLineItemStateChange

    Change triggered by the following update actions:

    - [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Orders.
- [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Staged Orders.
    interface TransitionLineItemStateChange {
        change: string;
        lineItemId: string;
        nextValue: ItemState[];
        previousValue: ItemState[];
        stateId: string;
        type: "TransitionLineItemStateChange";
    }

    Hierarchy (View Summary)

    • IChange
      • TransitionLineItemStateChange
    Index

    Properties

    change lineItemId nextValue previousValue stateId 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.
    lineItemId: string

    id of the updated LineItem.

    nextValue: ItemState[]

    Value after the change.

    previousValue: ItemState[]

    Value before the change.

    stateId: string

    id of the State involved in the transition.

    type: "TransitionLineItemStateChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties