API Pengembang

Edit Kupon

API ini digunakan untuk mengubah informasi dari kupon yang telah dibuat.
Namun, jika kupon sudah digunakan, hanya bagian "memo" yang dapat diperbarui; informasi lainnya tidak dapat diubah.

API ini tersedia mulai dari paket Personal.

Http Header

PUT /api/coupon/v1/update
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	Jenis
cpnNo	Kode Kupon	Kode kupon yang akan diperbarui. Masukkan kode tanpa tanda "-" (strip).	string
grpIdx	Grup Kupon	Grup kupon digunakan untuk mengelompokkan kupon. Jika terdapat konflik antara pengaturan grup dan kupon, maka pengaturan grup akan diutamakan. Nilai indeks grup dapat dilihat di halaman Grup Kupon di dasbor. Default: 0	int
tmplIdx	Template Kupon	Template kupon digunakan untuk menampilkan deskripsi, cara penggunaan, tujuan penggunaan, dan catatan penting kepada pengguna. Indeks template dapat dilihat di halaman Template Kupon di dasbor. Default: 0	int
nm	Nama Kupon	Nama kupon yang akan ditampilkan di halaman kupon.	string
discTypeIdx	Jenis Diskon	Menentukan jenis diskon kupon (persentase atau nominal). 457: Diskon persentase (%), 458: Diskon nominal Gunakan diskon persentase untuk potongan dalam %. Gunakan diskon nominal untuk potongan dalam jumlah tetap.	int
disc	Nilai Diskon	Jika jenis diskon adalah persentase (457), masukkan nilai antara 1% hingga 100%. Jika jenis diskon adalah nominal (458), masukkan jumlah potongan harga.	double
discCurrency	Mata Uang	Tentukan mata uang jika menggunakan diskon nominal (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Default: KRW	string
strtYmd	Tanggal Mulai Berlaku	Tentukan tanggal mulai kupon dapat digunakan. Format tanggal: yyyy-mm-dd (10 karakter) Contoh: 2024-10-01	date
endYmd	Tanggal Kedaluwarsa	Tentukan tanggal terakhir kupon dapat digunakan. Format tanggal: yyyy-mm-dd (10 karakter) Contoh: 2024-12-31	date
onsiteYn	Kupon On-site	Jika bernilai Y, tombol “Gunakan Kupon” akan muncul di halaman kupon. Pengguna menunjukkan kupon kepada staf toko, dan staf yang akan memproses penggunaannya. Cocok untuk toko fisik.	Y atau N
onsitePwd	Kata Sandi Kupon On-site	Jika kata sandi diatur, staf toko harus memasukkannya saat memproses penggunaan kupon. Pengguna tidak dapat menggunakan kupon sendiri tanpa izin.	string
memo	Catatan	Digunakan untuk keperluan manajemen internal. Tidak ditampilkan kepada pengguna.	string
url	URL	Jika URL diisi, tombol “Gunakan Kupon Sekarang” akan muncul dan mengarah ke URL tersebut. Jika ada gambar kupon, klik gambar juga akan mengarah ke URL yang sama.	string
useLimit	Batas Penggunaan per Pengguna	Menentukan berapa kali satu pengguna dapat menggunakan kupon ini. Jika nilainya 2–5, penggunaan harus dilakukan melalui REST API Vivoldi, dan user ID wajib disertakan. Jika dikelola secara manual di dasbor, hanya dapat memilih “Tanpa batas” atau “1 kali”. 0: Tanpa batas, 1: 1 kali, 2: 2 kali, 3: 3 kali, 4: 4 kali, 5: 5 kali	int
color	Warna Teks	Menentukan warna teks yang ditampilkan di halaman kupon. Harus dalam format HEX, hingga 9 karakter termasuk transparansi. Default: #4F4F4FFF	string
background	Warna Latar Belakang	Menentukan warna latar belakang kupon di halaman kupon. Harus dalam format HEX, hingga 9 karakter termasuk transparansi. Default: #FFFFFFFF	string
userId	ID Pengguna	Digunakan untuk mencatat siapa yang menerima dan menggunakan kupon. Wajib jika batas penggunaan adalah 2–5. Biasanya menggunakan ID login dari situs web Anda.	string
userNm	Nama Pengguna	Jika Anda sudah mengetahui siapa pengguna kupon, masukkan nama mereka di sini. Berguna untuk pengelolaan penerbitan dan penggunaan kupon.	string
userPhnno	Nomor Telepon Pengguna	Masukkan nomor telepon pengguna kupon.	string
userEml	Email Pengguna	Masukkan alamat email pengguna kupon.	string
userEtc1	Informasi Tambahan 1	Digunakan untuk mencatat informasi tambahan pengguna untuk keperluan internal.	string
userEtc2	Informasi Tambahan 2	Digunakan untuk mencatat informasi tambahan pengguna untuk keperluan 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