OrderOptions

Package: @vendure/core File: vendure-config.ts

Signature

interface OrderOptions {
  orderItemsLimit?: number;
  process?: OrderProcessOptions<string>;
  mergeStrategy?: OrderMergeStrategy;
  checkoutMergeStrategy?: OrderMergeStrategy;
}

Members

orderItemsLimit

property

type:

number

default:

999

The maximum number of individual items allowed in a single order. This option exists to prevent excessive resource usage when dealing with very large orders. For example, if an order contains a million items, then any operations on that order (modifying a quantity, adding or removing an item) will require Vendure to loop through all million items to perform price calculations against active promotions and taxes. This can have a significant performance impact for very large values.

Attempting to exceed this limit will cause Vendure to throw a OrderItemsLimitError.

process

property

type:

OrderProcessOptions<string>

Defines custom states and transition logic for the order process state machine.

mergeStrategy

property

type:

OrderMergeStrategy

default:

MergeOrdersStrategy

Defines the strategy used to merge a guest Order and an existing Order when signing in.

checkoutMergeStrategy

property

type:

OrderMergeStrategy

default:

UseGuestStrategy

Defines the strategy used to merge a guest Order and an existing Order when signing in as part of the checkout flow.

OrderProcessOptions

Package: @vendure/core File: vendure-config.ts

Defines custom states and transition logic for the order process state machine.

Signature

interface OrderProcessOptions<T extends string> {
  transtitions?: Partial<Transitions<T | OrderState>>;
  onTransitionStart?(
        fromState: T,
        toState: T,
        data: { order: Order },
    ): boolean | Promise<boolean> | Observable<boolean> | void;
  onTransitionEnd?(fromState: T, toState: T, data: { order: Order }): void;
  onTransitionError?(fromState: T, toState: T, message?: string): void;
}

Members

transtitions

property

type:

Partial<Transitions<T | OrderState>>

Define how the custom states fit in with the default order state transitions.

onTransitionStart

method

type:

(fromState: T, toState: T, data: { order: Order }) => boolean | Promise<boolean> | Observable<boolean> | void

Define logic to run before a state tranition takes place. Returning false will prevent the transition from going ahead.

onTransitionEnd

method

type:

(fromState: T, toState: T, data: { order: Order }) => void

Define logic to run after a state transition has taken place.

onTransitionError

method

type:

(fromState: T, toState: T, message?: string) => void

Define a custom error handler function for transition errors.