Redeem a Reward

This action redeems a reward for a customer, the same way they would from their Customer App. JeriCommerce checks the reward's rules, removes the points, and gives the customer a discount code. Use it when customers redeem from your own website, app, or point of sale, or to redeem automatically from a Klaviyo flow.

What happens ¶

• The reward's points are removed from the customer's balance.
• The customer gets a discount code: a new single-use Shopify code or the next code from your uploaded batch, depending on the reward's discount.
• The customer receives an email with the code, and the code appears in their coupons.
• A Reward redeemed event with the code and a Balance changed event are sent to your events webhook. Listen to Reward redeemed if your system needs the code.

A Fixed reward always costs its Points cost. A Points as cash reward lets the customer choose how many points to use, between the reward's minimum and maximum. The discount is the points multiplied by the value of each point, rounded to two decimals. For example, 500 points worth 0.02 each give a 10.00 discount.

The redemption is rejected, without removing points, when:

• The customer doesn't have enough points, or some of their points are still on hold.
• The customer doesn't meet the reward's visibility or segment rules.
• The reward's discount has no codes left.
• The points to redeem are missing for a Points as cash reward, or outside its minimum and maximum.

Set it up ¶

[
  {
    "email": "{{ person.email|default:'' }}",
    "rewardId": ""
  }
]

POST https://api.jericommerce.com/v1/programs/{program_slug}/reward/redeem

[
  {
    "email": "customer@example.com",
    "rewardId": "2f6c1a2e-8f3b-4f0e-9a51-1d2b3c4d5e6f"
  }
]

curl --request POST \
  --url 'https://api.jericommerce.com/v1/programs/your-program-slug/reward/redeem' \
  --header 'api-key: your-api-key' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "email": "customer@example.com",
    "rewardId": ""
  }
]'