Interface OrderTransitionStateAction

If the existing State has set transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed.

This update action produces the [Order State Transition](ctp:api:type:OrderStateTransitionMessage) Message.
interface OrderTransitionStateAction {
    action: "transitionState";
    force?: boolean;
    state: StateResourceIdentifier;
}

Properties

action force? state

Properties

Readonly action

action: "transitionState"

Optional Readonly force

force?: boolean

Set to true to turn off validation.

Readonly state

state: StateResourceIdentifier

Value to set. If there is no State yet, the new State must be an initial State.

Settings

Member Visibility

Theme

On This Page

actionforcestate