계약아이디(contractId)에 기반한 신규 쿠폰 생성을 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어
실제 API 수행 결과값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
실제 API 수행 결과값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
Path
POST/v2/providers/fms/apis/api/v2/vendors/{vendorId}/coupon
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v2/vendors/A00000001/couponRequest Parameters
Path Segment Parameter
Name | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
vendorId | O | String |
업체 ID
|
Body Parameter
Name | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
contractId | O | Number |
업체의 계약서 아이디
|
||||
name | O | String |
프로모션명(최대 45자)
|
||||
maxDiscountPrice | O | Number |
최대할인금액
최소 10원 이상
|
||||
discount | O | Number |
할인률
|
||||
startAt | O | String |
유효시작일
유효시작일은 다음날 00시부터 작동하도록 설정 가능 ex: 8월4일 15시에 쿠폰을 생성한다면 8월5일00시 부터 쿠폰이 적용되도록 생성
|
||||
endAt | O | String |
유효종료일
종료일은 계약 기간을 넘을수 없으며, 해당연도의 12월31일 00:00:00까지 지정 가능
|
||||
type | O | String |
할인방식
RATE(정률할인), FIXED_WITH_QUANTITY(수량별 정액할인), PRICE(정액할인)
|
Request Example
{
"contractId": "10",
"name": "newCoupon 20180328",
"maxDiscountPrice": "1000",
"discount": "10",
"startAt": "2017-12-08 00:00:00",
"endAt": "2017-12-09 00:00:00",
"type": "PRICE"
}
Response Message
Name | Type | Description | ||||
---|---|---|---|---|---|---|
code | Number |
서버 응답 코드
|
||||
message | String |
서버 응답 메세지
|
||||
httpStatus | Number |
HTTP Status Code(서버 응답 코드와 동일한 값)
|
||||
httpStatusMessage | String |
HTTP Status Message (서버 응답 메세지와 동일한 값)
|
||||
errorMessage | String |
HTTP Status 200을 제외한 나머지 Status에서 서버 내 상세한 실패 이유 메세지가 담깁니다.
|
||||
data | Object |
수행 성공 여부 데이터
|
||||
success | Boolean |
성공 여부
true or false
|
||||
content | Object |
처리 상태를 조회할 수 있는 요청아이디 데이터
|
||||
requestedId | String |
처리 상태 조회를 위한 요청아이디
예) 1542675975663862164
|
||||
success | Boolean |
성공 여부
true or false
|
||||
Pagination | null |
페이징 없음
|
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"requestedId": "123543582159745830895",
"success": true
},
"pagination": null
}
}
Error Spec
Status | Message |
---|---|
400 | 계약의 유효기간 안에 쿠폰이 존재해야 한다(계약서의 유효기간:2017-03-01 00:00:00~2017-12-31 23:59:59) (쿠폰의 유효기간:2016-12-05 00:00:00~2017-09-05 00:00:00) |
400 | Cannot parse "2017-13-05 00:00:00": Value 13 for monthOfYear must be in the range [1,12] |
400 | Cannot parse "2017-08-32 00:00:00": Value 32 for dayOfMonth must be in the range [1,31] |
400 | startAt 패턴을 확인하세요. yyyy-MM-dd HH:mm:ss |
400 | endAt 패턴을 확인하세요. yyyy-MM-dd HH:mm:ss |
400 | discount 양수만 입력 가능합니다. (정률은 1~100, 정액은 1이상) |