開発者向けAPI

クーポン使用

クーポンの利用はダッシュボードから手動で処理することもできますが、
このAPIを使用すれば、ユーザーがウェブサイトでクーポンを利用する際に自動で処理でき、効率的な運用が可能です。

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

Http Header

PUT /api/coupon/v1/redeem
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en

Request

{
	"cpnNo": "ZJLF0399WQBEQZJM",
	"userId": "x77hu",
	"memo": "IP Address: 210.123.111.222, Request Page: example.com/shop/bags/p112233"
}

フィールド	フィールドの説明	説明	タイプ
cpnNo	クーポン番号	「使用完了」処理するクーポン番号。「-"記号を除くクーポン番号のみを入力してください。	string
onsitePwd	現場クーポン使用パスワード	現場クーポンを使用する際、パスワードが設定されている場合は、設定されたパスワードを入力してください。パスワードが一致しない場合、クーポンを使用できません。	string
userId	ユーザーID	誰にクーポンを発行したか、誰がクーポンを使用したかを管理するために使用されます。 1人当たりの最大クーポン使用回数が2～5の場合、ユーザーIDは必ず入力する必要があります。通常、ウェブサイトに登録した会員のログインIDを入力します。	string
memo	メモ	クーポン使用の管理上、メモを入力することができます。ユーザーのIPアドレス、クーポンを使用したページやサービス、その他の情報を入力します。 1人当たりの最大クーポン使用回数が無制限の場合、誰がクーポンを使用したかわからないので、ユーザーIDまたはメモで管理することができます。	string

Response

{
	"code": 0,
	"message": "",
	"result": null
}

フィールド	説明	タイプ
code	応答コード (0:成功)	int
message	応答メッセージ、応答コードが0でない場合、関連メッセージが返されます。	string