クーポンの検証
「クーポン使用」を処理する前に、そのクーポンが有効かどうかを確認するためのAPIです。
以下の項目に基づいてクーポンの有効性を検証します：
- クーポン番号の有効性
- クーポンの有効期間
- 1人あたりの最大使用回数の超過有無
- すでに使用されたクーポンかどうか
このAPIはパーソナルプランから利用できます。
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"
}| フィールド | フィールドの説明 | 説明 | 必須 | タイプ |
|---|---|---|---|---|
| cpnNo | クーポン番号 | 検証するクーポン番号。 検証に失敗した場合、Responseのmessageを確認してください。 | 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"
}
}| フィールド | 説明 | タイプ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | 応答コード (0:成功) | int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | 応答メッセージ、応答コードが0でない場合、関連メッセージが返されます。 | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| result |
| object |