@vendure/docs 0.0.0-202601161541

package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.md

@@ -0,0 +1,91 @@
+---
+title: "OrderItemPriceCalculationStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## OrderItemPriceCalculationStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/order/order-item-price-calculation-strategy.ts" sourceLine="60" packageName="@vendure/core" />
+
+The OrderItemPriceCalculationStrategy defines the listPrice of an OrderLine when adding an item to an Order. By default the
+<a href='/reference/typescript-api/orders/default-order-item-price-calculation-strategy#defaultorderitempricecalculationstrategy'>DefaultOrderItemPriceCalculationStrategy</a> is used.
+
+:::info
+
+This is configured via the `orderOptions.orderItemPriceCalculationStrategy` property of
+your VendureConfig.
+
+:::
+
+### When is the strategy invoked ?
+* addItemToOrder (only on the new order line)
+* adjustOrderLine  (only on the adjusted order line)
+* setOrderShippingAddress (on all order lines)
+* setOrderBillingAddress (on all order lines)
+
+### OrderItemPriceCalculationStrategy vs Promotions
+Both the OrderItemPriceCalculationStrategy and Promotions can be used to alter the price paid for a product.
+
+The main difference is when a Promotion is applied, it adds a `discount` line to the Order, and the regular
+price is used for the value of `OrderLine.listPrice` property, whereas
+the OrderItemPriceCalculationStrategy actually alters the value of `OrderLine.listPrice` itself, and does not
+add any discounts to the Order.
+
+Use OrderItemPriceCalculationStrategy if:
+
+* The price calculation is based on the properties of the ProductVariant and any CustomFields
+  specified on the OrderLine, for example via a product configurator.
+* The logic is a permanent part of your business requirements.
+
+Use Promotions if:
+
+* You want to implement "discounts" and "special offers"
+* The calculation is not a permanent part of your business requirements.
+* The price depends on dynamic aspects such as quantities and which other
+  ProductVariants are in the Order.
+* The configuration of the logic needs to be manipulated via the Admin UI.
+
+### Example use-cases
+
+A custom OrderItemPriceCalculationStrategy can be used to implement things like:
+
+* A gift-wrapping service, where a boolean custom field is defined on the OrderLine. If `true`,
+  a gift-wrapping surcharge would be added to the price.
+* A product-configurator where e.g. various finishes, colors, and materials can be selected and stored
+  as OrderLine custom fields (see [the Custom Fields guide](/guides/developer-guide/custom-fields/).
+* Price lists or bulk pricing, where different price bands are stored e.g. in a customField on the ProductVariant, and this
+  is used to calculate the price based on the current quantity.
+
+```ts title="Signature"
+interface OrderItemPriceCalculationStrategy extends InjectableStrategy {
+    calculateUnitPrice(
+        ctx: RequestContext,
+        productVariant: ProductVariant,
+        orderLineCustomFields: { [key: string]: any },
+        order: Order,
+        quantity: number,
+    ): PriceCalculationResult | Promise<PriceCalculationResult>;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### calculateUnitPrice
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, orderLineCustomFields: { [key: string]: any }, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, quantity: number) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a> | Promise&#60;<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>&#62;`}   />
+
+Receives the ProductVariant to be added to the Order as well as any OrderLine custom fields and returns
+the price for a single unit.
+
+Note: if you have any `relation` type custom fields defined on the OrderLine entity, they will only be
+passed in to this method if they are set to `eager: true`. Otherwise, you can use the <a href='/reference/typescript-api/data-access/entity-hydrator#entityhydrator'>EntityHydrator</a>to join the missing relations.
+
+Note: the `quantity` argument was added in v2.0.0
+
+
+</div>

package/docs/reference/typescript-api/orders/order-merge-strategy.md

