홈
서비스 소개
개발자 API
가격 · 요금제
온라인 쿠폰
웹푸시 소개

쿠폰 생성

이 API는 할인 쿠폰을 생성하는 기능을 제공합니다.
여러 개의 쿠폰을 한 번에 생성하려면 대시보드를 이용해야 합니다.

API를 통해 쿠폰 이미지를 업로드할 수는 없습니다.
이미지가 필요한 경우, 먼저 대시보드에서 쿠폰 그룹을 생성하고 이미지를 등록한 뒤, 쿠폰 생성 시 해당 그룹을 지정하세요.

쿠폰 생성 시 쿠폰 그룹을 지정하면 일부 설정은 무시되며, 쿠폰 그룹의 설정이 우선 적용됩니다.

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

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": ""
}
필드필드 설명설명필수유형
cpnNo쿠폰 번호 대문자의 영문자와 숫자로 조합된 8~16자리의 쿠폰 번호입니다. 특수 문자는 쿠폰 번호에 사용할 수 없습니다.
값이 비어있으면 쿠폰 번호가 시스템에 의해 자동으로 생성됩니다. 		string
grpIdx쿠폰 그룹 쿠폰 그룹은 쿠폰의 분류를 관리하는데 사용되며, 그룹 설정과 쿠폰 설정이 중복될 경우 쿠폰 설정은 무시됩니다.
그룹IDX는 대시보드의 쿠폰 그룹 페이지에서 확인할 수 있습니다.
기본값: 0 		int
tmplIdx쿠폰 템플릿 쿠폰 템플릿은 쿠폰에 대한 설명과 사용처, 사용 방법, 주의 사항을 사용자에게 알려줄 때 사용됩니다.
템플릿IDX는 대시보드의 쿠폰 템플릿 페이지에서 확인할 수 있습니다.
기본값: 0 		int
nm쿠폰 이름 쿠폰의 이름은 쿠폰 페이지에 노출됩니다. string
discTypeIdx할인 유형 쿠폰의 할인 유형(요율 또는 금액)을 설정합니다.
457:요율 할인(%), 458:금액 할인
요율 할인: 쿠폰에 대한 백분율 할인을 제공할 때 사용됩니다.
금액 할인: 입력된 금액 만큼 할인을 제공할 때 사용됩니다. 		int
disc할인 값 할인 유형이 요율(457)일 때 1% ~ 100% 사이의 값을 입력합니다.
할인 유형이 금액(458)일 때 할인할 금액을 입력합니다. 		double
discCurrency금액 화폐 할인 유형이 금액(458)일 때 화폐 단위를 설정할 수 있습니다.
KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD
기본값: KRW 		string
strtYmd유효기간 시작일 쿠폰을 언제부터 사용할 수 있는지 유효기간의 시작일을 설정합니다.
yyyy-mm-dd 날짜 형식으로 10자리 값.
예: 2024-10-01 		date
endYmd유효기간 만료일 쿠폰을 언제까지 사용할 수 있는지 유효기간의 만료일을 설정합니다.
yyyy-mm-dd 날짜 형식으로 10자리 값.
예: 2024-12-31 		date
onsiteYn현장쿠폰 여부 이 값이 Y이면 쿠폰 페이지에서 쿠폰을 사용할 수 있는 버튼이 표시됩니다.
사용자가 매장 직원에게 쿠폰을 보여주면 직원이 쿠폰을 사용하는 방식입니다. 오프라인 매장을 운영하고 있다면 유용한 기능입니다.
기본값: N 		Y or N
onsitePwd현장쿠폰 사용 비밀번호 비밀번호를 설정하면 매장 직원이 쿠폰을 사용처리할 때 설정된 비밀번호를 입력해야 됩니다.
사용자가 임의로 쿠폰을 사용 처리할 수 없습니다. 		string
memo메모 쿠폰을 관리하는 내부 용도로 사용될 수 있습니다.
메모는 사용자에게 노출되지 않습니다. 		string
urlURL URL을 입력하면 쿠폰 페이지에 “쿠폰 사용하러 가기” 버튼이 표시되고 클릭하면 입력된 URL로 이동됩니다.
쿠폰 이미지가 업로드된 경우 이미지를 클릭하여도 URL로 이동됩니다. 		string
useLimit1인당 최대 쿠폰 사용 횟수 쿠폰을 최대 몇 번까지 사용할 수 있는지 횟수를 설정합니다.
1인당 쿠폰 사용 횟수 “2회 ~ 5회”까지는 비볼디에서 제공하는 REST API를 이용하여 쿠폰사용 처리를 할 때 필요합니다.
이때 사용자ID 값은 반드시 입력되어야 합니다.
쿠폰 사용을 대시보드에서 수동으로 관리할 때는 “무제한”, “1회” 중 1가지만 선택할 수 있습니다.
“무제한”을 선택하면 누구나 횟수 제한없이 쿠폰을 사용할 수 있습니다.
0:무제한, 1:1회 제한, 2:2회 제한, 3:3회 제한, 4:4회 제한, 5:5회 제한 		int
color글자 색상 쿠폰 페이지에서 쿠폰 글자의 색상을 설정합니다.
HEX 값으로 입력되어야 하며, 투명도를 포함한 최대 9자리까지 입력할 수 있습니다.
기본 값: #4F4F4FFF 		string
background배경 색상 쿠폰 페이지에서 쿠폰의 배경 색상을 설정합니다.
HEX 값으로 입력되어야 하며, 투명도를 포함한 최대 9자리까지 입력할 수 있습니다.
기본 값: #FFFFFFFF 		string
userId사용자 ID 누구에게 쿠폰을 발급하였는지 그리고 누가 쿠폰을 사용하였는지 관리하는데 사용됩니다.
1인당 최대 쿠폰 사용 횟수의 값이 2 ~ 5인 경우 사용자 ID는 반드시 입력되어야 합니다.
일반적으로 웹사이트에 가입한 회원의 로그인ID를 입력합니다. 		string
userNm사용자 이름 누구에게 쿠폰을 발급할 것인지 이미 알고 있다면 쿠폰을 사용할 사용자의 이름을 입력합니다.
쿠폰 발급과 사용 처리에 대한 관리를 할 때 필요합니다. 		string
userPhnno사용자 연락처 쿠폰을 사용할 사용자의 연락처를 설정합니다. string
userEml사용자 이메일 쿠폰을 사용할 사용자의 이메일을 설정합니다. string
userEtc1사용자 기타 정보1 내부 관리 용도로 사용자의 추가 정보를 설정합니다. string
userEtc2사용자 기타 정보2 내부 관리 용도로 사용자의 추가 정보를 설정합니다. string
 
Response 
{
	"code": 0,
	"message": "",
	"result": "ZJLF0399WQBEQZJM"
}
필드설명유형
code응답 코드 (0:성공)int
message응답 메시지, 응답 코드가 0이 아닐 경우 관련 메시지가 리턴됨.string
result응답 값 (쿠폰 번호)string