This endpoint returns every reward in your program. Use it to show your catalog in your own website or app, or to find the id you need to redeem a reward.

Endpoint 

GET https://api.jericommerce.com/v1/programs/{program_slug}/coupons/rewards-public

This endpoint is public, so it does not need an API key. If the program does not exist, it answers 404 with PROGRAM_NOT_FOUND.

Response

The response is an array of rewards:

[
  {
    "id": "2f6c1a2e-8f3b-4f0e-9a51-1d2b3c4d5e6f",
    "title": "10€ off your next order",
    "description": "Use it on any product.",
    "image": "https://...",
    "type": "fixed",
    "redeemCost": 500,
    "currencyPerPoint": null,
    "minPoints": null,
    "maxPoints": null,
    "order": 1,
    "visibilityRules": [],
    "redeemabilityRules": []
  }
]
Field Notes
id The reward ID. Send it as rewardId to redeem the reward.
title, description, image What the customer sees. description can be empty.
type fixed for a Fixed reward and dynamic for Points as cash in the admin.
redeemCost Fixed rewards only. The points the reward costs (its Points cost in the admin).
currencyPerPoint Points as cash only. How much money each point is worth.
minPoints, maxPoints Points as cash only. The minimum and maximum points a customer can use at once.
order The position of the reward in the catalog.
visibilityRules, redeemabilityRules The rules that decide who can see and redeem the reward.

This is the full catalog, not the rewards a specific customer can redeem right now. A reward in this list can still be rejected for a customer who doesn't meet its rules or doesn't have enough points.