*** title: "OrderProcess" generated: true --------------- ## OrderProcess 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](/current/core/reference/typescript-api/state-machine/state-machine-config#statemachineconfig) docs. :::info This is configured via the `orderOptions.process` property of your VendureConfig. ::: ```ts title="Signature" interface OrderProcess extends InjectableStrategy { transitions?: Transitions & Partial>; onTransitionStart?: OnTransitionStartFn; onTransitionEnd?: OnTransitionEndFn; onTransitionError?: OnTransitionErrorFn; } ``` * Extends: [`InjectableStrategy`](/current/core/reference/typescript-api/common/injectable-strategy#injectablestrategy)

### transitions \TransitionsOrderState> & Partial<Transitions<OrderState | State>>`} /> ### onTransitionStart \OnTransitionStartFnOrderState, OrderTransitionData>`} /> ### onTransitionEnd \OnTransitionEndFnOrderState, OrderTransitionData>`} /> ### onTransitionError \OnTransitionErrorFnOrderState>`} />

## DefaultOrderProcessOptions Options which can be passed to the [configureDefaultOrderProcess](/current/core/reference/typescript-api/orders/order-process#configuredefaultorderprocess) function to configure an instance of the default [OrderProcess](/current/core/reference/typescript-api/orders/order-process#orderprocess). By default, all options are set to `true`. ```ts title="Signature" interface DefaultOrderProcessOptions { checkModificationPayments?: boolean; checkAdditionalPaymentsAmount?: boolean; checkAllVariantsExist?: boolean; arrangingPaymentRequiresContents?: boolean; arrangingPaymentRequiresCustomer?: boolean; arrangingPaymentRequiresShipping?: boolean; arrangingPaymentRequiresStock?: boolean; checkPaymentsCoverTotal?: boolean; checkAllItemsBeforeCancel?: boolean; checkFulfillmentStates?: boolean; } ```

### checkModificationPayments \ Prevents 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. ### checkAdditionalPaymentsAmount \ Prevents an Order from transitioning out of the `ArrangingAdditionalPayment` state if the Order's Payments do not cover the full amount of `totalWithTax`. ### checkAllVariantsExist \ Prevents the transition from `AddingItems` to any other state (apart from `Cancelled`) if and of the ProductVariants no longer exists due to deletion. ### arrangingPaymentRequiresContents \ Prevents transition to the `ArrangingPayment` state if the active Order has no lines. ### arrangingPaymentRequiresCustomer \ Prevents transition to the `ArrangingPayment` state if the active Order has no customer associated with it. ### arrangingPaymentRequiresShipping \ Prevents transition to the `ArrangingPayment` state if the active Order has no shipping method set. ### arrangingPaymentRequiresStock \ Prevents transition to the `ArrangingPayment` state if there is insufficient saleable stock to cover the contents of the Order. ### checkPaymentsCoverTotal \ Prevents transition to the `PaymentAuthorized` or `PaymentSettled` states if the order `totalWithTax` amount is not covered by Payment(s) in the corresponding states. ### checkAllItemsBeforeCancel \ Prevents transition to the `Cancelled` state unless all OrderItems are already cancelled. ### checkFulfillmentStates \ Prevents 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.

## configureDefaultOrderProcess Used to configure a customized instance of the default [OrderProcess](/current/core/reference/typescript-api/orders/order-process#orderprocess) that ships with Vendure. Using this function allows you to turn off certain checks and constraints that are enabled by default. ```ts import { configureDefaultOrderProcess, VendureConfig } from '@vendure/core'; const myCustomOrderProcess = configureDefaultOrderProcess({ // Disable the constraint that requires // Orders to have a shipping method assigned // before payment. arrangingPaymentRequiresShipping: false, }); export const config: VendureConfig = { orderOptions: { process: [myCustomOrderProcess], }, }; ``` The [DefaultOrderProcessOptions](/current/core/reference/typescript-api/orders/order-process#defaultorderprocessoptions) type defines all available options. If you require even more customization, you can create your own implementation of the [OrderProcess](/current/core/reference/typescript-api/orders/order-process#orderprocess) interface. ```ts title="Signature" function configureDefaultOrderProcess(options: DefaultOrderProcessOptions): void ``` Parameters ### options \DefaultOrderProcessOptions`} /> ## defaultOrderProcess This is the built-in [OrderProcess](/current/core/reference/typescript-api/orders/order-process#orderprocess) that ships with Vendure. A customized version of this process can be created using the [configureDefaultOrderProcess](/current/core/reference/typescript-api/orders/order-process#configuredefaultorderprocess) function, which allows you to pass in an object to enable/disable certain checks. ## OrderStates An interface to extend the [OrderState](/current/core/reference/typescript-api/orders/order-process#orderstate) type. ```ts title="Signature" interface OrderStates { } ``` ## OrderState These are the default states of the Order process. They can be augmented and modified by using the [OrderOptions](/current/core/reference/typescript-api/orders/order-options#orderoptions) `process` property, and by default the [defaultOrderProcess](/current/core/reference/typescript-api/orders/order-process#defaultorderprocess) will add the states * `ArrangingPayment` * `PaymentAuthorized` * `PaymentSettled` * `PartiallyShipped` * `Shipped` * `PartiallyDelivered` * `Delivered` * `Modifying` * `ArrangingAdditionalPayment` ```ts title="Signature" type OrderState = | 'Created' | 'Draft' | 'AddingItems' | 'Cancelled' | keyof CustomOrderStates | keyof OrderStates ``` ## OrderTransitionData This is the object passed to the [OrderProcess](/current/core/reference/typescript-api/orders/order-process#orderprocess) state transition hooks. ```ts title="Signature" interface OrderTransitionData { ctx: RequestContext; order: Order; } ```

### ctx \RequestContext`} /> ### order \Order`} />