반품/교환회수목록조회 APIReturn/Exchange Recollect List Search API
정책 및 프로세스 Policy & Process
1. 배송진행상태가 회수지시인 회수건을 조회 가능합니다.
2. 반품/교환 접수 시 배송진행상태 회수지시로 회수(배송)데이터가 생성됩니다.
3. 회수지시일, 회수완료일, 주문완료일(=배송지시일) 기준으로 최대 7일까지 조회 가능합니다.
4. 배송진행상태가 회수확인인 회수건에 한해 회수확인일 +3일(영업일 기준)에 회수완료상태로 자동으로 변경됩니다.
1. Search for the cases of Recollect Instructed.
2. When receiving Return/Exchange, Recollect(Shipping) Data will be created to Recollect Instructed.
3. Based on Recollect Instructed Date, Recollect Completed Date and Order Completed Date (=Shipping Instructed Date)
you can search until maximum 7 days.
4. If shipping process status is Recollect Confirmed and Recollect Confirmed day + 3 days (based on business day),
shipping status will be change to Recollect Completed automatically.
기본설명 Description
반품/교환 접수된 회수건을 조회하는 API 입니다.
각 항목별 필수값을 넣지 않으면 오류메시지가 발생하니, 각 항목별 필수사항을 체크해주세요
Search for the cases about Return/Exchange Recollect.
Check essential points since error message can occur regardless of essential values.
API 상세 항목 API Details
URL : /api/pd/{version}/listExchangeTarget.ssg
Method : POST
URL : /api/pd/{version}/listExchangeTarget.ssg
Method : POST
RequestHeader :
| 이름 Property | 타입 Property Type | 필수여부 Require | 설명 Desciption | 수정일 UpdateDate | |
|---|---|---|---|---|---|
| Authorization | String | Y | 업체 인증키 Vendor API Authentication Key | - | |
| Accept | string | Y |
application/xml application/json application/xml application/json |
- | |
RequestURI :
| 이름 Property | 타입 Property Type | 필수여부 Require | 설명 Desciption | 수정일 UpdateDate | |
|---|---|---|---|---|---|
| version | String | Y | 1 고정 1 fix | - | |
RequestParameter :
| 이름 Property | 타입 PropertyType | 필수 여부 Required | 설명 Description | 수정일 UpdateDate | |||||
|---|---|---|---|---|---|---|---|---|---|
| requestExchangeTarget | OBJECT | Y | - | ||||||
| commType | String | Y |
빠른조회타입, 빠른조회일 경우 필수 값 01 운송장번호 02 주문번호 03 배송번호 If general search, then mandatory value. 01 Waybill Number 02 Order Number 03 Shipping Number |
- | |||||
| commValue | String | Y |
빠른조회값, 빠른조회일 경우 필수 값 If quick search, then mandatory value. |
- | |||||
| perdType | String | Y |
기간타입, 일반조회일 경우 필수 값 01 회수지시일 02 회수완료일 03 주문완료일(=배송지시일) 04 회수확인일 05 회수철회일 If general search, then mandatory value. 01 Recollect Instructed Date 02 Recollect Completed Date 03 Order Completed Date (= Shipping Instructed Date) 04 Recollect Confirmed Date 05 Recollect Revoked Date |
2020-12-30 | |||||
| perdStrDts | Date | Y |
기간시작일, 일반조회일 경우 필수 값. 기간은 7일 이내 If general search, then mandatory value. Period is within 7 days |
- | |||||
| perdEndDts | Date | Y |
기간종료일, 일반조회일 경우 필수 값. 기간은 7일 이내 If general search, then mandatory value. Period is within 7 days |
- | |||||
| shppDivDtlCds | String | N |
배송구분상세코드 21 반품 22 교환 23 AS Release Type 21 Return 22 Exchange 23 AS |
- | |||||
| shppProgStatDtlCds | String | N |
상세배송진행상태 61 회수지시 63 회수확인 64 회수완료 65 회수완료보류 66 회수철회 Recollect Status 61 Recollect Instructed 63 Recollect Confirmed 64 Recollect Completed 65 Recollect Completed On Hold 66 Recollect Revoked |
- | |||||
| retProcStats | String | N |
반품처리상태 10 반품완료 20 반품거부 30 반품거부CS처리중 40 반품거부CS처리완료 Return Process Status 10 Return Completed 20 Return Denied 30 Return Denied CS Processing 40 Return Denied CS Processing Completed |
- | |||||
| shppTypeDtlCds | String | N |
배송유형상세코드 14 업체자사배송 22 업체택배배송 25 해외택배배송 31 매장방문 41 등기 91 업체프리미엄배송 Shipping Type Detail 14 Vendor's In-House Shipping 22 Vendor Shipping 25 International Shipping 31 In-Store Visit 41 Mail 91 Premium Shipping |
- | |||||
| itemNm | String | N | 상품명 Item Name | - | |||||
| itemId | String | N | 상품번호 Item Number | - | |||||
| rcovMthdCds | String | N |
회수신청방법 20 고객직접발송 40 자동회수 45 업체자체회수 70 SSG전담택배 Recollect Request Method 20 Customer Firsthand Shipping 40 Automatic Return Shipping 45 Vendor Designated Shipping 70 SSG Dedicated Shipping |
2017-11-15 | |||||
| retImptMainCds | String | N |
귀책사유주체 10 고객 20 판매자 30 택배사 Return Request Reason Main 10 Customer 20 Seller 30 Shipping Company |
- | |||||
| retRefusRsnCds | String | N |
반품거부사유 01 기간경과 02 사용상품 03 상품불량 04 구성품누락 05 사은품누락 06 상품상이 07 상품수량상이 08 상품훼손/파손 09 케이스(BOX)파손 10 상담원과실 11 기타 Return Denied Reason Overlap permitted. Must use ',' for division. 01 Period Elapsed 02 Use Item 03 Faulty Item 04 Main Item Omitted 05 Free Gift Omitted 06 Item Incorrect 07 Item Quantity Incorrect 08 Item Damage 09 Case(Box) Damage 10 Consultant's Mistake 11 Other |
- | |||||
| ordpeNm | String | N | 주문자 Customer | - | |||||
| rcptpeNm | String | N | 수취인 Recipient | - | |||||
| mallTypeCd | String | N |
몰유형코드 10: 종합몰 20: 오픈마켓 Mall Type 10: general mall 20: open market |
2021-05-06 | |||||
| ordTypeCd06Yn | String | N |
선물하기 주문여부 Y/N GiftItem OrderType Yes Or No Y/N |
2021-08-04 | |||||
| ordItemCertNoYn | String | N |
개런티 주문여부 Y/N GuaranteeItem OrderType Yes Or No Y/N |
2021-08-04 | |||||
ResponseBody :
| 항목 Property | 타입 Property Type | 필수여부 Require | 설명 Desciption | 수정일 UpdateDate | |||
|---|---|---|---|---|---|---|---|
| resultCode | String | Y | 결과 코드 Result Code | - | |||
| resultMessage | String | Y | 결과 값 Result Message | - | |||
| resultDesc | String | Y | 오류 메시지 Error Message | - | |||
| exchangeTargets | LIST | - | |||||
| exchangeTarget | Object | - | |||||
| shppVenId | String | N | 공급업체아이디 Supply Vendor Identification | - | |||
| splVenNm | String | N | 상위업체명 (삭제예정. 'shppVenNm'을 사용해주세요) Upper Rank Vendor (To be deleted. Please use "shppVenNm".) | - | |||
| shppVenNm | String | N | 공급업체명 Supply Vendor Name |
2023-01-11 (추가) 2023-01-11 (added) |
|||
| shppLrnkVenId | String | N | 하위공급업체아이디 Low Rank Supply Vendor Identification | - | |||
| lrnkSplVenNm | String | N | 하위업체명 (삭제예정. 'shppLrnkVenNm'을 사용해주세요) Low Rand Vendor (To be deleted. Please use "shppLrnkVenNm".) | - | |||
| shppLrnkVenNm | String | N | 하위공급업체명 Low Rank Supply Vendor Name |
2023-01-11 (추가) 2023-01-11 (added) |
|||
| String | 이전주문번호 Previous System Order Number |
2022-12-07 (삭제) 2022-12-07 (deleted) |
|||||
| int | N | 이전시스템주문순번 Previous System Order Sequence |
2022-12-07 (삭제) 2022-12-07 (deleted) |
||||
| shppDivDtlCd | String | N |
배송구분상세코드 21 반품회수 22 교환회수 23 AS회수 Release Type 21 Return 22 Exchange 23 AS |
- | |||
| shppDivDtlNm | String | N | 배송구분상세명 Release Type Name | - | |||
| orordNo | String | N | 원주문번호 Original Order Number | - | |||
| orordItemSeq | int | N | 원주문순번 Original Order Item Sequence | - | |||
| ordNo | String | 주문번호 Order Number | - | ||||
| ordItemSeq | int | N | 주문순번 Order Sequence | - | |||
| bfShppNo | String | N | 이전배송번호 Previous Shipping Number | - | |||
| bfShppSeq | int | N | 이전배송순번 Previous Shipping Sequence | - | |||
| shppNo | String | N | 회수배송번호 Recollect Shipping Number | - | |||
| shppSeq | int | N | 회수배송순번 Recollect Shipping Sequence | - | |||
| itemNm | String | N | 상품명 Item Name | - | |||
| splVenItemId | String | N | 협력업체상품ID Vendor Item Number | - | |||
| uSplVenItemId | String | N | 협력업체단품ID Vendor Unit Item Number | - | |||
| itemId | String | N | 상품번호 Item Number | - | |||
| uitemNm | String | N | 단품명 Unit Item Name | - | |||
| uitemId | String | N | 단품번호 Unit Item Number | 2017-08-22 | |||
| orshppNo | String | N | 원배송번호 Original Shipping Number | - | |||
| orshppSeq | int | N | 원배송순번 Original Shipping Sequence | - | |||
| mdlNm | String | N | 모델명 Model Name | - | |||
| frebieNm | String | N | 사은품 Free Gifte | - | |||
| dircItemQty | int | N | 지시수량 Instructed Quantity | - | |||
| procItemQty | int | N | 처리수량 Recollect Quantity | - | |||
| refusRetProcQty | int | N | 반품거부수량 Return Denied Quantity | - | |||
| clmRsnCd | String | N | 클레임사유코드 Claim Reason Code | - | |||
| clmRsnNm | String | N | 클레임사유코드명 Claim Reason Name | - | |||
| clmRsnCntt | String | N | 클레임사유내용(귀책사유(세)) Claim Reason Content | - | |||
| shppcstBdnMainCd | String | N |
배송비부담주체코드 10 고객 20 업체 Shipping Cost Payee Main Code 10 Customer 20 Vendor |
- | |||
| shppcstBdnMainNm | String | N | 배송비부담주체코드명 Shipping Cost Payee Main Name | - | |||
| rcovMthdCd | String | N |
회수신청방법코드 20 고객직접발송 40 자동회수 45 업체자체회수 70 SSG전담택배 Recollect Request Method Code 20 Customer Firsthand Shipping 40 Automatic Return Shipping 45 Vendor Designated Shipping 70 SSG Dedicated Shipping |
- | |||
| rcovMthdNm | String | N | 회수신청방법 Recollect Request Method | - | |||
| lastShppProgStatDtlCd | String | N |
최종배송상세진행상태코드 61 회수지시 63 회수확인 64 회수완료 65 회수완료보류 66 회수철회 Final Shipping Detail Process Status Code 61 Recollect Instructed 63 Recollect Confirmed 64 Recollect Completed 65 Recollect Completed On Hold 66 Recollect Revoked |
- | |||
| lastShppProgStatDtlNm | String | N | 최종배송상세진행상태명 Final Shipping Detail Process Status Name | - | |||
| retProcStatCd | String | N |
반품처리상태코드 10 반품완료 20 반품거부 30 반품거부CS처리중 40 반품거부CS처리완료 50 반품확인 60 회수철회 Return Process Status Code 10 Return Completed 20 Return Denied 30 Return Denied CS Processing 40 Return Denied CS Processing Completed 50 Recollect Confirmed 60 Recollect Revoked |
- | |||
| retProcStatNm | String | N | 반품처리상태 Return Process Status | - | |||
| shppTypeDtlCd | String | N |
배송유형상세코드 14 업체자사배송 22 업체택배배송 25 해외택배배송 31 매장방문 41 등기 91 업체프리미엄배송 Shipping Type Code 14 Vendor's In-House Shipping 22 Vendor Shipping 25 International Shipping 31 In-Store Visit 41 Mail 91 Premium Shipping |
- | |||
| shppTypeDtlNm | String | N | 배송유형상세코드명 Shipping Type Detail Name | - | |||
| delicoVenId | String | N | 택배사ID Shipping Company | - | |||
| delicoVenNm | String | N | 택배사명 Shipping Company Name | - | |||
| wblNo | String | N | 운송장번호 Waybill Number | - | |||
| resellPsblYn | String | N |
재판매가능 구분 Y 가능 N 불가능 Resell Possibility Division Y Possible N Not Possible |
- | |||
| retImptMainCd | String | N |
귀책사유주체 10 고객 20 판매자 30 택배사 Return Request Reason Main Code 10 Customer 20 Seller 30 Shipping Company |
- | |||
| retImptMainNm | String | N | 귀책사유주체 Return Request Reason Main | - | |||
| shppcstAddPaymtNm | String | N | 배송비 추가결제 Shipping Cost Additional Payment | - | |||
| refundYn | String | N |
환불여부 Y/N Refund Yes Or No Y/N |
- | |||
| retRefusRsnNm | String | N |
반품거부사유 01 기간경과 02 사용상품 03 상품불량 04 구성품누락 05 사은품누락 06 상품상이 07 상품수량상이 08 상품훼손/파손 09 케이스(BOX)파손 10 상담원과실 11 기타 Return Denied Reason Overlap permitted. Must use ',' for division. 01 Period Elapsed 02 Use Item 03 Faulty Item 04 Main Item Omitted 05 Free Gift Omitted 06 Item Incorrect 07 Item Quantity Incorrect 08 Item Damage 09 Case(Box) Damage 10 Consultant's Mistake 11 Other |
- | |||
| retProcMemoCntt | String | N | 반품거부메모 Return Denied Memo | - | |||
| retProcMemoRegpeId | String | N | 메모등록자 Memo Registrant | - | |||
| memoCntt | String | N | 배송업무메모 Shipping Company Memo | - | |||
| rcovDircDt | Date | N | 회수지시일 Recollect Instructed Date | - | |||
| rcovCnfDt | Date | N | 회수확인일 Recollect Confirmed Date | - | |||
| rcovCmplDeferDt | Date | N | 회수완료보류일 Recollect Completion On Hold Date | - | |||
| rcovCmplDt | Date | N | 회수완료일 Recollect Completed Date | - | |||
| rcovRvkDt | Date | N | 회수철회일 Recollect Revoked Date | - | |||
| refundDt | Date | N | 환불완료일 Refund Completed Date | - | |||
| ordpeNm | String | N | 주문자 Customer | - | |||
| rcptpeNm | String | N | 수취인 Recipient | - | |||
| shpplocAddr | String | N |
수취인 도로명주소 (도로명 주소가 없는 경우 지번 주소) Recipient Road Name Address (If there is no road name address, the land lot number address is returned.) |
- | |||
| shpplocZipcd | String | N | 수취인 우편번호 Recipient Postal Code | - | |||
| shpplocOldZipcd | String | N | 수취인 구우편번호(6자리) Recipient Old Postal Code (6digits) | - | |||
| rcptpeHpno | String | N | 수취인 휴대폰번호 Recipient Mobile Phone Number | - | |||
| rcptpeTelno | String | N | 수취인 집전화번호 Recipient Phone Number | - | |||
| sellprc | int | N | 판매가 Sales Price | - | |||
| rlordAmt | int | N |
결제가 * 해당 항목은 배송을 위한 참고 정보입니다. 정산을 위해서는 정산 API를 활용해주세요. Real Order Amount * This is reference information for Shipping. Please use Settlement API for an accurate settlement. |
2023-01-11 (추가) 2023-01-11 (added) |
|||
| dcAmt | int | N |
할인가 * 해당 항목은 배송을 위한 참고 정보입니다. 정산을 위해서는 정산 API를 활용해주세요. Discount Amount * This is reference information for Shipping. Please use Settlement API for an accurate settlement. |
2023-01-11 (추가) 2023-01-11 (added) |
|||
| shppStatCd | String | N |
배송상태코드 10 정상 30 대기 Shipping Status Code 10 Normal 30 On Hold |
- | |||
| shppStatNm | String | N | 배송상태코드명 Shipping Status Name | - | |||
| shpplocBascAddr | String | N |
수취인 행정구역 + 도로명 + 건물번호 (도로명 주소가 없는 경우 지번 기본 주소) Recipient Administrative District + Street Name + Building Number (If there is no road name address, the land lot number basic address is returned.) |
2017-07-12 | |||
| shpplocDtlAddr | String | N |
수취인 도로명 상세주소 (도로명 주소가 없는 경우 지번 상세 주소) Recipient Road Name Detail Address (If there is no road name address, the land lot number detail address is returned.) |
2017-07-12 | |||
| mallTypeCd | String | N |
몰유형코드 10: 종합몰 20: 오픈마켓 Mall Type 10: general mall 20: open market |
2021-05-06 | |||
| ordTypeCd06Yn | String | N |
선물하기 주문여부 Y/N GiftItem OrderType Yes Or No Y/N |
2021-08-04 | |||
| ordItemCertNoYn | String | N |
개런티 주문여부 Y/N GuaranteeItem OrderType Yes Or No Y/N |
2021-08-04 | |||