Gutscheinüberprüfung

Diese API wird verwendet, um zu prüfen, ob ein Coupon vor der Nutzung gültig ist.

Die Gültigkeit des Coupons wird anhand der folgenden Kriterien überprüft:

  • Gültigkeit der Couponnummer
  • Gültigkeitszeitraum des Coupons
  • Ob das Nutzungslimit überschritten wurde
  • Ob der Coupon bereits verwendet wurde

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

GET

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

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
Coupon-Nummer. 
{
    "code": 0,
    "message": "",
    "result": {
        "cpnNo": "ZJLF0399WQBEQZJM",
        "nm": "$100 off cake coupon",
        "discTypeIdx": 457,
        "discCurrency": "USD",
        "formatDiscCurrency": "$60",
        "disc": 60.0,
        "strtYmd": "2025-01-01",
        "endYmd": "2025-12-31",
        "useLimit": 1,
        "imgUrl": "https://file.vivoldi.com/coupon/2024/11/08/lmTFkqLQdCzeBuPdONKG.webp",
        "onsiteYn": "Y",
        "onsitePwd": "123456",
        "memo": "60% off cake with coupon at the venue",
        "url": "",
        "userId": "user08",
        "userNm": "Emily",
        "userPhnno": "202-555-0173",
        "userEml": "test@gmail.com",
        "userEtc1": "",
        "userEtc2": "",
        "useCnt": 0,
        "regYmdt": "2024-11-17 17:29:25"
    }
}

Response Parameters

codeinteger
Antwortcode: 0 = Erfolgreich, jeder andere Wert = Fehler
messagestring
Antwortnachricht. Wenn der Antwortcode ungleich 0 ist, wird eine Fehlermeldung zurückgegeben.
resultobject
Bei erfolgreicher Prüfung: Die Antwort enthält die Coupon-Informationen.
Bei fehlgeschlagener Prüfung: Die Antwort ist null und kann über die Fehlermeldung eingesehen werden.
cpnNostring
Coupon-Nummer.
nmstring
Coupon-Name.
discTypeIdxinteger
Rabatt-Typ. (457: Prozent-Rabatt %, 458: Betrag-Rabatt)
discdouble
Für Prozentrabatt (457): Bereich 1–100%. Für Betragsrabatt (458): Betrag eingeben.
discCurrencystring
Währungseinheit. Erforderlich bei Betragsrabatt (discTypeIdx:458).
formatDiscCurrencystring
Währungssymbol.
strtYmddate
Startdatum der Coupon-Gültigkeit.
endYmddate
Ablaufdatum des Coupons.
useLimitinteger
Nutzungslimit für Coupons. (0: unbegrenzt, 1–5: begrenzte Nutzung)
imgUrlstring
Coupon-Bild-URL.
onsiteYnstring
Vor-Ort-Coupon. Bestimmt, ob die Schaltfläche „Coupon verwenden“ auf der Coupon-Seite angezeigt wird.
Erforderlich, wenn Coupons in einem stationären Geschäft eingelöst werden.
onsitePwdstring
Passwort für Vor-Ort-Coupons. Wird für die Einlösung benötigt.
memostring
Interne Notiz.
urlstring
Wenn eine URL eingegeben wird, erscheint auf der Coupon-Seite die Schaltfläche „Zum Coupon einlösen“.
Ein Klick auf die Schaltfläche oder das Coupon-Bild leitet zur angegebenen URL weiter.
userIdstring
Wird zur Verwaltung des Coupon-Empfängers verwendet.
Pflichtfeld, wenn die Nutzung auf 2–5 festgelegt ist.
In der Regel Login-ID oder englischer Name des Website-Mitglieds.
userNmstring
Name des Coupon-Nutzers. Nur für interne Verwaltung.
userPhnnostring
Telefonnummer des Coupon-Nutzers. Nur für interne Verwaltung.
userEmlstring
E-Mail des Coupon-Nutzers. Nur für interne Verwaltung.
userEtc1string
Zusätzliches internes Feld.
userEtc2string
Zusätzliches internes Feld.
useCntinteger
Anzahl der Coupon-Nutzungen.
regYmdtdatetime
Erstellungsdatum des Coupons. Beispiel: 2025-07-21 11:50:20