スタンプ検証

このAPIは、スタンプの追加・削除・特典の利用を行う前に、スタンプが有効であるかを確認するために使用されます。

スタンプの有効性は以下の基準で検証されます：

  • スタンプIDXの有効性
  • スタンプの有効期間
  • スタンプの有効化状態
  • すでに特典が使用されているかどうか

このAPIはパーソナルプラン以上でご利用いただけます。

GET

/api/stamp/v1/validate?stampIdx={stampIdx} 

{
    "stampIdx": 274
}

Request Parameters

stampIdx integer required
스템프 IDX. 
{
    "code": 0,
    "message": "",
    "result": {
        "stampIdx": 16,
        "domain": "https://vvd.bz",
        "cardIdx": 1,
        "cardNm": "Accumulate 10 Americanos",
        "cardTtl": "Collect 10 stamps to get one free Americano.",
        "stamps": 10,
        "maxStamps": 12,
        "stampUrl": "https://vvd.bz/stamp/274",
        "url": "https://myshopping.com",
        "strtYmd": "2025-01-01",
        "endYmd": "2026-12-31",
        "onsiteYn": "Y",
        "onsitePwd": "123456",
        "memo": null,
        "activeYn": "Y",
        "userId": "NKkDu9X4p4mQ",
        "userNm": null,
        "userPhnno": null,
        "userEml": null,
        "userEtc1": null,
        "userEtc2": null,
        "stampImgUrl": "https://cdn.vivoldi.com/www/image/icon/stamp/icon.stamp.1.webp",
        "regYmdt": "2025-10-30 05:11:35",
        "payloadVersion": "v1"
    }
}

Response Parameters

codeinteger
レスポンスコード: 0 = 成功、それ以外 = エラー
messagestring
レスポンスメッセージ。レスポンスコードが0以外の場合、エラー内容のメッセージが返されます。
resultobject
検証に成功すると、レスポンスにスタンプ情報が含まれます。
検証に失敗した場合、レスポンス値は null となり、エラーメッセージで原因を確認できます。
stampIdx integer
スタンプIDX。
domain string
スタンプドメイン。
cardIdx integer
カードIDX。
cardNm string
カード名。
cardTtl string
カードタイトル。
stamps integer
現在までに集めたスタンプの数。
maxStamps integer
カードで設定された最大スタンプ数。
stampUrl string
スタンプページのURL。
url string
スタンプページのボタンをクリックした際に移動するURL。
strtYmd date
スタンプの有効開始日。
endYmd date
スタンプの有効期限。
onsiteYn string
Enum:
YN
店舗でのスタンプ付与を有効にするかどうかを示します。 値が Y の場合、店舗スタッフが現場でスタンプを押すことができます。
onsitePwd string
店舗スタンプ用パスワード。 現場スタンプが有効（Y）の場合、スタンプ特典利用API呼び出し時に必須です。
memo string
内部参照用メモ。
activeYn string
Enum:
YN
スタンプの有効状態を示します。 無効化されている場合、顧客はスタンプを利用できません。
userId string
ユーザーID。スタンプ発行対象者の管理に使用します。
一般的に、ウェブサイト会員のログインIDを入力します。
設定されていない場合は、システムによって自動的にユーザーIDが生成されます。
userNm string
ユーザー名。内部管理用。
userPhnno string
ユーザーの電話番号。内部管理用。
userEml string
ユーザーのメールアドレス。内部管理用。
userEtc1 string
追加の内部管理フィールド。
userEtc2 string
追加の内部管理フィールド。
stampImgUrl string
スタンプ画像のURL。
regYmdt datetime
スタンプ作成日時。例: 2025-07-21 11:50:20