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 docs.

Signature

interface OrderProcess<State extends keyof CustomOrderStates | string> extends InjectableStrategy {
  transitions?: Transitions<State, State | OrderState> & Partial<Transitions<OrderState | State>>;
  onTransitionStart?: OnTransitionStartFn<State | OrderState, OrderTransitionData>;
  onTransitionEnd?: OnTransitionEndFn<State | OrderState, OrderTransitionData>;
  onTransitionError?: OnTransitionErrorFn<State | OrderState>;
}

Extends

• InjectableStrategy

Members

transitions

onTransitionStart

onTransitionEnd

onTransitionError

DefaultOrderProcessOptions

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.

Signature

interface DefaultOrderProcessOptions {
  checkModificationPayments?: boolean;
  checkAdditionalPaymentsAmount?: boolean;
  checkAllVariantsExist?: boolean;
  arrangingPaymentRequiresContents?: boolean;
  arrangingPaymentRequiresCustomer?: boolean;
  arrangingPaymentRequiresShipping?: boolean;
  arrangingPaymentRequiresStock?: boolean;
  checkPaymentsCoverTotal?: boolean;
  checkAllItemsBeforeCancel?: boolean;
  checkFulfillmentStates?: boolean;
}

Members

checkModificationPayments

checkAdditionalPaymentsAmount

checkAllVariantsExist

arrangingPaymentRequiresContents

arrangingPaymentRequiresCustomer

arrangingPaymentRequiresShipping

arrangingPaymentRequiresStock

checkPaymentsCoverTotal

checkAllItemsBeforeCancel

checkFulfillmentStates

configureDefaultOrderProcess

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.

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 type defines all available options. If you require even more customization, you can create your own implementation of the OrderProcess interface.

Signature

function configureDefaultOrderProcess(options: DefaultOrderProcessOptions): void

Parameters

options

defaultOrderProcess

This 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.

OrderStates

An interface to extend the OrderState type.

Signature

interface OrderStates {

}

OrderState

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

• ArrangingPayment
• PaymentAuthorized
• PaymentSettled
• PartiallyShipped
• Shipped
• PartiallyDelivered
• Delivered
• Modifying
• ArrangingAdditionalPayment

Signature

type OrderState = | 'Created'
    | 'Draft'
    | 'AddingItems'
    | 'Cancelled'
    | keyof CustomOrderStates
    | keyof OrderStates

OrderTransitionData

This is the object passed to the OrderProcess state transition hooks.

Signature

interface OrderTransitionData {
  ctx: RequestContext;
  order: Order;
}

Members

ctx

order