Questo endpoint restituisce tutti i premi del tuo programma. Usalo per mostrare il catalogo sul tuo sito o nella tua app, oppure per trovare l'id che ti serve per riscattare un premio.
Endpoint ¶
GET https://api.jericommerce.com/v1/programs/{program_slug}/coupons/rewards-public
Questo endpoint è pubblico, quindi non richiede una chiave API. Se il programma non esiste, risponde 404 con PROGRAM_NOT_FOUND.
Risposta ¶
La risposta è un array di premi:
[
{
"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 | Note |
|---|---|
id |
L'ID del premio. Invialo come rewardId per riscattare il premio. |
title, description, image |
Ciò che vede il cliente. description può essere vuoto. |
type |
fixed per un Fixed reward e dynamic per Points as cash nel pannello di amministrazione. |
redeemCost |
Solo per i Fixed reward. I punti che costa il premio (il suo Points cost nel pannello di amministrazione). |
currencyPerPoint |
Solo per Points as cash. Quanto vale in denaro ogni punto. |
minPoints, maxPoints |
Solo per Points as cash. Il numero minimo e massimo di punti che un cliente può usare in una volta. |
order |
La posizione del premio nel catalogo. |
visibilityRules, redeemabilityRules |
Le regole che stabiliscono chi può vedere e riscattare il premio. |
Questo è il catalogo completo, non l'elenco dei premi che un cliente specifico può riscattare in questo momento. Un premio di questo elenco può comunque essere rifiutato per un cliente che non rispetta le sue regole o non ha abbastanza punti.