Gutscheinüberprüfung
Diese API dient dazu, die Gültigkeit eines Coupons zu überprüfen, bevor „Coupon-Einlösung“ durchgeführt wird.
Die Gültigkeit wird anhand der folgenden Kriterien überprüft:
- Gültigkeit der Coupon-Nummer
- Gültigkeitszeitraum des Coupons
- Überschreitung der maximalen Nutzungsanzahl pro Person
- Ob der Coupon bereits verwendet wurde
Diese API ist ab dem Personal-Tarif verfügbar.
Http Header
GET /api/coupon/v1/validate?cpnNo={cpnNo}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"cpnNo": "ZJLF0399WQBEQZJM"
}| Felder | Feldbeschreibungen | Beschreibung | Erforderlich | Typ |
|---|---|---|---|---|
| cpnNo | Coupon number | Die zu validierende Gutscheinnummer. Wenn die Validierung fehlschlägt, überprüfen Sie die Nachricht in der Antwort. | string |
Response
{
"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"
}
}| Felder | Beschreibung | Typ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Antwortcode (0:Erfolg) | int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | Die Antwortnachricht oder eine zugehörige Nachricht, wenn der Antwortcode ungleich Null ist. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| result |
| object |