OrderOptions

OrderOptions

OrderOptions

Signature

interface OrderOptions {
  orderItemsLimit?: number;
  orderLineItemsLimit?: number;
  orderItemPriceCalculationStrategy?: OrderItemPriceCalculationStrategy;
  process?: Array<CustomOrderProcess<any>>;
  stockAllocationStrategy?: StockAllocationStrategy;
  mergeStrategy?: OrderMergeStrategy;
  checkoutMergeStrategy?: OrderMergeStrategy;
  orderCodeStrategy?: OrderCodeStrategy;
  changedPriceHandlingStrategy?: ChangedPriceHandlingStrategy;
  orderPlacedStrategy?: OrderPlacedStrategy;
}

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 {@link OrderItemsLimitError}.

orderLineItemsLimit

property
type:
number
default:
999

The maximum number of items allowed per order line. This option is an addition on the orderItemsLimit for more granular control. Note orderItemsLimit is still important in order to prevent excessive resource usage.

Attempting to exceed this limit will cause Vendure to throw a {@link OrderItemsLimitError}.

orderItemPriceCalculationStrategy

property
default:
DefaultPriceCalculationStrategy
Defines the logic used to calculate the unit price of an OrderItem when adding an item to an Order.

process

property
type:
Array<CustomOrderProcess<any>>
default:
[]
Allows the definition of custom states and transition logic for the order process state machine. Takes an array of objects implementing the CustomOrderProcess interface.

stockAllocationStrategy

Determines the point of the order process at which stock gets allocated.

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.

orderCodeStrategy

Allows a user-defined function to create Order codes. This can be useful when integrating with existing systems. By default, Vendure will generate a 16-character alphanumeric string.

Note: when using a custom function for Order codes, bear in mind the database limit for string types (e.g. 255 chars for a varchar field in MySQL), and also the need for codes to be unique.

changedPriceHandlingStrategy

property
default:
DefaultChangedPriceHandlingStrategy

Defines how we handle the situation where an OrderItem exists in an Order, and then later on another is added but in the mean time the price of the ProductVariant has changed.

By default, the latest price will be used. Any price changes resulting from using a newer price will be reflected in the GraphQL OrderLine.unitPrice[WithTax]ChangeSinceAdded field.

orderPlacedStrategy

Defines the point of the order process at which the Order is set as “placed”.