OrderPlacedStrategy

Package: @vendure/core File: order-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’.

Signature

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

Extends

InjectableStrategy

Members

shouldSetAsPlaced

method

type:

(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

Contents