@@ -0,0 +1,80 @@
+---
+title: "OrderMergeStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## OrderMergeStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/order/order-merge-strategy.ts" sourceLine="48" packageName="@vendure/core" />
+
+An OrderMergeStrategy defines what happens when a Customer with an existing Order
+signs in with a guest Order, where both Orders may contain differing OrderLines.
+
+Somehow these differing OrderLines need to be reconciled into a single collection
+of OrderLines. The OrderMergeStrategy defines the rules governing this reconciliation.
+
+:::info
+
+This is configured via the `orderOptions.mergeStrategy` property of
+your VendureConfig.
+
+:::
+
+```ts title="Signature"
+interface OrderMergeStrategy extends InjectableStrategy {
+    merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): MergedOrderLine[];
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### merge
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, guestOrder: <a href='/reference/typescript-api/entities/order#order'>Order</a>, existingOrder: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/orders/order-merge-strategy#mergedorderline'>MergedOrderLine</a>[]`}   />
+
+Merges the lines of the guest Order with those of the existing Order which is associated
+with the active customer.
+
+
+</div>
+
+
+## MergedOrderLine
+
+<GenerationInfo sourceFile="packages/core/src/config/order/order-merge-strategy.ts" sourceLine="15" packageName="@vendure/core" />
+
+The result of the <a href='/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy'>OrderMergeStrategy</a> `merge` method.
+
+```ts title="Signature"
+interface MergedOrderLine {
+    orderLineId: ID;
+    quantity: number;
+    customFields?: any;
+}
+```
+
+<div className="members-wrapper">
+
+### orderLineId
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
+
+
+### quantity
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### customFields
+
+<MemberInfo kind="property" type={`any`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/orders/order-options.md

@@ -0,0 +1,145 @@
+---
+title: "OrderOptions"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## OrderOptions
+
+<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="521" packageName="@vendure/core" />
+
+
+
+```ts title="Signature"
+interface OrderOptions {
+    orderItemsLimit?: number;
+    orderLineItemsLimit?: number;
+    orderItemPriceCalculationStrategy?: OrderItemPriceCalculationStrategy;
+    process?: Array<OrderProcess<any>>;
+    stockAllocationStrategy?: StockAllocationStrategy;
+    mergeStrategy?: OrderMergeStrategy;
+    checkoutMergeStrategy?: OrderMergeStrategy;
+    orderCodeStrategy?: OrderCodeStrategy;
+    orderByCodeAccessStrategy?: OrderByCodeAccessStrategy;
+    changedPriceHandlingStrategy?: ChangedPriceHandlingStrategy;
+    orderPlacedStrategy?: OrderPlacedStrategy;
+    activeOrderStrategy?: ActiveOrderStrategy<any> | Array<ActiveOrderStrategy<any>>;
+    orderSellerStrategy?: OrderSellerStrategy;
+    guestCheckoutStrategy?: GuestCheckoutStrategy;
+    orderInterceptors?: OrderInterceptor[];
+}
+```
+
+<div className="members-wrapper">
+
+### orderItemsLimit
+
+<MemberInfo kind="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 `OrderLimitError`.
+### orderLineItemsLimit
+
+<MemberInfo kind="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 OrderLimitError`.
+### orderItemPriceCalculationStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy'>OrderItemPriceCalculationStrategy</a>`} default={`DefaultPriceCalculationStrategy`}   />
+
+Defines the logic used to calculate the unit price of an OrderLine when adding an
+item to an Order.
+### process
+
+<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>&#60;any&#62;&#62;`} default={`[]`}   />
+
+Allows the definition of custom states and transition logic for the order process state machine.
+Takes an array of objects implementing the <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> interface.
+### stockAllocationStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy'>StockAllocationStrategy</a>`} default={`<a href='/reference/typescript-api/orders/default-stock-allocation-strategy#defaultstockallocationstrategy'>DefaultStockAllocationStrategy</a>`}   />
+
+Determines the point of the order process at which stock gets allocated.
+### mergeStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy'>OrderMergeStrategy</a>`} default={`<a href='/reference/typescript-api/orders/merge-strategies#mergeordersstrategy'>MergeOrdersStrategy</a>`}   />
+
+Defines the strategy used to merge a guest Order and an existing Order when
+signing in.
+### checkoutMergeStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy'>OrderMergeStrategy</a>`} default={`<a href='/reference/typescript-api/orders/merge-strategies#usegueststrategy'>UseGuestStrategy</a>`}   />
+
+Defines the strategy used to merge a guest Order and an existing Order when
+signing in as part of the checkout flow.
+### orderCodeStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-code-strategy#ordercodestrategy'>OrderCodeStrategy</a>`} default={`<a href='/reference/typescript-api/orders/order-code-strategy#defaultordercodestrategy'>DefaultOrderCodeStrategy</a>`}   />
+
+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.
+### orderByCodeAccessStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-by-code-access-strategy#orderbycodeaccessstrategy'>OrderByCodeAccessStrategy</a>`} default={`<a href='/reference/typescript-api/orders/order-by-code-access-strategy#defaultorderbycodeaccessstrategy'>DefaultOrderByCodeAccessStrategy</a>`}  since="1.1.0"  />
+
+Defines the strategy used to check if and how an Order may be retrieved via the orderByCode query.
+
+The default strategy permits permanent access to the Customer owning the Order and anyone
+within 2 hours after placing the Order.
+### changedPriceHandlingStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/changed-price-handling-strategy#changedpricehandlingstrategy'>ChangedPriceHandlingStrategy</a>`} default={`DefaultChangedPriceHandlingStrategy`}   />
+
+Defines how we handle the situation where an item exists in an Order, and
+then later on another is added but in the meantime 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
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>`} default={`<a href='/reference/typescript-api/orders/default-order-placed-strategy#defaultorderplacedstrategy'>DefaultOrderPlacedStrategy</a>`}   />
+
+Defines the point of the order process at which the Order is set as "placed".
+### activeOrderStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>&#60;any&#62; | Array&#60;<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>&#60;any&#62;&#62;`} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`}  since="1.9.0"  />
+
+Defines the strategy used to determine the active Order when interacting with Shop API operations
+such as `activeOrder` and `addItemToOrder`. By default, the strategy uses the active Session.
+
+Note that if multiple strategies are defined, they will be checked in order and the first one that
+returns an Order will be used.
+### orderSellerStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-seller-strategy#ordersellerstrategy'>OrderSellerStrategy</a>`} default={`<a href='/reference/typescript-api/orders/order-seller-strategy#defaultordersellerstrategy'>DefaultOrderSellerStrategy</a>`}  since="2.0.0"  />
+
+Defines how Orders will be split amongst multiple Channels in a multivendor scenario.
+### guestCheckoutStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/guest-checkout-strategy#guestcheckoutstrategy'>GuestCheckoutStrategy</a>`} default={`<a href='/reference/typescript-api/orders/default-guest-checkout-strategy#defaultguestcheckoutstrategy'>DefaultGuestCheckoutStrategy</a>`}   />
+
+Defines how we deal with guest checkouts.
+### orderInterceptors
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-interceptor#orderinterceptor'>OrderInterceptor</a>[]`} default={`[]`}  since="3.1.0"  />
+
+An array of <a href='/reference/typescript-api/orders/order-interceptor#orderinterceptor'>OrderInterceptor</a>s which can be used to modify the behavior of the Order process.
+
+
+</div>

