Promotion

Promotion

Promotion

A Promotion is used to define a set of conditions under which promotions actions (typically discounts) will be applied to an Order.

Each assigned PromotionCondition is checked against the Order, and if they all return true, then each assign PromotionItemAction / PromotionOrderAction is applied to the Order.

Signature

class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable {
  type = AdjustmentType.PROMOTION;
  constructor(input?: DeepPartial<Promotion> & {
            promotionConditions?: Array<PromotionCondition<any>>;
            promotionActions?: Array<PromotionAction<any>>;
        })
  @Column({ type: Date, nullable: true, default: null })
    deletedAt: Date | null;
  @Column({ type: Date, nullable: true, default: null })
    startsAt: Date | null;
  @Column({ type: Date, nullable: true, default: null })
    endsAt: Date | null;
  @Column({ nullable: true, default: null })
    couponCode: string;
  @Column({ nullable: true, default: null })
    perCustomerUsageLimit: number;
  @Column() name: string;
  @Column() enabled: boolean;
  @ManyToMany(type => Channel)
    @JoinTable()
    channels: Channel[];
  @Column('simple-json') conditions: ConfigurableOperation[];
  @Column('simple-json') actions: ConfigurableOperation[];
  @Column() priorityScore: number;
  async apply(args: ApplyOrderActionArgs | ApplyOrderItemActionArgs) => Promise<Adjustment | undefined>;
  async test(order: Order, utils: PromotionUtils) => Promise<boolean>;
}

Members

type

property
type:

constructor

method
type:
(input?: DeepPartial<Promotion> & { promotionConditions?: Array<PromotionCondition<any>>; promotionActions?: Array<PromotionAction<any>>; }) => Promotion

deletedAt

property
type:
Date | null

startsAt

property
type:
Date | null

endsAt

property
type:
Date | null

couponCode

property
type:
string

perCustomerUsageLimit

property
type:
number

name

property
type:
string

enabled

property
type:
boolean

channels

property
type:
Channel[]

conditions

property
type:
ConfigurableOperation[]

actions

property
type:
ConfigurableOperation[]

priorityScore

property
type:
number

The PriorityScore is used to determine the sequence in which multiple promotions are tested on a given order. A higher number moves the Promotion towards the end of the sequence.

The score is derived from the sum of the priorityValues of the PromotionConditions and PromotionActions comprising this Promotion.

An example illustrating the need for a priority is this:

Consider 2 Promotions, 1) buy 1 get one free and 2) 10% off when order total is over $50. If Promotion 2 is evaluated prior to Promotion 1, then it can trigger the 10% discount even if the subsequent application of Promotion 1 brings the order total down to way below $50.

apply

async method
type:
(args: ApplyOrderActionArgs | ApplyOrderItemActionArgs) => Promise<Adjustment | undefined>

test

async method
type:
(order: Order, utils: PromotionUtils) => Promise<boolean>