Diese Seite beschreibt die API-Calls zum Abfragen, Auf- sowie Entladen von Kundenboni.
Allgemeine Konfiguration
Der Parameter KUNDENBONUSSYSTEM sollte im Globalen-Bereich gepflegt werden und hat vier Optionen:
- poe → Es wird die Standard TRADEMAN Kundenbonusverwaltung genutzt
- plp → Gutscheine werden extern von Payloop verwaltet
- sdps → Gutscheine werden extern vom SD Promoserver verwaltet
- 4s → Gutscheine werden extern von Foursellers verwaltet
getCustomerBonus
Abfragen von KundenBonus-Informationen.
Der aktuelle Wert des Kundenbonus wird zurückgeliefert.
Aufruf:
GET - /api/bonus/<Referenz>/<Referenz-Typ>http://trademan/api/customerbonus/10001/1?v=1
Die Referenz kann dabei z.B. eine (1)Kunden-Nr. oder eine (2)Karten-Nr. sein.
Der Referenz-Typ gibt dabei an, um welche Art von Referenz es sich handelt.
Antwort:
- 200 - OK
- 404 - Kunde oder Kundenkarte nicht gefunden
- 500 - Unerwarteter Fehler
- 503 - Modul nicht konfiguriert, Parameter KUNDENBONUSSYSTEM
Beim erfolgreichen Aufruf kommen Bonus Infos zurück
JSON-Antwort
{
"success": true,
"code": 200,
"api_version": "1",
"rowcount": 1,
"msg": "Abfrage erfolgreich - Boni gefunden",
"warning": "",
"data": {
"kundenbonus": {
"id": 16,
"ref": "10001",
"reftyp": 1,
"anlagedatum": "20170810152447",
"belegdatum": "20170810152447",
"betrag": -489,
"saldo": 2115,
"belegnr": "99",
"belegtyp": 1,
"kasse": 333,
"text1": "",
"vknr": 99,
"fremdsystem": 0,
"transaktionid": ""
}
}
}
loadCustomerBonus
Aufladen/Erhöhen des Betrags eines Kundenbonus. Der Betrag muss dabei immer positiv sein, sonst wird ein Fehler geworfen.
Aufruf:
POST - api/loadcustomerbonushttp://trademan/api/loadcustomerbonus
{
"api_version": 1,
"systemno": 42,
"operatorno": 666,
"systemtype": "POSMAN",
"processno": 1337,
"datetime": "2017-08-30T13:37:42+0100",
"customercardid": "",
"customerid": "10001",
"value": 500,
"notice": "Bemerkung", // Optional
"processtype": "Beletyp" // Optional
}
Antwort:
Beim erfolgreichen Aufruf wird eine entsprechende Antwort zurückgegeben und die neuen Kundenbonus-Daten (Saldo etc.):
- 200 - OK
- 400 - Fehlerhafte Werte der übergebenen Parameter
- 404 - Kunde oder Kundenkarte nicht gefunden
- 500 - Unerwarteter Fehler
- 503 - Modul nicht konfiguriert, Parameter KUNDENBONUSSYSTEM
JSON-Antwort:
{
"success": true,
"code": 200,
"api_version": 1,
"rowcount": 1,
"msg": "Bonus erfolgreich aufgeladen",
"warning": "",
"data": {
"kundenbonus": {
"id": 20,
"ref": "10001",
"reftyp": 1,
"anlagedatum": "20170830121318",
"belegdatum": "20170830133742",
"betrag": 500,
"saldo": 2115,
"belegnr": "1337",
"belegtyp": 1337,
"kasse": 42,
"text1": "Bemerkung",
"vknr": 666,
"fremdsystem": 0,
"transaktionid": ""
}
}
}
unloadCustomerBonus
Einlösen/Verringern des Bonusbetrags eines Kunden. Der Betrag muss dabei immer positiv sein, sonst wird ein Fehler geworfen.
Im poe-internen Bonus-System findet auch eine Prüfung statt, die das Guthaben überprüft.
Aufruf:
POST - api/unloadcustomerbonushttp://trademan/api/unloadcustomerbonus
{
"api_version": 1,
"systemno": 42,
"operatorno": 666,
"systemtype": "POSMAN",
"processno": 1337,
"datetime": "2017-08-30T13:37:42+0100",
"customercardid": "",
"customerid": "10001",
"value": 500,
"notice": "Bemerkung", // Optional
"processtype": "Beletyp" // Optional
}
Antwort:
Beim erfolgreichen Aufruf wird eine entsprechende Antwort zurückgegeben und die neuen Kundenbonus-Daten (Saldo etc.)
- 200 - OK
- 400 - Fehlerhafte Werte der übergebenen Parameter
- 404 - Kunde oder Kundenkarte nicht gefunden
- 409 - Nicht genügend Guthaben
- 500 - Unerwarteter Fehler
- 503 - Modul nicht konfiguriert, Parameter BONUSPUNKTESYSTEM
JSON-Antwort:
{
"success": true,
"code": 200,
"api_version": 1,
"rowcount": 1,
"msg": "Bonus erfolgreich abgebucht",
"warning": "",
"data": {
"kundenbonus": {
"id": 21,
"ref": "10001",
"reftyp": 1,
"anlagedatum": "20170830121629",
"belegdatum": "20170830133742",
"betrag": -500,
"saldo": 1615,
"belegnr": "1337",
"belegtyp": 1337,
"kasse": 42,
"text1": "Bemerkung",
"vknr": 666,
"fremdsystem": 0,
"transaktionid": ""
}
}
}