Interface LineItemStateTransitionMessagePayload

Generated after a successful Transition Line Item State update action.

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

Index

Properties

fromState lineItemId 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.

`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) when the transition of the Line Item State was performed.

`Readonly` type

type: "LineItemStateTransition"

Generated using TypeDoc