Buat Kupon

API ini menyediakan fungsi untuk membuat kupon diskon.

Untuk membuat beberapa kupon sekaligus, silakan gunakan dasbor.

Gambar kupon tidak dapat diunggah melalui API.
Jika memerlukan gambar, buat terlebih dahulu grup kupon di dasbor, unggah gambar di sana, lalu tentukan grup tersebut saat membuat kupon.

API ini tersedia mulai paket Personal ke atas.

POST

/api/coupon/v1/create 

{
    "cpnNo": "",  // If left empty, a 16-character code will be generated automatically by the system.
    "nm": "$5 discount coupon",
    "discTypeIdx": 458,
    "disc": 5,
    "discCurrency": "USD",
    "strtYmd": "2025-01-01",
    "endYmd": "2025-12-31",
    "useLimit": 1,
    "grpIdx": 271,
    "tmplIdx": 0,
    "onsiteYn": "Y",
    "onsitePwd": "123456",
    "memo": "New Member Registration, IP: 211.111.222.33",
    "url": "https://bestshop.com",
    "userId": "att78z",
    "userNm": "Brown Smith",
    "userPhnno": "+1 123-4567-8900",
    "userEml": "test@gmail.com",
    "userEtc1": "Gold rating",
    "userEtc2": ""
}

Request Parameters

cpnNostring
Nomor kupon. 8–16 karakter alfanumerik. Jika tidak diisi, sistem akan membuatnya secara otomatis. Karakter khusus tidak diperbolehkan.
Contoh: V5H8GR5T
nmstringrequired
Nama kupon.
discTypeIdxintegerrequired
Jenis diskon. (457: Persentase %, 458: Jumlah tetap)
discdoublerequired
Untuk persentase (457): kisaran 1–100%. Untuk jumlah tetap (458): masukkan nominal.
discCurrencystring
Satuan mata uang. Wajib diisi jika menggunakan diskon jumlah tetap (discTypeIdx:458).
strtYmddaterequired
Tanggal mulai berlaku kupon. Contoh: 2024-10-01
endYmddaterequired
Tanggal kadaluarsa kupon. Contoh: 2024-12-31
Tanggal kedaluwarsa hanya dapat ditetapkan hingga 31 Desember tahun berikutnya.
useLimitintegerrequired
Batas penggunaan kupon. (0: Tanpa batas, 1–5: Terbatas)
Jika diatur ke 2 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": "ZJLF0399WQBEQZJM"
}

Response Parameters

codeinteger
Kode respons: 0 = Berhasil, nilai lainnya = Error
messagestring
Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
resultstring
Nilai respons. Nomor kupon yang dibuat akan dikembalikan.
Contoh: ZJLF0399WQBEQZJM