생성되어 있던 쿠폰의 파기를 위한 API입니다. 본 API는 비동기방식으로 프로세스에 대한 요청 만을 수행하고 있어
실제 API 수행 결과값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
실제 API 수행 결과값은 응답으로 받은 "requestedId" 값을 가지고 요청상태 확인 API를 통해서 확인 가능합니다.
쿠폰 파기 시 쿠폰에 아직 끝나지 않은 다른 요청이 있을 경우 실패가 발생할 수 있습니다. 예를 들어 쿠폰 생성 후 아이템들의 추가를 요청한 경우, 아이템 추가가 모두 완료되기 전에는 쿠폰 파기가 실패처리 됩니다. ("success": false 출력됨)
Path
PUT/v2/providers/fms/apis/api/v1/vendors/{vendorId}/coupons/{couponId}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/fms/apis/api/v1/vendors/A00012345/coupons/684245?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
|
||||
Request Example
not require body
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 |
처리 상태를 조회할 수 있는 요청ID 데이터
|
||||
| requestedId | String |
처리 상태 조회를 위한 요청ID
예) 1542675975663862164
|
||||
| success | Boolean |
성공 여부
true or false
|
||||
| Pagination | null |
페이징 없음
|
||||
Response Example
{
"code": 200,
"message": "OK",
"httpStatus": 200,
"httpStatusMessage": "OK",
"errorMessage": "",
"data": {
"success": true,
"content": {
"requestedId": "649102321051192483",
"success": true
},
"pagination": null
}
}Error Spec
| HTTP 상태 코드 (오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 400 (요청변수확인) | 조회되지 않는 쿠폰입니다.2325***23 | 올바른 쿠폰ID(couponId) 값을 입력했는지 확인합니다. |