Interface CustomLineItemStateTransitionMessagePayload

Generated after a successful Transition CustomLineItem State update action.

interface CustomLineItemStateTransitionMessagePayload {
    customLineItemId: string;
    customLineItemKey?: string;
    fromState: StateReference;
    quantity: number;
    toState: StateReference;
    transitionDate: string;
    type: "CustomLineItemStateTransition";
}

Hierarchy (View Summary)

IOrderMessagePayload
- CustomLineItemStateTransitionMessagePayload

Index

Properties

customLineItemId customLineItemKey? fromState quantity toState transitionDate type

Properties

`Readonly`customLineItemId

customLineItemId: string

Unique identifier of the Custom Line Item.

`Optional` `Readonly`customLineItemKey

customLineItemKey?: string

User-defined unique identifier of the Custom Line Item.

`Readonly`fromState

fromState: StateReference

State the Custom Line Item was transitioned from.

`Readonly`quantity

quantity: number

Number of Custom Line Items for which the State was transitioned.

`Readonly`toState

toState: StateReference

State the Custom Line Item was transitioned to.

`Readonly`transitionDate

transitionDate: string

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

`Readonly`type

type: "CustomLineItemStateTransition"