package/docs/reference/typescript-api/orders/order-placed-strategy.md

@@ -0,0 +1,54 @@
+---
+title: "OrderPlacedStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## OrderPlacedStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/order/order-placed-strategy.ts" sourceLine="24" packageName="@vendure/core" />
+
+This strategy is responsible for deciding at which stage in the order process
+the Order will be set as "placed" (i.e. the Customer has checked out, and
+next it must be processed by an Administrator).
+
+By default, the order is set as "placed" when it transitions from
+'ArrangingPayment' to either 'PaymentAuthorized' or 'PaymentSettled'.
+
+:::info
+
+This is configured via the `orderOptions.orderPlacedStrategy` property of
+your VendureConfig.
+
+:::
+
+```ts title="Signature"
+interface OrderPlacedStrategy extends InjectableStrategy {
+    shouldSetAsPlaced(
+        ctx: RequestContext,
+        fromState: OrderState,
+        toState: OrderState,
+        order: Order,
+    ): boolean | Promise<boolean>;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### shouldSetAsPlaced
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise&#60;boolean&#62;`}   />
+
+This method is called whenever an _active_ Order transitions from one state to another.
+If it resolves to `true`, then the Order will be set as "placed", which means:
+
+* Order.active = false
+* Order.placedAt = new Date()
+* Any active Promotions are linked to the Order
+
+
+</div>

package/docs/reference/typescript-api/orders/order-process.md

