Coupon-Einlösung

Diese API setzt einen ausgestellten Coupon auf den Status „verwendet“.

Anstatt die Verarbeitung manuell im Dashboard vorzunehmen, können ausgestellte Coupons automatisch per API als verwendet markiert werden.

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

PUT

/api/coupon/v1/redeem 

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

Request Parameters

cpnNostringrequired
Coupon-Nummer.
onsitePwdstring
Passwort für Vor-Ort-Coupon. Erforderlich, wenn für den Vor-Ort-Coupon ein Passwort festgelegt ist.
userIdstring
Benutzer-ID. Identifiziert den Aussteller oder Nutzer des Coupons.
Muss angegeben werden, wenn das Nutzungslimit des Coupons auf 2–5 gesetzt ist.
memostring
Interne Notiz. Kann verwendet werden, um Benutzer-IP, Einsatzort des Coupons oder andere Informationen zu dokumentieren.
Wenn die Nutzung des Coupons unbegrenzt ist, kann dieses Feld anstelle von userId genutzt werden, um Benutzer zu unterscheiden. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Antwortcode: 0 = Erfolg, andere Werte = Fehler
messagestring
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
resultnull