クーポン更新API

クーポン更新APIは、発行済みクーポンの情報を変更するための機能です。

クーポンコード（cpNo）を識別子として、割引タイプ、有効期限、利用回数制限、グループ、ユーザー情報などを更新できます。
ただし、すでに利用済みのクーポンは一部の項目を変更できません。

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

PUT

/api/coupon/v1/update 

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

Request Parameters

cpnNostringrequired
クーポン番号。
domain string
クーポンドメイン。
プレミアムプラン以上では、カスタムドメインを指定できます。
webhookEnableYn string
Enum:
YN
Webhook の有効化設定。
グローバル Webhook が有効になっている必要があります。
この機能はエンタープライズプランでのみ利用可能です。
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

code integer
応答コード: 0 = 成功、それ以外の値 = エラー
message string
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
result null

このAPIを利用する場面

すでに発行されたクーポンの条件を変更したい場合に利用します。

プロモーション期間の延長、割引内容の調整、特定ユーザーへの制限追加など、運用中のキャンペーン管理に適しています。

クーポンコードを変更せずに内容のみ更新できるため、配布済みクーポンを回収することなく条件を変更できます。

有効期限の延長方法

endYmdパラメータに新しい終了日を指定することで、有効期限を延長できます。
期限切れのクーポンも、終了日を未来の日付に更新することで再度利用可能になります。日付形式はYYYY-MM-DDを使用してください。

活用例

  • プロモーション期間の延長：endYmdを更新してキャンペーンの有効期間を延長
  • 割引設定の調整：マーケティング方針の変更に合わせてdiscを変更
  • 利用回数の拡張：VIPユーザー向けにuseLimitを増やし、同一クーポンの繰り返し利用を可能に
  • クーポングループの再設定：grpIdxを変更して別グループへ移動し、新しい画像やWebhook設定を適用
  • ユーザーターゲティング：メールアドレスやユーザーIDに基づくパーソナライズ割引を提供
  • ランディングページの変更：クーポンの遷移先URLを別のプロモーションページに更新

利用時の注意点

  • cpNo（クーポンコード）が無効な場合、更新は失敗します。
  • すでに利用済みのクーポンは、一部項目の変更が制限される場合があります。
  • 割引内容の変更は既存ユーザー体験に影響を与える可能性があります。
  • 期限切れのクーポンは、更新後もすぐに利用可能にならない場合があります。
  • 店舗用クーポンのパスワードは、スタッフ変更時に必ず更新してください。