スタンプ検証

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

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

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

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

GET

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

{
    "stampIdx": 274
}

Request Parameters

stampIdxintegerrequired
스템프 IDX. 
{
    "code": 0,
    "message": "",
    "result": {
        "stampIdx": 16,
        "domain": "https://vvd.bz",
        "cardIdx": 1,
        "cardNm": "아메리카노 10잔 적립",
        "cardTtl": "도장을 10개 모으면 아메리카노 1잔 무료",
        "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 となり、エラーメッセージで原因を確認できます。
stampIdxinteger
スタンプIDX。
domainstring
スタンプドメイン。
cardIdxinteger
カードIDX。
cardNmstring
カード名。
cardTtlstring
カードタイトル。
stampsinteger
現在までに集めたスタンプの数。
maxStampsinteger
カードで設定された最大スタンプ数。
stampUrlstring
スタンプページのURL。
urlstring
スタンプページのボタンをクリックした際に移動するURL。
strtYmddate
スタンプの有効開始日。
endYmddate
スタンプの有効期限。
onsiteYnstring
Enum:
YN
店舗でのスタンプ付与を有効にするかどうかを示します。 値が Y の場合、店舗スタッフが現場でスタンプを押すことができます。
onsitePwdstring
店舗スタンプ用パスワード。 現場スタンプが有効（Y）の場合、スタンプ特典利用API呼び出し時に必須です。
memostring
内部参照用メモ。
activeYnstring
Enum:
YN
スタンプの有効状態を示します。 無効化されている場合、顧客はスタンプを利用できません。
userIdstring
ユーザーID。スタンプ発行対象者の管理に使用します。
一般的に、ウェブサイト会員のログインIDを入力します。
設定されていない場合は、システムによって自動的にユーザーIDが生成されます。
userNmstring
ユーザー名。内部管理用。
userPhnnostring
ユーザーの電話番号。内部管理用。
userEmlstring
ユーザーのメールアドレス。内部管理用。
userEtc1string
追加の内部管理フィールド。
userEtc2string
追加の内部管理フィールド。
stampImgUrlstring
スタンプ画像のURL。
regYmdtdatetime
スタンプ作成日時。例: 2025-07-21 11:50:20