- DarkLight
Creating a Redeemable Custom Coupon
- DarkLight
The Custom Coupon reward allows you to manually upload codes for redeemable rewards that will be applied on a platform or 3rd party app that Yotpo Loyalty & Referrals does not directly integrate with.
Creating a New Custom Coupon
From the main menu go to Manage Program > Rewards Program.
Under Ways to redeem, click Create reward.
Select Custom Coupon from the Reward type dropdown menu.
Click Next.
Setting up Your Custom Coupon
Certain settings are unique to the Custom Coupon reward:
Where will the coupon be used? – Determines which In-store Module this reward will appear in.
Coupon Value (in cents) – Displays as part of your investment in the performance dashboards.
Low code threshold notification – Listed as “When the number of unused codes goes below this number, a webhook notification will be sent” in the settings. This defines the threshold at which the Redemption Below Threshold event is triggered when the number of unused codes falls below the specified value.
Adding Codes
Once you’ve created and set up your Custom Coupon reward, you will need to upload your codes to make it redeemable by customers in your store.
To upload new codes, do the following:
Create the codes on the platform or 3rd party app where they will apply. Your customers will receive these codes upon redemption and be able to use them on the designated platform or 3rd party app.
Gather and format the codes into a CSV file. Organize the file with one code per row. For example:
On the main Redeemable Rewards page, find the Custom Coupon reward you just created.
Click Add codes.
You have the option to either upload a CSV file with your codes, or enter them one-by-one.
Tip
If you have more than just a few codes, we recommend uploading them in a CSV file. Otherwise, enter them individually in the text box.
Note
CSV uploads currently support up to 10 000 codes per file. If you are trying to upload more than that, copy & paste the codes from your file into the text box.
You can see the number of remaining codes available on the main Redeemable Rewards page.
Note
The number of available codes will go down every time a customer redeems a Custom Coupon and uses its associated code in your store.
To add more codes to your Custom Coupon in addition to the ones you already have available, click Add codes.
Clearing Codes
If you want to clear all codes, do the following:
Hover over your Custom Coupon reward.
Click the ellipsis icon (3 dots) on the right.
Click Clear codes.
Adding Codes Using an Automated Flow via API
Note
Implementing this flow requires dev resources.
You can create an automation that will be triggered by our event and will automatically upload new codes to the relevant Custom Coupon reward
To set up an automatic flow via API, do the following:
Set up a webhook URL:
From the main menu on the left, go to Settings
In the Webhook URL field, enter the URL that will receive our event notifications.
Set up the webhook notification threshold:
From the main menu on the left, go to Set Up Program. Then, click Redeemable Rewards
Hover over the Custom Coupon reward, then click Edit
Under the When the number of unused codes goes below this number, a webhook notification will be sent field, enter the codes threshold that will trigger the webhook notification
On the bottom of the page, click Save Coupon
Upload new codes:
Once the webhook notification is triggered, the "Redemption Below Threshold" event will be sent to the webhook URL you set up.
The event will contain the redemption_option_id of the Custom Coupon, as well as its name, and the full redemption option (coupon) object.
You can now use these parameters to trigger a bulk creation of the relevant type of coupons on the platform or 3rd party app and push them into Yotpo Loyalty & Referrals using the Upload Coupon Codes API call.
This will complete the flow and ensure your customers can continue redeeming their points for the different Custom Coupons.