スタンプ更新API (v1)

Request Parameters

stampIdx integer required

スタンプIDX。

cardIdx integer

カードIDX。
カードIDXはダッシュボードの「スタンプカード」ページで確認できます。

stamps integer

スタンプに貯められた押印の数を指定します。
現在顧客が集めたスタンプの合計数を示します。値を変更するとスタンプの進捗が更新され、増減の両方が可能です。
すべてのスタンプが埋まった場合（stamps = カードに設定された最大スタンプ数）、useYnをYに変更して特典使用状態として処理する必要があります。

resetPinYn string

Default:N

Enum:

YN

スタンプを利用する顧客のPINコードを初期化するかどうかを指定します。
Y: 顧客が設定したPINコードを初期化します。初期化後、顧客はスタンプページにアクセスした際に新しいPINコードを再設定する必要があります。
N: 既存のPINコードを維持します。

useYn string

Default:N

Enum:

YN

スタンプの特典利用状況を指定します。
Y: 顧客がすべてのスタンプを集め、特典（例：無料ドリンク、割引など）を利用した状態です。
特典利用後、このスタンプは無効化され、新しいスタンプを発行する必要があります。
N: まだ特典を利用していない状態です。
NからYへ変更する場合は、保存されているスタンプ数がカードの最大スタンプ数に達している必要があり、 現場用パスワードが設定されたスタンプではonsitePwdを併せて送信する必要があります。

onsitePwd string

店舗で使用する従業員認証用パスワードです。
useYnをNからYに変更して特典利用として処理する場合、 スタンプがonsiteYn = Yに設定されていれば必須です。特典利用API（Redeem）と同じ検証ルールです。
スタンプ数のみを変更する場合や、パスワードが設定されていないスタンプでは省略できます。

domain string

Default:https://vvd.bz

スタンプドメイン。
値が空の場合、デフォルトドメインが使用されます。
プレミアムプラン以上では、「リンクドメイン管理」で登録されたカスタムドメインを指定できます。

strtYmd date

スタンプの有効開始日。例：2025-01-01

endYmd date

スタンプの有効期限日。例：2025-12-31
有効期限は本日から最長5年まで設定できます。

activeYn string

Default:Y

Enum:

YN

スタンプの有効状態を示します。
無効化されている場合、顧客はスタンプを使用できません。

memo string

内部参照用メモ。

userId string

ユーザーID。
スタンプ発行対象者を管理するために使用されます。
通常はウェブサイト会員のログインIDを入力します。
指定されていない場合、システムによって自動的にユーザーIDが生成されます。

userNm string

ユーザー名。内部管理用。

userPhnno string

ユーザーの連絡先。内部管理用。

userEml string

ユーザーのメールアドレス。内部管理用。

userEtc1 string

追加の内部管理用フィールド。

userEtc2 string

追加の内部管理用フィールド。