スタンプ編集
発行済みスタンプ情報を編集するためのAPIです。
顧客の獲得スタンプ数(stamps)、特典使用状況(useYn)、PINリセット設定(resetPinYn)などを変更できます。
このAPIはパーソナルプラン以上でご利用いただけます。
PUT
/api/stamp/v1/update
{
"stampIdx": 1457,
"cardIdx": 172,
"stamps": 7,
"resetPinYn": "Y",
"userEml": "example@gmail.com"
}Request Parameters
- stampIdxintegerrequired
- スタンプIDX。
- cardIdxinteger
- カードIDX。
カードIDXはダッシュボードの「スタンプカード」ページで確認できます。 - stampsinteger
- スタンプに貯められた押印の数を指定します。
現在顧客が集めたスタンプの合計数を示します。値を変更するとスタンプの進捗が更新され、増減の両方が可能です。
すべてのスタンプが埋まった場合(stamps= カードに設定された最大スタンプ数)、useYnをYに変更して特典使用状態として処理する必要があります。 - resetPinYnstring
- Default:N
- Enum:YN
- スタンプを利用する顧客のPINコードを初期化するかどうかを指定します。
Y: 顧客が設定したPINコードを初期化します。初期化後、顧客はスタンプページにアクセスした際に新しいPINコードを再設定する必要があります。
N: 既存のPINコードを維持します。 - useYnstring
- Default:N
- Enum:YN
- スタンプの特典利用状況を指定します。
Y: 顧客がすべてのスタンプを集め、特典(例:無料ドリンク、割引など)を利用した状態です。
特典利用後、このスタンプは無効化され、新しいスタンプを発行する必要があります。
N: まだ特典を利用していない状態です。 - domainstring
- Default:https://vvd.bz
- スタンプドメイン。
値が空の場合、デフォルトドメインが使用されます。プレミアムプラン以上では、「リンクドメイン管理」で登録されたカスタムドメインを指定できます。 - strtYmddate
- スタンプの有効開始日。例:2025-01-01
- endYmddate
- スタンプの有効期限日。例:2025-12-31
有効期限は本日から最長5年まで設定できます。 - activeYnstring
- Default:Y
- Enum:YN
- スタンプの有効状態を示します。
無効化されている場合、顧客はスタンプを使用できません。 - memostring
- 内部参照用メモ。
- userIdstring
- ユーザーID。
スタンプ発行対象者を管理するために使用されます。
通常はウェブサイト会員のログインIDを入力します。
指定されていない場合、システムによって自動的にユーザーIDが生成されます。 - userNmstring
- ユーザー名。内部管理用。
- userPhnnostring
- ユーザーの連絡先。内部管理用。
- userEmlstring
- ユーザーのメールアドレス。内部管理用。
- userEtc1string
- 追加の内部管理用フィールド。
- userEtc2string
- 追加の内部管理用フィールド。
{
"code": 0,
"message": "",
"result": null
}Response Parameters
- codeinteger
- 応答コード: 0 = 成功、それ以外の値 = エラー
- messagestring
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- resultnull