쿠폰에 적용되어 있던 옵션(아이템)의 적용 해제를 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어
실제 API 수행 결과 값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
실제 API 수행 결과 값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
Path
PUT/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}/items?action=expire
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/84/items?action=expireRequest Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345
|
||||
| couponId | O | Number |
적용을 해제할 쿠폰 ID
|
||||
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| action | O | String |
expire
|
||||
Body Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorItems | O | Array |
쿠폰 적용을 해제할 옵션ID
한 번에 적용 해제할 옵션ID 수는 10,000개를 초과할 수 없음
|
||||
Request Example
{
"vendorItems": [
3226138951,
3226138847
]
}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": "2837577763015251644",
"success": true
},
"pagination": null
}
}Error Spec
| HTTP 상태 코드 (오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 400 (요청변수확인) | vendorItems may not be empty, vendorItems size must be between 1 and 10000 | 쿠폰적용을 해제할 옵션ID(vendorItems) 를 올바로 입력했는지 확인합니다. 한 번에 적용 해제할 옵션ID 수는 10,000개를 초과할 수 없습니다. |
| 400 (요청변수확인) | 업체정보의 권한을 확인하세요 | 판매자ID(vendorId) 값을 올바로 입력했는지 확인합니다. |
| 400 (요청변수확인) | 쿠폰아이디를 확인해주세요 208463**** | 쿠폰ID(couponId) 값을 올바로 입력했는지 확인합니다. |