Validasi Kupon

API ini digunakan untuk memverifikasi apakah kupon masih berlaku sebelum memproses “Penggunaan Kupon”.
Kupon akan diverifikasi berdasarkan kriteria berikut:

  • Validitas nomor kupon
  • Masa berlaku kupon
  • Apakah melebihi batas maksimum penggunaan per orang
  • Apakah kupon sudah digunakan

API ini tersedia mulai dari paket Personal.

Http Header
GET /api/coupon/v1/validate?cpnNo={cpnNo}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
	"cpnNo": "ZJLF0399WQBEQZJM"
}
BidangDeskripsi LapanganDeskripsiDiperlukanJenis
cpnNoCoupon number Nomor kupon yang akan divalidasi.
Jika validasi gagal, periksa pesan di respons.
string
 
Response
{
	"code": 0,
	"message": "",
	"result": {
		"cpnNo": "ZJLF0399WQBEQZJM",
		"nm": "$100 off cake coupon",
		"discTypeIdx": 457,
		"discCurrency": "USD",
		"formatDiscCurrency": "$60",
		"disc": 60.0,
		"strtYmd": "2025-01-01",
		"endYmd": "2025-12-31",
		"useLimit": 1,
		"imgUrl": "https://file.vivoldi.com/coupon/2024/11/08/lmTFkqLQdCzeBuPdONKG.webp",
		"onsiteYn": "Y",
		"onsitePwd": "123456",
		"memo": "60% off cake with coupon at the venue",
		"url": "",
		"userId": "user08",
		"userNm": "Emily",
		"userPhnno": "202-555-0173",
		"userEml": "test@gmail.com",
		"userEtc1": "",
		"userEtc2": "",
		"useCnt": 0,
		"regYmdt": "2024-11-17 17:29:25"
	}
}
BidangDeskripsiJenis
codeKode respons (0: Sukses)int
messagePesan respons, atau pesan terkait jika kode respons bukan nol.string
result
KolomDeskripsi KolomDetailTipe
cpnNoNomor Kupon-string
nmNama Kupon-string
discTypeIdxJenis Kupon457: Diskon Persentase (%), 458: Diskon Nominalint
discCurrencyMata UangKRW, CAD, JPY, CNY, EUR, GBP, IDR, MUR, RUB, SGD, USDstring
formatDiscCurrencySimbol Mata Uang-string
discDiskonNilai diskon persentase atau nominaldouble
strtYmdTanggal Mulai Berlaku-Date
endYmdTanggal Berakhir-Date
useLimitBatas Penggunaan per Orang0: Tidak terbatas, 1: 1 kali, 2: 2 kali, 3: 3 kali, 4: 4 kali, 5: 5 kaliint
imgUrlURL Gambar KuponUntuk menetapkan gambar saat membuat kupon melalui API, buat grup kupon di dasbor, unggah gambar, lalu tentukan grup saat memanggil API.string
onsiteYnKupon On-siteY: Kupon on-site, N: Bukan kupon on-siteY atau N
onsitePwdKata Sandi Kupon On-siteKata sandi yang digunakan staf toko untuk menebus kupon on-sitestring
memoCatatanInformasi tambahan yang digunakan secara internal untuk pengelolaan kuponstring
urlURL Gunakan KuponURL tujuan ketika pengguna mengklik tombol "Gunakan Kupon"string
userIdID Pengguna-string
userNmNama Pengguna-string
userPhnnoNomor Telepon-string
userEmlEmail Pengguna-string
userEtc1Informasi Lainnya 1-string
userEtc2Informasi Lainnya 2-string
useCntJumlah PenggunaanJumlah penggunaan kupon oleh penggunaint
regYmdtTanggal Pembuatan KuponContoh: 2025-07-21 11:50:20Datetime
object