API Pembaruan Kupon

API Pembaruan Kupon memungkinkan Anda memperbarui detail kupon yang sudah diterbitkan.

Dengan menggunakan kode kupon (cpNo) sebagai identitas, Anda dapat mengubah jenis diskon, masa berlaku, batas penggunaan, grup, dan informasi pengguna.
Beberapa field tidak dapat diubah setelah kupon digunakan.

API ini tersedia mulai dari paket Personal.

PUT

/api/coupon/v1/update 

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

Request Parameters

cpnNostringrequired
Nomor kupon.
domain string
Domain kupon.
Tersedia di paket Premium ke atas: Anda dapat menentukan domain khusus.
webhookEnableYn string
Enum:
YN
Status penggunaan Webhook.
Webhook global harus diaktifkan.
Fitur ini hanya tersedia pada paket Enterprise.
nmstring
Nama kupon.
discTypeIdxinteger
Jenis diskon. (457: Persentase %, 458: Diskon nominal)
discdouble
Untuk persentase (457): rentang 1–100%. Untuk diskon nominal (458): masukkan jumlah.
discCurrencystring
Satuan mata uang. Wajib diisi saat menggunakan diskon nominal (discTypeIdx:458).
strtYmddate
Tanggal mulai berlaku kupon. Contoh: 2024-10-01
endYmddate
Tanggal kedaluwarsa kupon. Contoh: 2024-12-31
Tanggal kedaluwarsa hanya dapat ditetapkan hingga 31 Desember tahun berikutnya.
useLimitinteger
Batas penggunaan kupon. (0: Tanpa batas, 1–5: Jumlah penggunaan terbatas)
Jika ditetapkan 2 kali atau lebih, nilai userId wajib diisi.
grpIdxinteger
Grup kupon. Digunakan untuk mengelola kupon berdasarkan grup. IDX grup dapat dilihat di dasbor.
Jika ada pengaturan duplikat antara grup dan kupon, pengaturan grup akan diprioritaskan.
tmplIdxinteger
Template kupon. Digunakan sebagai referensi saat membuat kupon. IDX template dapat dilihat di dasbor.
onsiteYnstring
Penanda kupon di lokasi. Menampilkan tombol “Gunakan Kupon” pada halaman kupon.
Diperlukan agar staf toko offline dapat memverifikasi kupon.
onsitePwdstring
Kata sandi kupon di lokasi. Diperlukan saat kupon digunakan.
memostring
Catatan internal untuk referensi.
urlstring
Jika URL dimasukkan, tombol “Pergi Gunakan Kupon” akan muncul di halaman kupon.
Klik tombol atau gambar kupon akan mengarahkan ke URL tersebut.
colorstring
Warna teks kupon. Masukkan nilai HEX. Contoh: #4F4F4F
backgroundstring
Warna latar kupon. Masukkan nilai HEX. Contoh: #FFFFFF
userIdstring
Digunakan untuk mengelola penerima kupon.
Wajib diisi jika batas penggunaan diatur 2–5 kali. Biasanya menggunakan ID login atau nama pengguna.
userNmstring
Nama pengguna kupon. Untuk manajemen internal.
userPhnnostring
Nomor telepon pengguna kupon. Untuk manajemen internal.
userEmlstring
Email pengguna kupon. Untuk manajemen internal.
userEtc1string
Bidang tambahan untuk manajemen internal.
userEtc2string
Bidang tambahan untuk manajemen internal. 
{
    "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 saat Anda perlu mengubah kondisi kupon yang sudah diterbitkan.

Cocok untuk mengelola kampanye yang sedang berjalan, seperti memperpanjang periode promosi, menyesuaikan diskon, atau menambahkan batasan pengguna.

Karena kode kupon tidak berubah, Anda dapat memperbarui detail tanpa perlu menerbitkan ulang atau menarik kupon yang sudah dibagikan.

Cara memperpanjang masa berlaku

Untuk memperpanjang masa berlaku, masukkan tanggal baru pada parameter endYmd.
Kupon yang sudah kedaluwarsa dapat diaktifkan kembali dengan mengatur tanggal ke masa depan. Gunakan format YYYY-MM-DD.

Contoh penggunaan

  • Memperpanjang periode promosi: Ubah endYmd untuk memperpanjang masa berlaku kampanye
  • Menyesuaikan pengaturan diskon: Perbarui disc sesuai perubahan strategi
  • Menambah batas penggunaan: Tingkatkan useLimit untuk pelanggan VIP agar dapat digunakan berulang
  • Memindahkan grup kupon: Ubah grpIdx untuk memindahkan kupon ke grup lain dan menerapkan pengaturan baru
  • Targeting pengguna: Berikan diskon personal berdasarkan email atau user ID
  • Mengubah landing page: Perbarui URL kupon ke halaman promosi lain

Hal yang perlu diperhatikan

  • Jika cpNo (kode kupon) tidak valid, pembaruan akan gagal.
  • Beberapa field mungkin tidak dapat diubah jika kupon sudah digunakan.
  • Perubahan diskon dapat memengaruhi pengalaman pengguna.
  • Kupon kedaluwarsa mungkin tidak langsung aktif setelah diperbarui.
  • Untuk kupon offline, ganti password saat terjadi perubahan staf.