@@ -0,0 +1,271 @@
+---
+title: "OrderProcess"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## OrderProcess
+
+<GenerationInfo sourceFile="packages/core/src/config/order/order-process.ts" sourceLine="35" packageName="@vendure/core" />
+
+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 <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a> docs.
+
+:::info
+
+This is configured via the `orderOptions.process` property of
+your VendureConfig.
+
+:::
+
+```ts title="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: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### transitions
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>&#60;State, State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>&#62; &#38; Partial&#60;<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>&#60;<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> | State&#62;&#62;`}   />
+
+
+### onTransitionStart
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>&#60;State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>&#62;`}   />
+
+
+### onTransitionEnd
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>&#60;State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>&#62;`}   />
+
+
+### onTransitionError
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>&#60;State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>&#62;`}   />
+
+
+
+
+</div>
+
+
+## DefaultOrderProcessOptions
+
+<GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="50" packageName="@vendure/core" since="2.0.0" />
+
+Options which can be passed to the <a href='/reference/typescript-api/orders/order-process#configuredefaultorderprocess'>configureDefaultOrderProcess</a> function
+to configure an instance of the default <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>. 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;
+}
+```
+
+<div className="members-wrapper">
+
+### checkModificationPayments
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+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
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents an Order from transitioning out of the `ArrangingAdditionalPayment` state if
+the Order's Payments do not cover the full amount of `totalWithTax`.
+### checkAllVariantsExist
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents the transition from `AddingItems` to any other state (apart from `Cancelled`) if
+and of the ProductVariants no longer exists due to deletion.
+### arrangingPaymentRequiresContents
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents transition to the `ArrangingPayment` state if the active Order has no lines.
+### arrangingPaymentRequiresCustomer
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents transition to the `ArrangingPayment` state if the active Order has no customer
+associated with it.
+### arrangingPaymentRequiresShipping
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents transition to the `ArrangingPayment` state if the active Order has no shipping
+method set.
+### arrangingPaymentRequiresStock
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents transition to the `ArrangingPayment` state if there is insufficient saleable
+stock to cover the contents of the Order.
+### checkPaymentsCoverTotal
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents transition to the `PaymentAuthorized` or `PaymentSettled` states if the order
+`totalWithTax` amount is not covered by Payment(s) in the corresponding states.
+### checkAllItemsBeforeCancel
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Prevents transition to the `Cancelled` state unless all OrderItems are already
+cancelled.
+### checkFulfillmentStates
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+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.
+
+
+</div>
+
+
+## configureDefaultOrderProcess
+
+<GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="163" packageName="@vendure/core" since="2.0.0" />
+
+Used to configure a customized instance of the default <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> 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 <a href='/reference/typescript-api/orders/order-process#defaultorderprocessoptions'>DefaultOrderProcessOptions</a> type defines all available options. If you require even
+more customization, you can create your own implementation of the <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> interface.
+
+```ts title="Signature"
+function configureDefaultOrderProcess(options: DefaultOrderProcessOptions): void
+```
+Parameters
+
+### options
+
+<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/orders/order-process#defaultorderprocessoptions'>DefaultOrderProcessOptions</a>`} />
+
+
+
+## defaultOrderProcess
+
+<GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="475" packageName="@vendure/core" since="2.0.0" />
+
+This is the built-in <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> that ships with Vendure. A customized version of this process
+can be created using the <a href='/reference/typescript-api/orders/order-process#configuredefaultorderprocess'>configureDefaultOrderProcess</a> function, which allows you to pass in an object
+to enable/disable certain checks.
+
+
+
+## OrderStates
+
+<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="21" packageName="@vendure/core" since="2.0.0" />
+
+An interface to extend the <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> type.
+
+```ts title="Signature"
+interface OrderStates {
+
+}
+```
+
+
+## OrderState
+
+<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="42" packageName="@vendure/core" />
+
+These are the default states of the Order process. They can be augmented and
+modified by using the <a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a> `process` property, and by default
+the <a href='/reference/typescript-api/orders/order-process#defaultorderprocess'>defaultOrderProcess</a> 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
+
+<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="57" packageName="@vendure/core" />
+
+This is the object passed to the <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> state transition hooks.
+
+```ts title="Signature"
+interface OrderTransitionData {
+    ctx: RequestContext;
+    order: Order;
+}
+```
+
+<div className="members-wrapper">
+
+### ctx
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`}   />
+
+
+### order
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/order#order'>Order</a>`}   />
+
+
+
+
+</div>