반품 접수번호를 이용하여 반품 단건 조회를 수행합니다.
Path
GET/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnRequests/{receiptId}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012697/returnRequests/363585Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자 ID
|
||||
| receiptId | O | Number |
취소(반품)접수번호
ReceiptId는 반품요청 목록 조회API를 통해 확인가능합니다.
ReceiptId는 반드시 number타입이어야 합니다.
|
||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | String |
Http request status code
Example: 200, 400, 500
|
||||||||||||||||
| message | String |
성공 혹은 실패 시 해당 결과메시지가 나타남
|
||||||||||||||||
| data | Array |
|
||||||||||||||||
| receiptId | Number |
취소(반품)접수번호
|
||||||||||||||||
| orderId | Number |
주문번호
|
||||||||||||||||
| paymentId | Number |
결제번호
|
||||||||||||||||
| receiptType | String |
취소유형
|
||||||||||||||||
| receiptStatus | String |
취소(반품)진행 상태
|
||||||||||||||||
| createdAt | String |
취소(반품) 접수시간
yyyy-MM-ddThh:mm:ss
|
||||||||||||||||
| modifiedAt | String |
취소(반품) 상태 최종 변경시간
yyyy-MM-ddThh:mm:ss
|
||||||||||||||||
| requesterName | String |
반품 신청인 이름
|
||||||||||||||||
| requesterPhoneNumber | String |
반품 신청인 전화번호
|
||||||||||||||||
| requesterRealPhoneNumber | String |
반품 신청인 실전화번호
null
|
||||||||||||||||
| requesterAddress | String |
반품 회수지 주소
|
||||||||||||||||
| requesterAddressDetail | String |
반품 회수지 상세주소
|
||||||||||||||||
| requesterZipCode | String |
반품 회수지 우편번호
|
||||||||||||||||
| cancelReasonCategory1 | String |
반품 사유 카테고리 1
|
||||||||||||||||
| cancelReasonCategory2 | String |
반품 사유 카테고리 2
|
||||||||||||||||
| cancelReason | String |
취소사유 상세내역
|
||||||||||||||||
| cancelCountSum | Number |
총 취소수량
|
||||||||||||||||
| returnDeliveryId | Number |
반품배송번호
|
||||||||||||||||
| returnDeliveryType | String |
회수종류
고객이 직접 반품상품을 발송했거나 회수할 상품이 없을 때 ""로 표시됩니다.
|
||||||||||||||||
| releaseStopStatus | String |
출고중지처리상태
|
||||||||||||||||
| enclosePrice | Number |
동봉배송비
|
||||||||||||||||
| faultByType | String |
귀책타입
|
||||||||||||||||
| preRefund | Boolean |
빠른환불 여부
|
||||||||||||||||
| completeConfirmType | String |
완료 확인 종류
|
||||||||||||||||
| completeConfirmDate | String |
완료 확인 시간
yyyy-MM-ddTHH:mm:ss
|
||||||||||||||||
| returnItems | Array |
반품 아이템 목록
|
||||||||||||||||
| vendorItemPackageId | Number |
딜번호
*사용안함
|
||||||||||||||||
| vendorItemPackageName | String |
딜명
*사용안함
|
||||||||||||||||
| vendorItemId | Number |
옵션아이디
*vendorItemId 단위로 반품이 접수됩니다. 반품 접수 시, 반드시 확인 필요한 옵션아이디
|
||||||||||||||||
| vendorItemName | String |
옵션명
|
||||||||||||||||
| cancelCount | Number |
취소 수량
*부분 반품이 가능하므로, 취소(반품) 수량을 반드시 확인해주세요.
|
||||||||||||||||
| purchaseCount | Number |
주문 수량
|
||||||||||||||||
| shipmentBoxId | Number |
원 배송번호
|
||||||||||||||||
| sellerProductId | Number |
업체등록상품번호
|
||||||||||||||||
| sellerProductName | String |
업체 등록 상품명
|
||||||||||||||||
| releaseStatus | String |
상품출고여부
|
||||||||||||||||
| cancelCompleteUser | String |
주문취소처리 담당자
(3P_CANCEL: 상품준비중 단계에서 취소된 경우) |
||||||||||||||||
| returnDeliveryDtos | Array |
회수 운송장 정보
receiptId 별로 복수의 회수 운송장정보가 발생할 수 있음
|
||||||||||||||||
| deliveryCompanyCode | String |
회수 택배사코드
|
||||||||||||||||
| deliveryInvoiceNo | String |
회수 운송장번호
회수 운송장번호 값이 "" 또는 null일 경우 무시
|
||||||||||||||||
| reasonCode | String |
반품사유코드
반품요청 목록페이지 상단에서 VOC 사유코드를 다운받아 확인해주세요.
|
||||||||||||||||
| reasonCodeText | String |
반품사유설명
|
||||||||||||||||
| returnShippingCharge | Long |
예상 반품배송비
|
||||||||||||||||
Response Example
{
"code": "200",
"message": "OK",
"data": [
{
"receiptId": 365937,
"orderId": 500004398,
"paymentId": 700003957,
"receiptType": "반품",
"receiptStatus": "RELEASE_STOP_UNCHECKED",
"createdAt": "2016-03-25T13:05:30",
"modifiedAt": "2016-03-25T13:05:30",
"requesterName": "임송이",
"requesterPhoneNumber": "010-****-4043",
"requesterRealPhoneNumber": null,
"requesterAddress": "서울특별시 송파구 송파대로 570 (신천동)",
"requesterAddressDetail": "Tower 730",
"requesterZipCode": "05510",
"cancelReasonCategory1": "고객변심",
"cancelReasonCategory2": "단순변심(사유없음)",
"cancelReason": "테스트",
"cancelCountSum": 1,
"returnDeliveryId": 40453,
"returnDeliveryType": "연동택배",
"releaseStopStatus": "미처리",
"enclosePrice": 0,
"faultByType": "CUSTOMER",
"preRefund": false,
"completeConfirmDate": "",
"completeConfirmType": "미확인",
"returnItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "객지/한씨연대기/삼포 가는 길/섬섬옥수/몰개월의 새",
"vendorItemId": 3000001893,
"vendorItemName": "객지/한씨연대기/삼포 가는 길/섬섬옥수/몰개월의 새 1",
"purchaseCount": 1,
"cancelCount": 1,
"shipmentBoxId": 197267583,
"sellerProductId": 130,
"sellerProductName": "객지/한씨연대기/삼포 가는 길/섬섬옥수/몰개월의 새 1",
"releaseStatus": "S",
"cancelCompleteUser": "l******"
}
],
"returnDeliveryDtos": [
{
"deliveryCompanyCode": "DIRECT",
"deliveryInvoiceNo": "201807261200"
},
{
"deliveryCompanyCode": "DIRECT",
"deliveryInvoiceNo": "201807261200"
}
],
"reasonCode": "CHANGEMIND",
"reasonCodeText": "필요 없어짐 (단순 변심)",
"returnShippingCharge": -3000
}
]
}Error Spec
| HTTP 상태 코드(오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 400 (요청변수확인) | ReceiptId doesn't belong to the vendorId, or cannot find the Receipt by the given id | 조회하는 반품접수번호(receiptId)가 고객에 의해 철회 되었는지 확인합니다. 반품철회 이력 접수번호로 조회 API로 철회내역을 조회할 수 있습니다. 철회된 반품접수 번호는 더이상 조회하지 않도록 처리합니다. |
URL API Name
GET_RETURN_REQUEST_BY_RECEIPT