Ce point de terminaison renvoie toutes les récompenses de votre programme. Utilisez-le pour afficher votre catalogue sur votre propre site web ou application, ou pour trouver l’id dont vous avez besoin pour échanger une récompense.

Point de terminaison 

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

Ce point de terminaison est public : il n’a pas besoin de clé API. Si le programme n’existe pas, il répond 404 avec PROGRAM_NOT_FOUND.

Réponse

La réponse est un tableau de récompenses :

[
  {
    "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": []
  }
]
Champ Notes
id L’identifiant de la récompense. Envoyez-le comme rewardId pour échanger la récompense.
title, description, image Ce que le client voit. description peut être vide.
type fixed pour une Fixed reward et dynamic pour Points as cash dans l’interface d’administration.
redeemCost Récompenses fixes uniquement. Les points que coûte la récompense (son Points cost dans l’interface d’administration).
currencyPerPoint Points as cash uniquement. La valeur en argent de chaque point.
minPoints, maxPoints Points as cash uniquement. Le minimum et le maximum de points qu’un client peut utiliser en une fois.
order La position de la récompense dans le catalogue.
visibilityRules, redeemabilityRules Les règles qui déterminent qui peut voir et échanger la récompense.

Il s’agit du catalogue complet, pas des récompenses qu’un client donné peut échanger en ce moment. Une récompense de cette liste peut quand même être refusée pour un client qui ne respecte pas ses règles ou qui n’a pas assez de points.