쿠폰 검증

“쿠폰 사용” 처리를 하기 전에 해당 쿠폰이 유효한지 확인하는 데 사용되는 API입니다.
다음 항목들을 기준으로 쿠폰의 유효성을 검증합니다:

  • 쿠폰 번호의 유효성
  • 쿠폰 유효기간
  • 1인당 최대 사용 가능 횟수 초과 여부
  • 이미 사용된 쿠폰인지 여부

이 API는 퍼스널 요금제부터 사용할 수 있습니다.

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"
}
필드필드 설명설명필수유형
cpnNo쿠폰 번호 검증할 쿠폰 번호.
검증에 실패할 경우, Response의 message를 확인하세요.
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"
	}
}
필드설명유형
code응답 코드 (0:성공)int
message응답 메시지, 응답 코드가 0이 아닐 경우 관련 메시지가 리턴됨.string
result
필드필드 설명설명유형
cpnNo쿠폰 번호-string
nm쿠폰명-string
discTypeIdx쿠폰 유형457:요율 할인(%), 458:금액 할인int
discCurrency화페 단위KRW, CAD, JPY, CNY, EUR, GBP, IDR, MUR, RUB, SGD, USDstring
formatDiscCurrency화폐 통화 기호-string
disc할인요율 할인 또는 금액 할인 값double
strtYmd유효기간 시작날짜-Date
endYmd유효기간 종료날짜-Date
useLimit1인당 최대 쿠폰 사용 횟수 제한0:무제한, 1:1회 사용, 2:2회 사용, 3:3회 사용, 4:4회 사용, 5:5회 사용int
imgUrl쿠폰 이미지 URLAPI를 이용하여 쿠폰을 생성할 때 쿠폰 이미지를 설정하려면 대시보드에서 쿠폰 그룹을 생성하여 이미지를 업로드하고 쿠폰 생성 API를 호출할 때 그룹을 지정하세요.string
onsiteYn현재 쿠폰 여부Y:현장 쿠폰, N: 현장 쿠폰 아님Y or N
onsitePwd현장 쿠폰 비밀번호매장 직원이 현장 쿠폰을 사용처리할 때 비밀번호string
memo메모쿠폰을 관리할 때 내부적으로 사용되는 부가 정보string
url쿠폰 사용하기 URL쿠폰 페이지에서 쿠폰 사용하러 가기 버튼 클릭 시 이동될 URLstring
userId사용자 ID-string
userNm사용자 이름-string
userPhnno사용자 전화번호-string
userEml사용자 이메일-string
userEtc1사용자 기타 정보1-string
userEtc2사용자 기타 정보2-string
useCnt쿠폰 사용 횟수사용자가 쿠폰을 사용한 횟수int
regYmdt쿠폰 생성 날짜예: 2025-07-21 11:50:20Datetime
object