Dieser Endpunkt gibt alle Prämien Ihres Programms zurück. Verwenden Sie ihn, um Ihren Katalog auf Ihrer eigenen Website oder in Ihrer App anzuzeigen oder um die id zu finden, die Sie zum Einlösen einer Prämie brauchen.
Endpunkt ¶
GET https://api.jericommerce.com/v1/programs/{program_slug}/coupons/rewards-public
Dieser Endpunkt ist öffentlich und benötigt keinen API-Schlüssel. Existiert das Programm nicht, antwortet er mit 404 und PROGRAM_NOT_FOUND.
Antwort ¶
Die Antwort ist ein Array von Prämien:
[
{
"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": []
}
]
| Feld | Hinweise |
|---|---|
id |
Die ID der Prämie. Senden Sie sie als rewardId, um die Prämie einzulösen. |
title, description, image |
Was der Kunde sieht. description kann leer sein. |
type |
fixed für eine Fixed reward und dynamic für Points as cash im Adminbereich. |
redeemCost |
Nur bei Fixed rewards. Die Punkte, die die Prämie kostet (im Adminbereich die Points cost). |
currencyPerPoint |
Nur bei Points as cash. Wie viel Geld jeder Punkt wert ist. |
minPoints, maxPoints |
Nur bei Points as cash. Die Mindest- und Höchstzahl an Punkten, die ein Kunde auf einmal einsetzen kann. |
order |
Die Position der Prämie im Katalog. |
visibilityRules, redeemabilityRules |
Die Regeln, die festlegen, wer die Prämie sehen und einlösen kann. |
Dies ist der vollständige Katalog, nicht die Prämien, die ein bestimmter Kunde gerade einlösen kann. Eine Prämie in dieser Liste kann trotzdem abgelehnt werden, wenn der Kunde ihre Regeln nicht erfüllt oder nicht genug Punkte hat.