クーポン削除API

Vivoldiのクーポン削除APIは、発行済みクーポンを完全に削除するための機能です。

削除されたクーポンは即時に無効となり、その後の利用はすべてブロックされます。
複数のクーポンを一括で削除する場合は、ダッシュボードをご利用ください。

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

DELETE

/api/coupon/v1/delete?cpnNo={cpnNo} 


DELETE /api/coupon/v1/delete
        ?cpnNo=ZJLF0399WQBEQZJM

Request Parameters

cpnNostringrequired
クーポン番号。 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

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

このAPIを利用する場面

次のような場面で利用します。

  • 誤って発行されたクーポンを即時に無効化したい場合
  • キャンペーン終了後にクーポンを整理する場合
  • 重複やテスト用のクーポンを削除する場合
  • 不正利用の可能性があるクーポンを無効化する場合

本番環境では、単なる削除ではなくリスク管理の目的で利用されることが一般的です。

削除と有効期限の違い

クーポンの利用を停止する方法は2つあります。

endYmd（有効期限）を過去の日付に設定するとクーポンは期限切れになりますが、データは保持され、後から再度有効化できます。
一方、削除APIを実行するとクーポンデータは完全に削除され、復元できません。

一時的に無効化したい場合は、削除ではなく更新APIで有効期限を調整することを推奨します。

活用例

  • イベント終了後の整理：イベント終了後に不要なクーポンを削除し、管理リストを整理
  • 誤作成クーポンの削除：入力ミスやテスト用、設定不備で発行されたクーポンを即時削除
  • 流出クーポンの遮断：クーポンコードが外部に漏れた場合、削除APIで即時利用を停止

削除後でも同じクーポンコードを再利用して新規作成することが可能です。

利用時の注意点

削除は取り消せないため、実行前に以下を確認してください。

  • 対象クーポンが現在進行中のキャンペーンで使用されていないことを確認してください。
  • すでに配布されたクーポンを削除すると、利用時にエラーが発生します。
  • 削除により統計データも失われる可能性があります。必要な場合は事前に保存してください。