쿠폰 생성

이 API는 할인 쿠폰을 생성하는 기능을 제공합니다.

여러 개의 쿠폰을 동시에 생성하려면 대시보드를 이용하세요.

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

이 API는 퍼스널 요금제 이상에서만 제공됩니다.

POST

/api/coupon/v1/create 

{
    "cpnNo": "",  // If left empty, a 16-character code will be generated automatically by the system.
    "nm": "$5 discount coupon",
    "discTypeIdx": 458,
    "disc": 5,
    "discCurrency": "USD",
    "strtYmd": "2025-01-01",
    "endYmd": "2025-12-31",
    "useLimit": 1,
    "grpIdx": 271,
    "tmplIdx": 0,
    "onsiteYn": "Y",
    "onsitePwd": "123456",
    "memo": "New Member Registration, IP: 211.111.222.33",
    "url": "https://bestshop.com",
    "userId": "att78z",
    "userNm": "Brown Smith",
    "userPhnno": "+1 123-4567-8900",
    "userEml": "test@gmail.com",
    "userEtc1": "Gold rating",
    "userEtc2": ""
}

Request Parameters

cpnNostring
쿠폰 번호. 영문/숫자 조합 8~16자리. 값이 없으면 시스템에서 자동 생성. 특수문자 불가.
값이 비어있으면 쿠폰 번호가 시스템에 의해 자동으로 생성됩니다.
예: V5H8GR5T
nmstringrequired
쿠폰 이름.
discTypeIdxintegerrequired
Default:457
Enum:
457458
할인 유형. (457:요율 할인 %, 458:금액 할인)
discdoublerequired
Default:0
할인율(457)은 1~100% 범위, 할인금액(458)은 금액 입력
discCurrencystring
Default:KRW
Enum:
KRWCADCNYEURGBPIDRJPYMURRUBSGDUSD
화폐 단위. 금액 할인(discTypeIdx:458) 사용시 필수.
strtYmddaterequired
쿠폰 유효 시작일. 예: 2024-10-01
endYmddaterequired
쿠폰 유효 만료일. 예: 2024-12-31
만료일은 다음 해 12월 31일까지만 설정할 수 있습니다.
useLimitintegerrequired
Default:1
Enum:
012345
쿠폰 사용 가능 횟수. (0:무제한, 1~5: 횟수 제한)
2회 이상 지정시 userId 값은 반드시 지정해야 합니다.
grpIdxinteger
Default:0
쿠폰 그룹. 쿠폰을 그룹으로 관리할 때 사용. 그룹IDX는 대시보드의 쿠폰 그룹 관리에서 확인 가능.
그룹 설정과 쿠폰 설정이 중복될 경우 그룹 설정이 우선순위를 갖습니다.
tmplIdxinteger
Default:0
쿠폰 템플릿. 쿠폰 생성 시 참조할 템플릿. 템플릿IDX는 대시보드의 쿠폰 템플릿 관리에서 확인 가능.
onsiteYnstring
Default:N
Enum:
YN
현장쿠폰 여부. 쿠폰 페이지에 “쿠폰 사용” 버튼 표시 여부.
오프라인 매장에서 직원이 쿠폰 사용 시 필요.
onsitePwdstring
현장쿠폰 비밀번호. 쿠폰 사용 시 필요한 비밀번호.
memostring
내부 참고용 메모.
urlstring
URL 입력 시 쿠폰 페이지에 “쿠폰 사용하러 가기” 버튼이 표시됩니다.
버튼 또는 쿠폰 이미지 클릭 시 해당 URL로 리디렉션.
colorstring
쿠폰 글자 색상. HEX 값 입력. 예: #4F4F4F
backgroundstring
쿠폰 배경 색상. HEX 값 입력. 예: #FFFFFF
userIdstring
쿠폰 발급 대상자를 관리하는 데 사용됩니다.
쿠폰 사용 가능 횟수가 2~5로 설정된 경우 반드시 입력해야 하며, 일반적으로 웹사이트 회원의 로그인 ID 또는 영문 이름을 입력합니다.
userNmstring
쿠폰 사용자 이름. 내부 관리용.
userPhnnostring
쿠폰 사용자 연락처. 내부 관리용.
userEmlstring
쿠폰 사용자 이메일. 내부 관리용.
userEtc1string
추가 내부 관리용 필드.
userEtc2string
추가 내부 관리용 필드. 
{
    "code": 0,
    "message": "",
    "result": "ZJLF0399WQBEQZJM"
}

Response Parameters

codeinteger
응답 코드: 0 = 성공, 그 외 값 = 오류
messagestring
응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
resultstring
응답 값입니다. 생성된 쿠폰 번호가 반환됩니다.
예: ZJLF0399WQBEQZJM