An OrderProcess is used to define the way the order process works as in: what states an Order can be
in, and how it may transition from one state to another. Using the onTransitionStart() hook, an
OrderProcess can perform checks before allowing a state transition to occur, and the onTransitionEnd()
hook allows logic to be executed after a state change.
For detailed description of the interface members, see the StateMachineConfig docs.
This is configured via the orderOptions.process property of
your VendureConfig.
InjectableStrategyTransitions<State, State | OrderState> & Partial<Transitions<OrderState | State>>OnTransitionStartFn<State | OrderState, OrderTransitionData>OnTransitionEndFn<State | OrderState, OrderTransitionData>OnTransitionErrorFn<State | OrderState>Options which can be passed to the configureDefaultOrderProcess function
to configure an instance of the default OrderProcess. By default, all
options are set to true.
booleantruePrevents an Order from transitioning out of the Modifying state if
the Order price has changed and there is no Payment or Refund associated
with the Modification.
booleantruePrevents an Order from transitioning out of the ArrangingAdditionalPayment state if
the Order's Payments do not cover the full amount of totalWithTax.
booleantruePrevents the transition from AddingItems to any other state (apart from Cancelled) if
and of the ProductVariants no longer exists due to deletion.
booleantruePrevents transition to the ArrangingPayment state if the active Order has no lines.
booleantruePrevents transition to the ArrangingPayment state if the active Order has no customer
associated with it.
booleantruePrevents transition to the ArrangingPayment state if the active Order has no shipping
method set.
booleantruePrevents transition to the ArrangingPayment state if there is insufficient saleable
stock to cover the contents of the Order.
booleantruePrevents transition to the PaymentAuthorized or PaymentSettled states if the order
totalWithTax amount is not covered by Payment(s) in the corresponding states.
booleantruePrevents transition to the Cancelled state unless all OrderItems are already
cancelled.
booleantruePrevents transition to the Shipped, PartiallyShipped, Delivered & PartiallyDelivered states unless
there are corresponding Fulfillments in the correct states to allow this. E.g. Shipped only if all items in
the Order are part of a Fulfillment which itself is in the Shipped state.
Used to configure a customized instance of the default OrderProcess that ships with Vendure. Using this function allows you to turn off certain checks and constraints that are enabled by default.
The DefaultOrderProcessOptions type defines all available options. If you require even more customization, you can create your own implementation of the OrderProcess interface.
Parameters
DefaultOrderProcessOptionsThis is the built-in OrderProcess that ships with Vendure. A customized version of this process can be created using the configureDefaultOrderProcess function, which allows you to pass in an object to enable/disable certain checks.
An interface to extend the OrderState type.
These are the default states of the Order process. They can be augmented and
modified by using the OrderOptions process property, and by default
the defaultOrderProcess will add the states
ArrangingPaymentPaymentAuthorizedPaymentSettledPartiallyShippedShippedPartiallyDeliveredDeliveredModifyingArrangingAdditionalPaymentThis is the object passed to the OrderProcess state transition hooks.