クーポン編集
このAPIは、発行済みクーポンの情報を修正するためのものです。
ただし、すでに使用されたクーポンは「メモ」項目のみ編集可能で、それ以外の情報は変更できません。
このAPIはパーソナルプランから利用できます。
Http Header
PUT /api/coupon/v1/update
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"cpnNo": "", // You can specify a coupon code manually. If left empty, a 16-character code will be generated automatically by the system.
"grpIdx": 271,
"tmplIdx": 0,
"nm": "$5 discount coupon",
"discTypeIdx": 458,
"disc": 5,
"strtYmd": "2025-01-01",
"endYmd": "2025-12-31",
"onsiteYn": "Y",
"onsitePwd": "123456",
"memo": "New Member Registration, IP: 211.111.222.33",
"url": "https://bestshop.com",
"useLimit": 1,
"userId": "att78z",
"userNm": "Brown Smith",
"userPhnno": "+1 123-4567-8900",
"userEml": "",
"userEtc1": "Gold rating",
"userEtc2": ""
}| フィールド | フィールドの説明 | 説明 | 必須 | タイプ |
|---|---|---|---|---|
| cpnNo | クーポン番号 | 情報を変更するクーポン番号です。 “-” 記号を除くクーポン番号のみを入力してください。 | string | |
| grpIdx | クーポングループ | クーポングループはクーポンの分類を管理するために使用され、グループ設定とクーポン設定が重複する場合、クーポン設定は無視されます。 グループIDXは、ダッシュボードのクーポングループページで確認できます。 デフォルト: 0 | int | |
| tmplIdx | クーポンテンプレート | クーポンテンプレートは、クーポンの説明と使用場所、使用方法、注意事項をユーザーに伝えるために使用されます。 テンプレートIDXは、ダッシュボードのクーポンテンプレートページで確認できます。 デフォルト: 0 | int | |
| nm | クーポン名 | クーポンの名前はクーポンページに表示されます。 | string | |
| discTypeIdx | 割引の種類 | クーポンの割引タイプ(料金または金額)を設定します。 457:料金割引(%), 458:金額割引 料金割引： クーポンのパーセンテージ割引を提供する場合に使用します。 金額割引：入力された金額分の割引を提供する場合に使用します。 | int | |
| disc | 割引値 | 割引タイプがレート(457)の場合、1%~100%の間の値を入力します。 割引タイプが金額(458)の場合、割引する金額を入力します。 | double | |
| discCurrency | 金額通貨 | 割引タイプが金額(458)の場合、通貨単位を設定することができます。 KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD デフォルト: KRW | string | |
| strtYmd | 有効期間開始日 | クーポンをいつから使用できるのか、有効期間の開始日を設定します。 yyyy-mm-ddの日付形式で10桁の値。 はい： 2024-10-01 | date | |
| endYmd | 有効期限満了日 | クーポンをいつまで使用できるのか、有効期限を設定します。 yyyy-mm-ddの日付形式で10桁の値。 はい： 2024-12-31 | date | |
| onsiteYn | 現場クーポンの有無 | この値がYの場合、クーポンページでクーポンを使用できるボタンが表示されます。 ユーザーがクーポンを店員に見せると、店員がクーポンを使うという仕組みです。オフライン店舗を運営している場合、便利な機能です。 | Y or N | |
| onsitePwd | 現場クーポン使用パスワード | パスワードを設定すると、店舗のスタッフがクーポンを使用処理する際、設定されたパスワードを入力する必要があります。 ユーザーが任意にクーポンを使用処理することはできません。 | string | |
| memo | 메모 | クーポンを管理する内部用途に使用することができます。 メモはユーザーに公開されません。 | string | |
| url | URL | URLを入力すると、クーポンページにクーポンを使うボタンが表示され、クリックすると入力したURLに移動します。 クーポン画像がアップロードされている場合は、画像をクリックしてもURLに移動します。 | string | |
| useLimit | 1人あたりの最大クーポン使用回数 | クーポンを最大何回まで使用できるかを回数を設定します。 1人当たりのクーポン使用回数「2回～5回」までは、Vivoldiが提供するREST APIを利用してクーポン使用処理をする際に必要です。 この時、ユーザーIDの値は必ず入力する必要があります。 クーポン使用をダッシュボードで手動で管理する場合は、「無制限」、「1回」のうち1つだけ選択することができます。 「無制限」を選択すると、誰でも回数制限なくクーポンを使用することができます。 0:無制限、1:1回限定、2:2回限定、3:3回限定、4:4回限定、5:5回限定 | int | |
| color | 文字色 | クーポンページでクーポン文字の色を設定します。 HEX値で入力する必要があり、透明度を含めて最大9桁まで入力できます。 デフォルト値: #4F4F4FFF | string | |
| background | 背景色 | クーポンページでクーポンの背景色を設定します。 HEX値で入力する必要があり、透明度を含めて最大9桁まで入力できます。 デフォルト値: #FFFFFFFF | string | |
| userId | ユーザーID | 誰にクーポンを発行したか、誰がクーポンを使用したかを管理するために使用されます。 1人当たりの最大クーポン使用回数が2～5の場合、ユーザーIDは必ず入力する必要があります。 通常、ウェブサイトに登録した会員のログインIDを入力します。 | string | |
| userNm | ユーザー名 | 誰にクーポンを発行するかがすでにわかっている場合は、クーポンを使用するユーザーの名前を入力します。 クーポンの発行や使用処理の管理を行う際に必要です。 | string | |
| userPhnno | ユーザー連絡先 | クーポンを使用するユーザーの連絡先を設定します。 | string | |
| userEml | ユーザーメール | クーポンを使用するユーザーのメールアドレスを設定します。 | string | |
| userEtc1 | ユーザーその他の情報1 | 内部管理用にユーザーの追加情報を設定します。 | string | |
| userEtc2 | ユーザーその他の情報2 | 内部管理用にユーザーの追加情報を設定します。 | string |
Response
{
"code": 0,
"message": "",
"result": "ZJLF0399WQBEQZJM"
}
| フィールド | 説明 | タイプ |
|---|---|---|
| code | 応答コード (0:成功) | int |
| message | 応答メッセージ、応答コードが0でない場合、関連メッセージが返されます。 | string |