スタンプ作成
このAPIは顧客に新しいスタンプを発行する機能を提供します。
カードIDXは必須項目です。ダッシュボードの「スタンプカード」ページで確認できます。
このAPIはパーソナルプラン以上でご利用いただけます。
POST
/api/stamp/v1/create
{
"cardIdx": 123, // You can check the IDX value on the card management page of the dashboard.
"domain": "https://vvd.bz",
"strtYmd": "2025-01-01",
"endYmd": "2025-12-31",
"activeYn": "Y",
"memo": "New Member Registration, IP: 211.111.222.33",
"userId": "att78z",
"userNm": "Brown Smith",
"userPhnno": "+1 123-4567-8900",
"userEml": "test@gmail.com",
"userEtc1": "Gold rating",
"userEtc2": ""
}
Request Parameters
- cardIdx integer required
-
カードIDX。
カードIDXはダッシュボードの「スタンプカード」ページで確認できます。 - domain string
- Default:https://vvd.bz
-
スタンプドメイン。
値が空の場合は、デフォルトドメインとして保存されます。
プレミアムプラン以上では、「リンクドメイン管理」で登録したカスタムドメインを指定できます。 - strtYmd date required
- スタンプの有効開始日。例: 2025-01-01
- endYmd date required
-
スタンプの有効期限日。例: 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
- 追加の内部管理用フィールド。
{
"code": 0,
"message": "",
"result": "ZJLF0399WQBEQZJM"
}
Response Parameters
- code integer
- 応答コード: 0 = 成功、それ以外の値 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result integer
-
レスポンス値です。
生成されたスタンプIDXが返されます。
例:1347