OrderOptions

OrderOptions

Documentation generated from vendure-config.ts on Mar 14 2019 at 20:14

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.

process

property
type:
OrderProcessOptions<string>

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

mergeStrategy

property

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

checkoutMergeStrategy

property
default:
UseGuestStrategy

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

alpha