Entwickler-API

Coupon-Einlösung

Die Einlösung von Gutscheinen kann manuell über das Dashboard erfolgen,
aber mit dieser API kannst du den Einlösungsprozess auf deiner Website automatisieren, wenn Nutzer einen Gutschein verwenden – für eine effizientere Verwaltung.

Diese API ist ab dem Personal-Tarif verfügbar.

Http Header

PUT /api/coupon/v1/redeem
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en

Request

{
	"cpnNo": "ZJLF0399WQBEQZJM",
	"userId": "x77hu",
	"memo": "IP Address: 210.123.111.222, Request Page: example.com/shop/bags/p112233"
}

Felder	Feldbeschreibungen	Beschreibung	Typ
cpnNo	Coupon number	Die „eingelöste“ Gutscheinnummer, die verarbeitet werden soll. Geben Sie nur die Gutscheinnummer ohne das Zeichen „-“ ein.	string
onsitePwd	On-site coupon usage password	Wenn für die Nutzung vor Ort ein Passwort festgelegt wurde, geben Sie das festgelegte Passwort ein. Bei falschem Passwort kann der Gutschein nicht eingelöst werden.	string
userId	User ID	Dient zur Verwaltung, wer Gutscheine ausgestellt und eingelöst hat. Wenn der Wert für die maximale Gutscheineinlösung pro Person zwischen 2 und 5 liegt, muss die Benutzer-ID angegeben werden. Geben Sie in der Regel die Login-ID des registrierten Benutzers Ihrer Website ein.	string
memo	Notes	Sie können Notizen zur Verwaltung von Gutscheineinlösungen eingeben. Geben Sie die IP-Adresse des Nutzers, die Seite und den Dienst ein, auf denen der Gutschein eingelöst wurde, sowie weitere Informationen. Wenn die maximale Anzahl der Gutscheineinlösungen pro Person unbegrenzt ist, wissen Sie nicht, wer den Gutschein eingelöst hat – verwalten Sie dann nach Benutzername oder Notiz.	string

Response

{
	"code": 0,
	"message": "",
	"result": null
}

Felder	Beschreibung	Typ
code	Antwortcode (0:Erfolg)	int
message	Die Antwortnachricht oder eine zugehörige Nachricht, wenn der Antwortcode ungleich Null ist.	string