Documentatie
difficulty level:
Module textPhrase before ModuleName Kadobon Module textPhrase after ModuleName.
API - Gift - POST gift/validate
POST gift/validate
Verwendet für
Überprüfen eines Geschenkgutschein-Codes.
Es können maximal 10 Geschenkgutscheine gleichzeitig validiert werden.
Wenn ein Geschenkgutschein ungültig ist, wird dies zurückgegeben, indem das Attribut valid auf false gesetzt wird.
Wenn ein Geschenkgutschein gültig ist, wird eine Liste von Merkmalen mitgegeben, darunter ein Rabattpreis (price) oder ein Prozentsatz.
Funktional: Ein Geschenkgutschein mit einem Prozentsatz wird auch Rabattgutschein genannt.
Authentifizierung
Der Benutzer muss auf Administratorebene angemeldet sein.
Parameters
| Parameter | Beschreibung | Erforderlich | Beispiel |
|---|---|---|---|
| voucher | Liste von Geschenkgutscheinen oder einzelner Geschenkgutschein | Ja | ["VOUCHER1", "VOUCHER2"]] oder "VOUCHER1" |
| product_id | Produkt-ID, für die der Geschenkgutschein verwendet wird Wenn nicht angegeben, muss eine com_id angegeben werden. |
Nein | 1 |
| com_id | Arrangement-ID, für die der Geschenkgutschein verwendet wird. Wenn nicht angegeben, muss eine product_id angegeben werden. |
Nein | 2 |
Response codes
- 200 OK
Beispiel
Validieren Sie die Geschenkgutschein-Codes VALIDVOUCHER1, VALIDVOUCHER2 und INVALIDVOUCHER für Produkt 1.
POST api/rest/gift/validate/
Request:
{
"voucher": ["VALIDVOUCHER1","VALIDVOUCHER2","INVALIDVOUCHER"],
"product_id": 1
}
Response:
{
"VALIDVOUCHER1": {
"valid": true,
"validtill": "2024-11-30T00:00:00+0100",
"percentage": 100,
"price": "0",
"currency": "EUR",
"product_id": "1",
"combi_id": "0"
},
"VALIDVOUCHER2": {
"valid": true,
"validtill": "2018-05-31T00:00:00+0200",
"percentage": 0,
"price": "10",
"currency": "EUR",
"product_id": "1",
"combi_id": "0"
},
"INVALIDVOUCHER": {
"valid": false
}
}
