Buat Kupon
API ini memungkinkan Anda membuat kupon diskon.
Untuk membuat beberapa kupon sekaligus, Anda harus menggunakan dasbor.
API tidak mendukung unggah gambar kupon.
Jika Anda memerlukan gambar, buat dulu grup kupon di dasbor dan unggah gambar di sana, lalu tentukan grup tersebut saat membuat kupon.
Jika grup kupon ditentukan, beberapa pengaturan kupon akan diabaikan dan pengaturan dari grup akan digunakan.
API ini tersedia mulai dari paket Personal.
Http Header
POST /api/coupon/v1/create
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"cpnNo": "", // You can specify a coupon code manually. If left empty, a 16-character code will be generated automatically by the system.
"grpIdx": 271,
"tmplIdx": 0,
"nm": "$5 discount coupon",
"discTypeIdx": 458,
"disc": 5,
"strtYmd": "2025-01-01",
"endYmd": "2025-12-31",
"onsiteYn": "Y",
"onsitePwd": "123456",
"memo": "New Member Registration, IP: 211.111.222.33",
"url": "https://bestshop.com",
"useLimit": 1,
"userId": "att78z",
"userNm": "Brown Smith",
"userPhnno": "+1 123-4567-8900",
"userEml": "",
"userEtc1": "Gold rating",
"userEtc2": ""
}| Bidang | Deskripsi Lapangan | Deskripsi | Diperlukan | Jenis |
|---|---|---|---|---|
| cpnNo | Nomor kupon 8~16 digit yang terdiri dari huruf kapital dan angka. Karakter khusus tidak diperbolehkan. Jika nilai ini kosong, nomor kupon akan dibuat otomatis oleh sistem. | string | ||
| grpIdx | Grup kupon digunakan untuk mengelola kategori kupon. Jika pengaturan grup dan pengaturan kupon bertabrakan, pengaturan kupon akan diabaikan. Anda bisa melihat grup IDX pada halaman grup kupon di dashboard. Nilai default: 0 | int | ||
| tmplIdx | Template kupon digunakan untuk mendeskripsikan kegunaan kupon, cara pakai, dan ketentuan lainnya. Template IDX dapat ditemukan di halaman template kupon pada dashboard. Nilai default: 0 | int | ||
| nm | Nama kupon akan ditampilkan di halaman kupon. | string | ||
| discTypeIdx | Tentukan jenis diskon (persen atau nominal) untuk kupon. 457: Diskon persen (%), 458: Diskon nominal. Diskon persen: digunakan untuk diskon dalam bentuk persen. Diskon nominal: digunakan untuk diskon dalam jumlah tertentu. | int | ||
| disc | Masukkan nilai antara 1% dan 100% jika diskon berupa persen (457). Masukkan jumlah diskon jika tipenya nominal (458). | double | ||
| discCurrency | Anda dapat memilih satuan mata uang jika menggunakan diskon nominal (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Nilai default: KRW | string | ||
| strtYmd | Tentukan tanggal mulai masa berlaku kupon. Masukkan 10 digit dengan format yyyy-mm-dd. Contoh: 2024-10-01 | date | ||
| endYmd | Tentukan tanggal berakhirnya masa berlaku kupon. Masukkan 10 digit dengan format yyyy-mm-dd. Contoh: 2024-12-31 | date | ||
| onsiteYn | Jika nilai ini Y, halaman kupon akan menampilkan tombol untuk menukarkan kupon di tempat. Pengguna menunjukkan kupon ke staf toko untuk ditukarkan. Fitur ini berguna untuk toko fisik. Nilai default: N | Y or N | ||
| onsitePwd | Jika Anda mengatur kata sandi, staf toko harus memasukkannya saat memproses penukaran kupon. Pengguna tidak bisa menukarkan kupon sendiri. | string | ||
| memo | Dapat digunakan untuk keperluan internal dalam pengelolaan kupon. Catatan ini tidak terlihat oleh pengguna. | string | ||
| url | Setelah Anda memasukkan URL, halaman kupon akan menampilkan tombol “Tukar kupon” yang akan mengarahkan ke URL tersebut. Jika gambar kupon diunggah, mengklik gambar juga akan membuka URL itu. | string | ||
| useLimit | Tentukan batas maksimum penukaran kupon per orang. Pada penggunaan REST API Vivoldi, jumlah penukaran harus antara 2 hingga 5 dan memerlukan user ID. Saat mengelola manual melalui dashboard, hanya bisa memilih “Tidak terbatas” atau “1 kali”. Jika memilih “Tidak terbatas”, siapa pun dapat menukarkan kupon tanpa batas. 0: Tidak terbatas, 1: 1 kali, 2: 2 kali, 3: 3 kali, 4: 4 kali, 5: 5 kali | int | ||
| color | Tentukan warna teks kupon pada halaman kupon. Harus dimasukkan dalam format HEX hingga 9 digit (termasuk transparansi). Nilai default: #4F4F4FFF | string | ||
| background | Atur warna latar belakang kupon pada halaman kupon. Harus dalam format HEX hingga 9 digit (termasuk transparansi). Nilai default: #FFFFFFFF | string | ||
| userId | Digunakan untuk mengelola siapa yang menerbitkan dan menukarkan kupon. Jika batas penukaran per orang antara 2-5, user ID wajib diisi. Biasanya, masukkan ID login anggota yang terdaftar di situs Anda. | string | ||
| userNm | Jika sudah tahu siapa yang akan menerima kupon, masukkan nama pengguna di sini. Ini digunakan untuk mengelola penerbitan dan penukaran kupon. | string | ||
| userPhnno | Masukkan nomor kontak pengguna yang akan menukarkan kupon. | string | ||
| userEml | Masukkan email pengguna yang akan menukarkan kupon. | string | ||
| userEtc1 | Masukkan informasi tambahan pengguna untuk keperluan administrasi internal. | string | ||
| userEtc2 | Masukkan informasi tambahan pengguna untuk keperluan administrasi internal. | string |
Response
{
"code": 0,
"message": "",
"result": "ZJLF0399WQBEQZJM"
}
| Bidang | Deskripsi | Jenis |
|---|---|---|
| code | Kode respons (0: Sukses) | int |
| message | Pesan respons, atau pesan terkait jika kode respons bukan nol. | string |
| result | Nilai respons (Nomor kupon) | string |