クーポン編集

発行済みクーポン情報を修正するAPIです。

すでに使用されたクーポンはメモ項目のみ変更可能で、その他の情報は変更できません。

このAPIはパーソナルプラン以上で利用可能です。

PUT

/api/coupon/v1/update 

{
    "cpnNo": "ZJLF0399WQBEQZJM",
    "nm": "$10 discount coupon",
    "disc": 10,
    "endYmd": "2025-12-31"
}

Request Parameters

cpnNostringrequired
クーポン番号。
nmstring
クーポン名。
discTypeIdxinteger
割引タイプ。（457: 割引率 %, 458: 金額割引）
discdouble
割引率 (457) は 1〜100% の範囲、金額割引 (458) は金額を入力。
discCurrencystring
通貨単位。金額割引 (discTypeIdx:458) を使用する場合は必須。
strtYmddate
クーポンの有効開始日。例: 2024-10-01
endYmddate
クーポンの有効期限。例: 2024-12-31
有効期限は翌年の12月31日までしか設定できません。
useLimitinteger
クーポンの利用可能回数。(0: 無制限, 1〜5: 回数制限)
2回以上に設定する場合は、userId を必ず指定する必要があります。
grpIdxinteger
クーポングループ。 グループで管理する場合に使用します。グループIDXはダッシュボードで確認可能。
グループ設定とクーポン設定が重複する場合は、グループ設定が優先されます。
tmplIdxinteger
クーポンテンプレート。 クーポン作成時に参照するテンプレート。テンプレートIDXはダッシュボードで確認可能。
onsiteYnstring
店舗用クーポンの有無。クーポンページに 「クーポンを使用」 ボタンを表示。
オフライン店舗でスタッフが利用処理を行う際に必要。
onsitePwdstring
店舗用クーポンのパスワード。クーポン利用時に必要。
memostring
内部参照用メモ。
urlstring
URLを入力すると、クーポンページに 「クーポンを使う」 ボタンが表示されます。
ボタンまたはクーポン画像をクリックすると、そのURLにリダイレクトされます。
colorstring
クーポン文字色。HEX値で指定。例: #4F4F4F
backgroundstring
クーポン背景色。HEX値で指定。例: #FFFFFF
userIdstring
クーポン発行対象者を管理するために使用。
使用回数が2～5に設定されている場合は必須入力。通常は会員のログインIDまたは英字氏名を指定。
userNmstring
クーポン利用者名。内部管理用。
userPhnnostring
クーポン利用者の連絡先。内部管理用。
userEmlstring
クーポン利用者のメールアドレス。内部管理用。
userEtc1string
追加の内部管理用フィールド。
userEtc2string
追加の内部管理用フィールド。 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
応答コード: 0 = 成功、それ以外の値 = エラー
messagestring
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
resultnull