API zur Aktualisierung von Gutscheinen

Die Coupon Update API ermöglicht es, Daten bereits erstellter Gutscheine zu ändern.

Mithilfe des Gutscheincodes (cpNo) als Identifikator können Rabattart, Ablaufdatum, Nutzungslimits, Gruppe und Benutzerdaten aktualisiert werden.
Einige Felder können nach der Einlösung nicht mehr geändert werden.

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

PUT

/api/coupon/v1/update 

{
    "cpnNo": "ZJLF0399WQBEQZJM",
    "nm": "$10 discount coupon",
    "disc": 10,
    "endYmd": "2025-12-31"
}

Request Parameters

cpnNostringrequired
Coupon-Nummer.
domain string
Coupon-Domain.
In Premium-Tarifen und höher verfügbar: Sie können eine benutzerdefinierte Domain angeben.
webhookEnableYn string
Enum:
YN
Einstellung für die Webhook-Nutzung.
Der globale Webhook muss aktiviert sein.
Diese Funktion ist nur im Enterprise-Tarif verfügbar.
nmstring
Coupon-Name.
discTypeIdxinteger
Rabatt-Typ. (457: Prozentsatz %, 458: Fester Betrag)
discdouble
Für Prozentsatz (457): Bereich 1–100 %. Für festen Betrag (458): Betrag eingeben.
discCurrencystring
Währungseinheit. Erforderlich bei Verwendung eines festen Betragsrabattes (discTypeIdx:458).
strtYmddate
Startdatum der Coupon-Gültigkeit. Beispiel: 2024-10-01
endYmddate
Ablaufdatum des Coupons. Beispiel: 2024-12-31
Das Ablaufdatum kann nur bis zum 31. Dezember des folgenden Jahres festgelegt werden.
useLimitinteger
Nutzungsbeschränkung des Coupons. (0: Unbegrenzt, 1–5: Begrenzte Nutzung)
Wenn auf 2 oder mehr festgelegt, muss der Wert userId angegeben werden.
grpIdxinteger
Coupon-Gruppe. Wird verwendet, um Coupons in Gruppen zu verwalten. Die Gruppen-ID (IDX) kann im Dashboard eingesehen werden.
Wenn Gruppeneinstellungen und Coupon-Einstellungen überschneiden, haben die Gruppeneinstellungen Vorrang.
tmplIdxinteger
Coupon-Vorlage. Wird beim Erstellen eines Coupons als Referenz verwendet. Die Vorlagen-ID (IDX) kann im Dashboard eingesehen werden.
onsiteYnstring
Vor-Ort-Coupon. Zeigt die Schaltfläche „Coupon einlösen“ auf der Coupon-Seite an.
Erforderlich, wenn Mitarbeiter in einem Offline-Shop den Coupon einlösen.
onsitePwdstring
Passwort für Vor-Ort-Coupon. Erforderlich bei der Nutzung des Coupons.
memostring
Interne Notiz für Referenzzwecke.
urlstring
Wenn eine URL eingegeben wird, erscheint auf der Coupon-Seite eine Schaltfläche „Zum Einlösen gehen“.
Beim Klicken auf die Schaltfläche oder das Bild wird auf die URL weitergeleitet.
colorstring
Schriftfarbe des Coupons. HEX-Wert eingeben. Beispiel: #4F4F4F
backgroundstring
Hintergrundfarbe des Coupons. HEX-Wert eingeben. Beispiel: #FFFFFF
userIdstring
Wird verwendet, um den Empfänger des Coupons zu verwalten.
Pflichtfeld, wenn die Nutzungsbeschränkung auf 2–5 festgelegt ist. Normalerweise die Login-ID oder der Name des Benutzers.
userNmstring
Name des Coupon-Nutzers. Für interne Verwaltung.
userPhnnostring
Telefonnummer des Coupon-Nutzers. Für interne Verwaltung.
userEmlstring
E-Mail des Coupon-Nutzers. Für interne Verwaltung.
userEtc1string
Zusätzliches internes Verwaltungsfeld.
userEtc2string
Zusätzliches internes Verwaltungsfeld. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Antwortcode: 0 = Erfolg, andere Werte = Fehler
message string
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
result null

Wann diese API verwenden

Verwenden Sie diese API, wenn Sie die Bedingungen bereits ausgestellter Gutscheine ändern möchten.

Sie eignet sich zur Verwaltung laufender Kampagnen, z. B. zur Verlängerung von Aktionszeiträumen, zur Anpassung von Rabatten oder zum Hinzufügen von Nutzerbeschränkungen.

Da der Gutscheincode unverändert bleibt, können Sie Bedingungen aktualisieren, ohne bereits verteilte Gutscheine neu auszustellen oder zurückzuziehen.

Ablaufdatum verlängern

Um das Ablaufdatum zu verlängern, setzen Sie einen neuen Wert im Parameter endYmd.
Abgelaufene Gutscheine können durch ein zukünftiges Datum wieder aktiviert werden. Verwenden Sie das Format YYYY-MM-DD.

Anwendungsfälle

  • Verlängerung von Aktionen: Aktualisieren Sie endYmd, um die Gültigkeit einer Kampagne zu verlängern
  • Anpassung von Rabatten: Ändern Sie disc entsprechend Ihrer Strategie
  • Erhöhung der Nutzungslimits: Erhöhen Sie useLimit für VIP-Kunden zur mehrfachen Nutzung
  • Neuzuweisung von Gruppen: Ändern Sie grpIdx, um den Gutschein in eine andere Gruppe zu verschieben
  • Zielgruppenspezifische Angebote: Personalisierte Rabatte basierend auf E-Mail oder Benutzer-ID
  • Änderung der Zielseite: Aktualisieren Sie die Ziel-URL des Gutscheins

Wichtige Hinweise

  • Wenn cpNo (Gutscheincode) ungültig ist, schlägt die Aktualisierung fehl.
  • Einige Felder können nach der Nutzung eingeschränkt sein.
  • Änderungen am Rabatt können die Nutzererfahrung beeinflussen.
  • Abgelaufene Gutscheine sind möglicherweise nicht sofort wieder nutzbar.
  • Bei Vor-Ort-Gutscheinen sollte das Passwort bei Personalwechsel aktualisiert werden.