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