クーポンの検証

このAPIは、クーポンを使用処理する前に有効かどうかを確認するために使用されます。

クーポンの有効性は次の基準で検証されます：

  • クーポン番号の有効性
  • クーポンの有効期間
  • 使用可能回数を超えていないか
  • すでに使用済みかどうか

このAPIはパーソナルプラン以上で利用可能です。

GET

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

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
クーポン番号。 
{
    "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
レスポンスコード: 0 = 成功、それ以外 = エラー
messagestring
レスポンスメッセージ。レスポンスコードが0以外の場合、エラー内容のメッセージが返されます。
resultobject
検証成功時: 応答にはクーポン情報が返されます。
検証失敗時: 応答はnullとなり、エラーメッセージで確認できます。
cpnNostring
クーポン番号。
nmstring
クーポン名。
discTypeIdxinteger
割引タイプ。（457: 割引率 %, 458: 金額割引）
discdouble
割引率（457）の場合: 1〜100%の範囲。金額割引（458）の場合: 金額を入力。
discCurrencystring
通貨単位。金額割引（discTypeIdx:458）を使用する場合は必須。
formatDiscCurrencystring
通貨記号。
strtYmddate
クーポン有効開始日。
endYmddate
クーポン有効期限日。
useLimitinteger
クーポン利用可能回数。（0: 無制限、1〜5: 制限回数）
imgUrlstring
クーポン画像URL。
onsiteYnstring
店舗用クーポンの有無。クーポンページに 「クーポンを使用」ボタン を表示するかどうか。
オフライン店舗でスタッフがクーポンを処理する際に必要。
onsitePwdstring
店舗用クーポンのパスワード。 クーポン利用時に必要なパスワード。
memostring
内部参照用メモ。
urlstring
URLを入力すると、クーポンページに 「クーポンを使いに行く」ボタン が表示されます。
ボタンまたはクーポン画像をクリックすると、そのURLにリダイレクトされます。
userIdstring
クーポン発行対象者の管理に使用。
クーポン利用可能回数が2〜5に設定されている場合は必須。
一般的にはウェブサイト会員のログインIDまたは英字の名前を入力。
userNmstring
クーポン利用者名。内部管理用。
userPhnnostring
クーポン利用者の連絡先。内部管理用。
userEmlstring
クーポン利用者のメールアドレス。内部管理用。
userEtc1string
内部追加管理用フィールド。
userEtc2string
内部追加管理用フィールド。
useCntinteger
クーポン利用回数。
regYmdtdatetime
クーポン作成日時。例: 2025-07-21 11:50:20