クーポン使用
このAPIは発行されたクーポンを使用済みとして処理します。
ダッシュボードで手動処理する代わりに、APIを通じて自動的に使用済みとして登録できます。
このAPIはパーソナルプラン以上で利用可能です。
PUT
/api/coupon/v1/redeem
{
"cpnNo": "ZJLF0399WQBEQZJM",
"userId": "x77hu",
"memo": "IP Address: 210.123.111.222, Request Page: https://example.com/shop/bags/p112233"
}
Request Parameters
- cpnNostringrequired
- クーポン番号。
- onsitePwdstring
- 現場クーポンのパスワード。 現場クーポンにパスワードが設定されている場合は必須入力です。
- userIdstring
- ユーザーID。 クーポン発行者・利用者を識別するためのID。
クーポンの利用可能回数が2~5
に設定されている場合は必ず入力してください。 - memostring
- 内部参照用メモ。 ユーザーのIP、クーポン利用先、その他の情報を記録できます。
クーポン利用回数が無制限の場合、userIdの代わりにこのメモを使ってユーザーを区別できます。
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- codeinteger
- 応答コード: 0 = 成功、それ以外の値 = エラー
- messagestring
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- resultnull