쿠폰 사용
대시보드에서 쿠폰 사용을 수동으로 처리할 수도 있지만,
이 API를 사용하면 사용자가 웹사이트에서 쿠폰을 사용할 때 자동으로 처리할 수 있어 효율적인 운영이 가능합니다.
이 API는 퍼스널 요금제부터 사용할 수 있습니다.
Http Header
PUT /api/coupon/v1/redeem
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"cpnNo": "ZJLF0399WQBEQZJM",
"userId": "x77hu",
"memo": "IP Address: 210.123.111.222, Request Page: example.com/shop/bags/p112233"
}| 필드 | 필드 설명 | 설명 | 필수 | 유형 |
|---|---|---|---|---|
| cpnNo | 쿠폰 번호 | “사용 완료” 처리할 쿠폰 번호. “-” 기호를 제외한 쿠폰 번호만 입력하세요. | string | |
| onsitePwd | 현장쿠폰 사용 비밀번호 | 현장쿠폰 사용에 대한 비밀번호가 설정되어 있을 경우, 설정된 비밀번호를 입력합니다. 비밀번호가 맞지 않으면 쿠폰을 사용처리할 수 없습니다. | string | |
| userId | 사용자 ID | 누구에게 쿠폰을 발급하였는지 그리고 누가 쿠폰을 사용하였는지 관리하는데 사용됩니다. 1인당 최대 쿠폰 사용 횟수의 값이 2 ~ 5인 경우 사용자 ID는 반드시 입력되어야 합니다. 일반적으로 웹사이트에 가입한 회원의 로그인ID를 입력합니다. | string | |
| memo | 메모 | 쿠폰 사용의 관리 차원에서 메모를 입력할 수 있습니다. 사용자의 IP Address, 쿠폰을 사용한 페이지 및 서비스, 기타 정보를 입력합니다. 1인당 최대 쿠폰 사용 횟수가 무제한일 때 누가 쿠폰을 사용하였는지 알 수 없기 때문에 사용자ID 또는 메모로 관리할 수 있습니다. | string |
Response
{
"code": 0,
"message": "",
"result": null
}
| 필드 | 설명 | 유형 |
|---|---|---|
| code | 응답 코드 (0:성공) | int |
| message | 응답 메시지, 응답 코드가 0이 아닐 경우 관련 메시지가 리턴됨. | string |