Edit Kupon

API untuk memperbarui informasi kupon yang sudah dibuat.

Untuk kupon yang sudah digunakan, hanya kolom catatan yang bisa diperbarui; detail lain tidak dapat diubah.

API ini tersedia untuk paket Personal ke atas.

PUT

/api/coupon/v1/update

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

Request Parameters

cpnNostringrequired
Nomor kupon.
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

codeinteger
Kode respons: 0 = Berhasil, nilai lainnya = Error
messagestring
Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
resultnull