API Update Kupon Online Instan

API Version

PUT

/api/coupon/v2/update

Request
Response

{
    "cpnNo": "ZJLF0399WQBEQZJM",
    "nm": "$10 discount coupon",
    "disc": 10,
    "endYmd": "2025-12-31",
    "branchIdx": 11,
    "storeIdx": 22,
    "useScope": "BRANCH",
    "useBranchIdx": 11
}

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.
branchIdx integer: IDX cabang penerbit. Jika tidak dikirim, diterbitkan oleh kantor pusat; kirim 0 untuk mengosongkannya.
Tersedia pada paket Business atau lebih tinggi.
storeIdx integer: IDX toko penerbit. Jika ditentukan, cabang tempat toko berada menjadi cabang penerbit. Mengirim cabang yang berbeda akan menghasilkan kesalahan.
useScope string: Cakupan penggunaan. Hanya ALL (semua toko) atau BRANCH (cabang tertentu) yang diizinkan. Jika tidak dikirim, nilainya ALL.
useBranchIdx integer: IDX cabang tempat penggunaan. Hanya diperlukan saat useScope = BRANCH; selalu kosong jika ALL.

{
    "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

Cabang penerbit, toko penerbit, dan cakupan penggunaan

Nilai yang ditentukan di sini adalah kebijakan yang disimpan saat penerbitan. "Di mana diterbitkan" (cabang penerbit, toko penerbit) dan "di mana pelanggan dapat menggunakannya" (cakupan penggunaan, cabang penggunaan) adalah konsep yang berbeda, sehingga parameternya terpisah.

Parameter	Arti	Deskripsi
`branchIdx`	Cabang penerbit	Jika tidak dikirim, diterbitkan kantor pusat. Kirim `0` untuk mengosongkannya ke kantor pusat.
`storeIdx`	Toko penerbit	Jika ditentukan, cabang tempat toko berada menjadi cabang penerbit. Mengirim cabang lain akan ditolak.
`useScope`	Cakupan penggunaan	`ALL` (semua toko) atau `BRANCH` (cabang tertentu). Default `ALL`.
`useBranchIdx`	Cabang penggunaan	Hanya diperlukan saat `useScope=BRANCH`. Selalu kosong jika `ALL`.

Parameter yang tidak dapat digunakan — processStoreIdx (toko pemroses) menunjuk toko tempat verifikasi, penggunaan, penambahan, atau pengurangan benar-benar terjadi, sehingga tidak dapat dipakai pada API ini. Jika dikirim, akan ditolak dengan 400 (kode kesalahan 1227).

Fitur cabang dan toko hanya tersedia pada paket Business atau lebih tinggi.

Idempotency-Key

Untuk mencoba ulang dengan aman saat respons hilang karena kesalahan jaringan, kirim nilai unik per permintaan pada header Idempotency-Key. Anda juga dapat mengirimnya sebagai requestId di body; jika keduanya dikirim dengan nilai berbeda, permintaan ditolak. Format yang diizinkan adalah 8–64 karakter berupa huruf, angka, dan . _ : -.

Jika Anda mengirim ulang permintaan yang sama dengan key yang sama, hasil pertama dikembalikan tanpa diproses ulang. Tidak ada yang diproses dua kali dan webhook tidak dikirim ulang.

Gunakan key yang sama hanya untuk percobaan ulang operasi logis yang sama. Selalu gunakan key baru untuk operasi yang berbeda. Menggunakan key yang sama dengan isi permintaan lain atau untuk operasi lain dapat ditolak dengan 409.

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.

API Pembaruan Kupon (v2)