Este endpoint devuelve todas las recompensas de tu programa. Úsalo para mostrar tu catálogo en tu propia web o app, o para encontrar el id que necesitas para canjear una recompensa.
Endpoint ¶
GET https://api.jericommerce.com/v1/programs/{program_slug}/coupons/rewards-public
Este endpoint es público, así que no necesita clave de API. Si el programa no existe, responde 404 con PROGRAM_NOT_FOUND.
Respuesta ¶
La respuesta es una matriz de recompensas:
[
{
"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": []
}
]
| Campo | Notas |
|---|---|
id |
El ID de la recompensa. Envíalo como rewardId para canjearla. |
title, description, image |
Lo que ve el cliente. description puede estar vacío. |
type |
fixed para una Fixed reward y dynamic para Points as cash en el panel de administración. |
redeemCost |
Solo en recompensas fijas. Los puntos que cuesta la recompensa (su Points cost en el panel). |
currencyPerPoint |
Solo en Points as cash. Cuánto dinero vale cada punto. |
minPoints, maxPoints |
Solo en Points as cash. El mínimo y el máximo de puntos que un cliente puede usar de una vez. |
order |
La posición de la recompensa en el catálogo. |
visibilityRules, redeemabilityRules |
Las reglas que deciden quién puede ver y canjear la recompensa. |
Este es el catálogo completo, no las recompensas que un cliente concreto puede canjear ahora mismo. Una recompensa de esta lista aún puede rechazarse para un cliente que no cumpla sus reglas o no tenga puntos suficientes.