Skip to main content

OrderPlacedStrategy

OrderPlacedStrategy​

@vendure/coreorder-placed-strategy.ts

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.

Signature
interface OrderPlacedStrategy extends InjectableStrategy {
    shouldSetAsPlaced(
        ctx: RequestContext,
        fromState: OrderState,
        toState: OrderState,
        order: Order,
    ): boolean | Promise<boolean>;
}

shouldSetAsPlaced​

method
(ctx: RequestContext, fromState: OrderState, toState: OrderState, order: Order) => boolean | Promise<boolean>

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