API zum Löschen von Gutscheinen

Die Vivoldi Coupon Delete API ermöglicht es, bereits ausgestellte Gutscheine dauerhaft zu löschen.

Nach dem Löschen wird der Gutschein sofort ungültig und alle weiteren Einlösungsversuche werden blockiert.
Zum gleichzeitigen Löschen mehrerer Gutscheine verwenden Sie das Dashboard.

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

DELETE

/api/coupon/v1/delete?cpnNo={cpnNo} 


DELETE /api/coupon/v1/delete
        ?cpnNo=ZJLF0399WQBEQZJM

Request Parameters

cpnNostringrequired
Coupon-Nummer. 
{
    "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 in folgenden Fällen:

  • Sofortiges Sperren falsch ausgestellter Gutscheine
  • Bereinigung von Gutscheinen nach Kampagnenende
  • Entfernung von doppelten oder Test-Gutscheinen
  • Deaktivierung von Gutscheinen mit Missbrauchsrisiko

In Produktionsumgebungen wird sie in der Regel zur Risikokontrolle eingesetzt und nicht nur zur einfachen Bereinigung.

Unterschied zwischen Löschen und Ablauf

Es gibt zwei Möglichkeiten, die Nutzung eines Gutscheins zu verhindern.

Wird endYmd (Ablaufdatum) auf ein vergangenes Datum gesetzt, gilt der Gutschein als abgelaufen, bleibt aber gespeichert und kann später wieder aktiviert werden.
Beim Aufruf der Delete API wird der Gutschein hingegen dauerhaft gelöscht und kann nicht wiederhergestellt werden.

Für eine temporäre Deaktivierung wird empfohlen, die Gültigkeit über die Update API anzupassen, anstatt den Gutschein zu löschen.

Anwendungsfälle

  • Bereinigung nach Kampagnen: Entfernen Sie nicht mehr benötigte Gutscheine nach Kampagnenende
  • Fehlerhafte Gutscheine löschen: Löschen Sie sofort falsch erstellte oder zu Testzwecken generierte Gutscheine
  • Geleakte Gutscheine sperren: Wenn ein Code bekannt wird, verhindern Sie dessen Nutzung durch sofortiges Löschen

Auch nach dem Löschen kann derselbe Gutscheincode erneut verwendet werden.

Wichtige Hinweise

Das Löschen ist endgültig. Prüfen Sie vorab:

  • Stellen Sie sicher, dass der Gutschein nicht in einer aktiven Kampagne verwendet wird.
  • Bereits ausgegebene Gutscheine führen nach dem Löschen zu Fehlern bei der Nutzung.
  • Analysedaten können ebenfalls gelöscht werden. Sichern Sie diese bei Bedarf vorher.