취소(반품)접수번호를 이용하여 철회된 반품의 이력을 조회합니다.
Path
POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawList
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnWithdrawListRequest Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345 |
||||
Body Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| cancelIds | O | Array |
철회 이력을 조회할 취소(반품)접수번호 목록
한 번에 최대 50개까지 cancelIds 조회가 가능합니다.
cancelIds는 number 타입이어야 합니다.
|
||||
Request Example
{
"cancelIds": [
87033689
]
}Response Message
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number |
Http request status code
Example: 200, 400, 500
|
||||||||||||
| message | String |
성공 혹은 실패 시 해당 결과메시지가 나타남
|
||||||||||||
| data | Array |
|
||||||||||||
| cancelId | Number |
취소(반품)접수번호
|
||||||||||||
| orderId | Number |
주문번호
|
||||||||||||
| vendorId | String |
업체코드
|
||||||||||||
| refundDeliveryDuty | String |
반품 귀책
|
||||||||||||
| createdAt | String |
취소(반품) 철회 시각
yyyy-MM-ddThh:mm:ss
|
||||||||||||
| vendorItemIds | Array |
반품 옵션아이디 목록
|
||||||||||||
Response Example
{
"code": "200",
"message": "OK",
"data": [
{
"cancelId": 87033689,
"orderId": 23000016565020,
"vendorId": "A00001234",
"refundDeliveryDuty": "COM",
"createdAt": "2018-06-05T13:40:56",
"vendorItemIds": [
3737624764
]
}
]
}Error Spec
| HTTP 상태 코드(오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 500 (요청변수확인) | CReturns getWithdrawnList failed | 올바른 반품접수번호(cancelIds)를 입력했는지 확인합니다. 해당 항목 입력을 안할 경우 500 에러가 발생합니다. |
URL API Name
GET_RETURNWITHDRAW_BY_CANCEL_IDS