スタンプ更新API (v2)

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へ変更する場合は、保存されているスタンプ数がカードの最大スタンプ数に達している必要があり、 現場用パスワードが設定されたスタンプではonsiteTokenを併せて送信する必要があります。

onsiteToken string

現場処理用の短期交換トークン。v2はパスワードの平文(onsitePwd)を受け付けません。
スタンプにonsiteYn = Yが設定されている場合、検証API(Validate)の応答にあるonsiteTokenを そのまま送信してください。
トークンを使うリクエストにはIdempotency-Keyが必須です。同じkeyの再試行は最初の結果を そのまま再生し、別のkeyで同じトークンを使うと400(エラーコード1228)で拒否されます。
検証で処理店舗を指定した場合、このリクエストの処理店舗も同じでなければなりません。

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

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

branchIdx integer

発行支店IDX。省略した場合は本社発行となり、0を送ると本社に戻します。
ビジネスプラン以上でご利用いただけます。

storeIdx integer

発行店舗IDX。指定すると、その店舗が属する支店が発行支店になります。異なる支店を一緒に送るとエラーになります。

useScope string

利用可能範囲。ALL(すべての店舗)またはBRANCH(特定の支店)のみ指定できます。省略時はALLです。

useBranchIdx integer

利用可能支店IDX。useScope = BRANCHの場合のみ必要で、ALLのときは常に空です。