Description
The PromotionAction object contains information about how a Promotion acts when it is applied.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
action |
String | Returns the action that this PromotionAction will take, eg: 'apply_per_item', 'apply_per_order', 'buy_one_get_another_at_discount', 'apply_free_shipping', 'apply_discount_shipping' |
calculation |
String | Returns the calculation type for this PromotionAction, eg: 'percentage', 'flat_rate' |
discount_percent |
Number | Returns the percentage of discount to apply |
discount_value |
Number | Returns the amount of discount to apply |
discount_value_points |
Number | Returns the amount of discount to apply in points |
id |
String | Returns the unique id for this PromotionAction |
promotion |
Promotion | Returns the Promotion object associated with this PromotionAction |
qualifying_quantity |
Number | Returns the quantity of scoped items needed before the order qualifies for the promotion |