Interface LineItemStateTransitionMessagePayload

Generated after a successful Transition LineItem State update action.

interface LineItemStateTransitionMessagePayload {
    fromState: StateReference;
    lineItemId: string;
    lineItemKey?: string;
    quantity: number;
    toState: StateReference;
    transitionDate: string;
    type: "LineItemStateTransition";
}

Hierarchy (View Summary)

IOrderMessagePayload
- LineItemStateTransitionMessagePayload

Index

Properties

fromState lineItemId lineItemKey? quantity toState transitionDate type

Properties

`Readonly`fromState

fromState: StateReference

State the Line Item was transitioned from.

`Readonly`lineItemId

lineItemId: string

Unique identifier of the Line Item.

`Optional` `Readonly`lineItemKey

lineItemKey?: string

User-defined identifier of the LineItem. Unique among LineItems in the Order.

`Readonly`quantity

quantity: number

Number of Line Items for which the State was transitioned.

`Readonly`toState

toState: StateReference

State the Line Item was transitioned to.

`Readonly`transitionDate

transitionDate: string

Date and time (UTC) the transition of the Line Item State was performed.

`Readonly`type

type: "LineItemStateTransition"