Represents a promotion for a loyalty program.
<- Object
Object
Represents a promotion for a loyalty program.
Loyalty promotions enable buyers to earn extra points on top of those earned from the base program.
A loyalty program can have a maximum of 10 loyalty promotions with an ACTIVE or SCHEDULED status.
The points incentive for the promotion. This field defines whether promotion points are earned by multiplying base program points or by adding a specified number of points.
The scheduling information that defines when purchases can qualify to earn points from an ACTIVE promotion.
The number of times a buyer can earn promotion points during a specified interval. If not specified, buyers can trigger the promotion an unlimited number of times.
Read only The timestamp of when the promotion was created, in RFC 3339 format.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
Read only The timestamp of when the promotion was canceled, in RFC 3339 format.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
Read only The timestamp when the promotion was last updated, in RFC 3339 format.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
Read only The ID of the loyalty program associated with the promotion.
The minimum purchase amount required to earn promotion points. If specified, this amount is positive.
The IDs of any qualifying ITEM_VARIATION catalog objects. If specified, the purchase must include at least one of these items to qualify for the promotion.
This option is valid only if the base loyalty program uses a VISIT or SPEND accrual rule. With SPEND accrual rules, make sure that qualifying promotional items are not excluded.
You can specify qualifying_item_variation_ids or qualifying_category_ids for a given promotion, but not both.
The IDs of any qualifying CATEGORY catalog objects. If specified, the purchase must include at least one item from one of these categories to qualify for the promotion.
This option is valid only if the base loyalty program uses a VISIT or SPEND accrual rule. With SPEND accrual rules, make sure that qualifying promotional items are not excluded.
You can specify qualifying_category_ids or qualifying_item_variation_ids for a promotion, but not both.