Available effects in promotion rules
This page lists the available effects in promotion rules.
In promotion rules, effects are triggered when all or some of the conditions of the rule
are valid, depending on whether all or at least one condition is set to be true.
Effects follow the logic WHEN this happens THEN do that.
You can trigger effects to send a notification, apply a discount to your customer's session, or create a referral code.
Promotion rules also have failure effects. Failure effects define what happens when one or more conditions are not met. You can set notifications and custom effects as failure effects.
The effects triggered by Talon.One are returned to your website/integration layer and it is up to you and your development team to decide how to apply them.
Learn how to process effects in the Developer docs and see the JSON structure of each of them on the API effects page.
The effects available in promotion rules are sorted by these categories:
- Discount effects
- Reward effects
- Create effects
- Update effects
- Achievement effects
- Webhooks
- Custom effects
Most of the effects are always available, but some are only available when you enable specific features in your campaign.
Discount effects
| Effect name | Description | API effect |
|---|---|---|
| Discount session total | Applies a discount to the total value of a customer session. | setDiscount |
| Discount individual items | Applies a discount to certain items or their additional cost in the cart. Eligible items are discounted one by one. | setDiscountPerItem |
| Discount individual items pro rata | Applies a pro rata discount to certain items in the cart. | setDiscountPerItem |
| Discount bundles pro rata | Applies a pro rata discount to the items in one or more bundles. | setDiscountPerItem |
| Discount individual item in bundles pro rata | Applies a single discount that is distributed pro rata throughout all items in a bundle, determined by the individual item. | setDiscountPerItem |
| Discount additional cost | Applies a discount to an additional cost, such as shipping costs or transaction fees. | setDiscountPerAdditionalCost |
| Discount additional cost per item | Applies a discount to an additional cost, such as a shipping cost, applied to an individual cart item. | setDiscountPerAdditionalCost |
Reward effects
| Effect name | Description | API effect |
|---|---|---|
| Add free item | Adds one or more free items to a customer's session. | addFreeItem |
| Add loyalty points | Adds loyalty points per session total to a customer's wallet or to a loyalty card. The loyalty feature must be enabled in the campaign. | addLoyaltyPoints changeLoyaltyTierLevel |
| Add loyalty points per item | Adds loyalty points per cart item to a customer's wallet or to a loyalty card. The loyalty feature must be enabled in the campaign. | addLoyaltyPoints changeLoyaltyTierLevel |
| Redeem loyalty points | Allows a customer to use their loyalty points. The loyalty feature must be enabled in the campaign. | deductLoyaltyPoints |
| Award giveaway | Grants a giveaway code to the customer. The giveaways feature must be enabled in the campaign. | awardGiveaway |
Create effects
| Effect name | Description | API effect |
|---|---|---|
| Create notification | Displays a notification to the customer. | showNotification |
| Create referral code | Generates a referral code for your customer. The referrals feature must be enabled in the campaign. | referralCreated |
| Create coupon code | Generates a coupon code of a gift card for your customer. The coupons feature must be enabled in the campaign. | couponCreated |
| Create coupon code reservation | Reserves a coupon code so it can only be redeemed by the current customer profile. The coupons feature must be enabled in the campaign. | reserveCoupon |
Update effects
| Effect name | Description | API effect |
|---|---|---|
| Update attribute value | Updates the value of a custom attribute. | updateAttribute |
| Update cart item attribute value | Updates the value of a custom attribute for the items in the customer's cart. | updateAttribute |
| Update audience | Adds a customer to or removes them from an audience. | addToAudience removeFromAudience |
Achievement effects
| Effect name | Description | API effect |
|---|---|---|
Updates the progress of the customer in the achievement. |
Webhooks
| Effect name | Description | API effect |
|---|---|---|
| Any webhooks you created. | To learn how to create webhooks, see the Developer docs. | callApi |
Custom effects
| Effect name | Description | API effect |
|---|---|---|
| Any custom effect you created. | To learn how to create custom effects, see Managing custom effects. | What you define as API name and payload. |