Interface OrderTransitionCustomLineItemStateAction

Produces the Custom Line Item State Transition Message.

interface OrderTransitionCustomLineItemStateAction {
    action: "transitionCustomLineItemState";
    actualTransitionDate?: string;
    customLineItemId?: string;
    customLineItemKey?: string;
    fromState: StateResourceIdentifier;
    quantity: number;
    toState: StateResourceIdentifier;
}

Properties

action actualTransitionDate? customLineItemId? customLineItemKey? fromState quantity toState

Properties

Readonly action

action: "transitionCustomLineItemState"

Optional Readonly actualTransitionDate

actualTransitionDate?: string

Date and time (UTC) to perform the State transition.

Optional Readonly customLineItemId

customLineItemId?: string

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Optional Readonly customLineItemKey

customLineItemKey?: string

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Readonly fromState

fromState: StateResourceIdentifier

State the Custom Line Item should transition from.

Readonly quantity

quantity: number

Number of Custom Line Items that should transition State.

Readonly toState

toState: StateResourceIdentifier

State the Custom Line Item should transition to.

Settings

Member Visibility

Theme

On This Page

actionactualTransitionDatecustomLineItemIdcustomLineItemKeyfromStatequantitytoState