API Penghapusan Kupon

API Penghapusan Kupon Vivoldi memungkinkan Anda menghapus kupon yang sudah diterbitkan secara permanen.

Setelah dihapus, kupon langsung menjadi tidak valid dan semua percobaan penggunaan akan ditolak.
Untuk menghapus beberapa kupon sekaligus, gunakan dashboard.

API ini tersedia mulai dari paket Personal.

DELETE

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


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

Request Parameters

cpnNostringrequired
Nomor kupon. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Kode respons: 0 = Berhasil, nilai lainnya = Error
message string
Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
result null

Kapan menggunakan API ini

Gunakan API ini dalam situasi berikut:

  • Memblokir kupon yang salah diterbitkan secara langsung
  • Membersihkan kupon setelah kampanye selesai
  • Menghapus kupon duplikat atau untuk pengujian
  • Menonaktifkan kupon yang berpotensi disalahgunakan

Dalam lingkungan produksi, API ini umumnya digunakan untuk pengendalian risiko, bukan sekadar pembersihan.

Perbedaan antara penghapusan dan kedaluwarsa

Terdapat dua cara untuk menghentikan penggunaan kupon.

Jika endYmd (tanggal kedaluwarsa) diatur ke tanggal lampau, kupon akan menjadi kedaluwarsa tetapi data tetap tersimpan dan dapat diaktifkan kembali dengan memperpanjang tanggal.
Sebaliknya, jika menggunakan API penghapusan, data kupon akan dihapus secara permanen dan tidak dapat dipulihkan.

Jika hanya ingin menonaktifkan sementara, disarankan menggunakan API pembaruan untuk mengatur masa berlaku, bukan menghapusnya.

Contoh penggunaan

  • Pembersihan setelah kampanye: Hapus kupon yang tidak lagi diperlukan setelah event selesai untuk menjaga daftar tetap rapi
  • Menghapus kupon tidak valid: Hapus segera kupon yang dibuat karena kesalahan, untuk testing, atau dengan konfigurasi yang salah
  • Memblokir kupon bocor: Jika kode kupon tersebar, gunakan API untuk segera mencegah penggunaannya

Setelah dihapus, kode kupon yang sama tetap dapat digunakan kembali untuk membuat kupon baru.

Hal yang perlu diperhatikan

Penghapusan tidak dapat dibatalkan. Pastikan hal berikut sebelum melanjutkan:

  • Pastikan kupon tidak sedang digunakan dalam kampanye aktif.
  • Jika kupon yang sudah dibagikan dihapus, pengguna akan mengalami error saat mencoba menggunakannya.
  • Data analitik dapat ikut terhapus. Simpan riwayat klik atau penggunaan jika diperlukan.