본문 바로가기
스마일배송 API/외부주문

반품/교환입고 조회 API

Description
[POST] https://sa2.esmplus.com/efm/v1/api/service/GetOuterclaimList
반품/교환입고 등록된 주문을 조회하는 API입니다.

Request Description

항목 항목명 필수여부 Type Description
SiteId 사이트코드 Y Int 하단 사이트 코드 참조
SearchType 외부주문검색조건 Y string OUTER_CART_NO : 외부장바구니번호
OUTER_ORDER_NO : 외부주문번호
SMILE_ORDER_NO : 스마일주문번호
CLAIM_DATE : 클레임등록일날짜로조회
WAREHOUSE_IN_DATE : 반품입고일날짜로조회
REPORTING_INS_DATE : 클레임리포팅등록일날짜로 조회
REPORTING_UPD_DATE : 클레임리포팅수정일날짜로 조회
SearchString 주문상세검색   string 검색조건 > OUTER_CART_NO / OUTER_ORDER_NO / SMILE_ORDER_NO 선택 시 필수
이 때, 날짜검색조건 무시
StartDate 조회시작일자   Date-Time 검색조건 > INS_DATE / WAREHOUSE_INS_DATE 일 경우 필수
EndDate 조회종료일자   Date-Time 검색조건 > INS_DATE / WAREHOUSE_INS_DATE 일 경우 필수
ClaimStatus 클레임상태 Y Int 0 : 전체
1 : 반품입고신청
2 : 반품입고완료
3 : 교환입고신청
4 : 교환입고완료
5 : 클레임입고미신청 & 반품입고완료(5번은 추후 제공예정)
pageIndex 페이지번호 Y Int 정수: Page 구분
pageSize 페이지사이즈 Y Int 1페이지에 출력하려는 리스트 Max값
1000까지 지원 가능
JSON
{
  "SiteId": 0,
  "SearchType": "string",
  "SearchString": "string",
  "StartDate": "2020-01-29T05:26:48.957Z",
  "EndDate": "2020-01-29T05:26:48.957Z",
  "ClaimStatus": 0,
  "PageIndex": 0,
  "PageSize": 0
}

 

Response Description

항목 항목명 Type Description
ResultCode 결과코드 int 성공: 0
실패 :Error Massage 참고
Message 메시지 string  
Data > TotalCount 전체대상건수 Int 조회조건 범위 전체 건수
Data > PageIndex Response PageNo Int 조회시 입력한 PageNo
Data > PageSize Response PageSize Int 조회시 입력한 PageSize
Data > Data > OrderDetail > SkuId []Sku번호 Int 지마켓에서 채번한 SKU번호 내려감
Data > Data > OrderDetail > OwQty []SKU총출고수량 Int 판매자가 등록한 SKU총출고수량
Data > Data > OrderDetail > BoxSize []출고된 박스사이즈 string 출고된 박스사이즈 내려감
Data > Data > OrderDetail > DeliveryCompCode []출고된 택배사코드 string 택배사별 5자리 코드 아래 택배사코드 참고
Data > Data > OrderDetail > InvoiceNo []출고송장번호 string 해당 SKU 출고송장번호 내려감
Data > Data > OrderDetail > InvoiceIssueDate []출고송장발급일시 Date-Time 해당 SKU 출고송장번호 발급일시 내려감
Data > Data > OrderDetail > InvoiceIssueDate []상품관리코드 string 판매자가 입력한 상품관리코드 내려감
Data > Data > OrderDetail > InvoiceIssueDate []SKU관리코드 string 판매자가 입력한 SKU관리코드 내려감
Data > ClaimSeqNo 클레임관리번호 Int 내부클레임관리번호 내려감
Data > EfmSeqNo 내부주문관리번호 Int 내부주문관리번호 내려감
Data > SiteId 사이트코드 Int 해당 스마일주문번호의 사이트코드 내려감
Data > SiteUserInput 사이트직접입력 string 판매자가 사이트직접입력한 텍스트 내려감
Data > ClaimType 클레임상태 string RT : 반품
EX : 교환
Data > DeliveryCompCode 수거 택배사코드 string 수거한 택배사코드 내려감
Data > ClaimInvoiceNo 수거 송장번호 string 수거한 송장번호 내려감
Data > DeliveryPayType 선불/착불여부 string 판매자가 입력한 선불/착불여부 내려감
Y: 선불
N: 착불
Data > DeliveryExpense 지마켓 지불 반품/교환배송비 Number 착불일 경우, 사이트 에서 지불한 반품/교환배송비 금액 내려감(추후제공)
Data > ClaimDate 반품/교환입고일시 Date-Time 판매자가 입력한 외부주문 반품/교환입고요청한 일시
YYYY-MM-DD hh:mm:ss형식
Data > UpdDate 반품/교환정보 업데이트일시 Date-Time 판매자가 입력한 외부주문 반품/교환입고정보 업데이트된 일시
YYYY-MM-DD hh:mm:ss형식
Data > SmileOrderNo 스마일주문번호 long 스마일주문번호 내려감
Data > OuterOrderNo 외부주문번호 string 판매자가 입력한 외부주문번호 내려감
Data > BundleType 합포장여부 string 센터에서 검수 후, 해당 SKU 합포장 가능여부 내려감
B : 합포장가능
I : 합포장불가능
Data > OuterCartNo 외부장바구니번호 string 판매자가 입력한 외부장바구니 번호 내려감
Data > OuterGoodsNo 외부상품번호 string 판매자가 입력한 외부상품 번호 내려감
Data > OrderDate 주문일자 Date-Time 주문일자 내려감
Data > GoodsName 상품명 string 판매자 입력한 상품명 내려감
Data > OptValue 옵션명 string 판매자 입력한 옵션명 내려감
Data > RcverInfoNa 수령인명 string 판매자 입력한 수령인명 내려감
Data > RcverInfoCp 수령인휴대폰번호 string 판매자 입력한 수령인휴대폰번호 내려감
Data > RcverInfoHt 수령인일반전화번호 string 판매자 입력한 수령인일반전화번호 내려감
Data > ZipCode 수령인우편번호 string 판매자 입력한 수령인우편번호 내려감
Data > RcverInfoAd1 수령인기본주소 string 판매자 입력한 수령인기본주소 내려감
Data > RcverInfoAd2 수령인상세주소 string 판매자 입력한 수령인상세주소 내려감
Data > Memo 수령인배송메모 string 판매자 입력한 수령인배송메모 내려감
Data > EfmCartSeqNo 내부장바구니관리번호 Int 내부장바구니관리번호 내려감
Data > DeliveryReqDate 출고요청일시 Date-Time 판매자가 출고요청처리한 일시 내려감
Data > ClaimStatus 클레임상태 Int 1 : 반품입고신청
2 : 반품입고완료
3 : 교환입고신청
4 : 교환입고완료
5 : 클레임입고미신청 & 반품입고완료(5번은 추후 제공예정)
Data > WarehouseInDate 수거일시 Int 스마일배송 센터에 수거 도착한 일시
Data > IsReporting Reporting등록여부 Int 검수리포팅이 등록되었는지 여부
1.등록
2.미등록
Data > Reporting > ReturnChangeBlame 이용료부담주체 Int 반품교환배송비귀책
1:판매자
(센터사유 3~11 매칭)
2:지마켓 스마일배송 센터
(센터사유 1~2 매칭
센터사유 1 (택배파손) : 사이트_택배사귀책
센터사유 2 (센터파손) : 사이트_운영사귀책)
3:기타
4:협의후 결정
5:미정 (Reporting 검수중으로 정해지지 않은 경우)
Data > Reporting > ReportingInsDate Reporting 등록일시 DateTime  
Data > Reporting > ReportingUpdDate Reporting 수정일시 DateTime  
Data > Reporting > DistrCenterClaimCode 전체검수결과코드 string 담당자 별도 코드 문의(엑셀로 제공)
Data > Reporting > Memo 결과상세 string  
Data > Reporting > ImageUrl1 []이미지1 string  
Data > Reporting > ImageUrl2 []이미지2 string  
Data > Reporting > ImageUrl3 []이미지3 string  
Data > Reporting > ImageUrl4 []이미지4 string  
Data > Reporting > ImageUrl5 []이미지5 string  
Data > Reporting > ClaimSkuDetail > SkuId []SKU번호 long 해당 주문번호에 포함되는 SKU번호 내려감
Data > Reporting > ClaimSkuDetail > IwScheduledQty []SKU반품/교환입고 예정수량 int 0 또는 정수
Data > Reporting > ClaimSkuDetail > IwDetrmQty []SKU반품/교환입고 확정수량 int 0 또는 정수
Data > Reporting > ClaimSkuDetail > RestockYn []양품화 가능여부 string Y: 가능
N: 불가

JSON_Success

{
  "ResultCode": 0,
  "Message": "string",
  "Data": {
    "TotalCount": 0,
    "PageSize": 0,
    "PageIndex": 0,
    "Data": [
      {
        "OrderDetail": [
          {
            "SkuId": 0,
            "OwQty": 0,
            "BoxSize": "string",
            "DeliveryCompCode": "string",
            "InvoiceNo": "string",
            "InvoiceIssueDate": "2020-02-03T06:58:22.537Z"
            "ItemManageCode": null,
            "StockNo": null
          }
        ],
        "ClaimSeqNo": 0,
        "EfmSeqNo": 0,
        "SiteId": 0,
        "SiteUserInput": "string",
        "ClaimType": "string",
        "DeliveryCompCode": "string",
        "ClaimInvoiceNo": "string",
        "DeliveryPayType": "string",
        "DeliveryExpense": 0,
        "ClaimDate": "2020-02-03T06:58:22.537Z",
        "UpdDate": "2020-02-03T06:58:22.537Z",
        "SmileOrderNo": 0,
        "OuterOrderNo": "string",
        "BundleType": "string",
        "OuterCartNo": 0,
        "OuterGoodsNo": "string",
        "OrderDate": "2020-02-03T06:58:22.537Z",
        "GoodsName": "string",
        "OptValue": "string",
        "RcverInfoNa": "string",
        "RcverInfoCp": "string",
        "RcverInfoHt": "string",
        "RcverInfoAd1": "string",
        "RcverInfoAd2": "string",
        "ZipCode": "string",
        "Memo": "string",
        "EfmCartSeqNo": 0,
        "DeliveryReqDate": "2020-02-03T06:58:22.537Z",
        "ClaimStatus": "string",
        "WarehouseInDate": "2020-02-03T06:58:22.537Z"
        "IsReporting": 0,
        "Reporting": {
          "ClaimSkuDetail": [
            {
              "EfmOrderNo": 0,
              "SkuId": 0,
              "IwScheduledQty": 0,
              "IwDetrmQty": 0,
              "RestockYn": "string",
              "WarehouseNo": 0
            }
          ],
          "DistrCenterClaimCode": "string",
          "Memo": "string",
          "ImageUrl1": "string",
          "ImageUrl2": "string",
          "ImageUrl3": "string",
          "ImageUrl4": "string",
          "ImageUrl5": "string",
          "InsDate": "2021-02-25T23:54:21.002Z",
          "UpdDate": "2021-02-25T23:54:21.002Z",
          "ReturnChangeBlame": 0
        }
      }
    ]
  }
}

 

Sample Code_Success

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "TotalCount": 1,
        "PageSize": 100,
        "PageIndex": 1,
        "Data": [
            {
                "OrderDetail": [
                    {
                        "SkuId": 41741,
                        "OwQty": 1,
                        "BoxSize": null,
                        "DeliveryCompCode": null,
                        "InvoiceNo": null,
                        "InvoiceIssueDate": null
                        "ItemManageCode": null,
                        "StockNo": null
                    },
                    {
                        "SkuId": 41741,
                        "OwQty": 1,
                        "WarehouseNo": 217191730,
                        "BoxSize": null,
                        "DeliveryCompCode": null,
                        "InvoiceNo": null,
                        "InvoiceIssueDate": null
                        "ItemManageCode": null,
                        "StockNo": null
                    }
                ],
                "ClaimSeqNo": 10640,
                "EfmSeqNo": 3266032,
                "SiteId": 24,
                "SiteUserInput": null,
                "ClaimType": "RT",
                "DeliveryCompCode": "10032",
                "ClaimInvoiceNo": "1234",
                "DeliveryPayType": "Y",
                "DeliveryExpense": 0.0,
                "ClaimDate": "2020-01-03T17:28:51.35+09:00",
                "UpdDate": "2020-01-03T17:28:51.35+09:00",
                "SmileOrderNo": 408715,
                "OuterOrderNo": "13000059460401",
                "BundleType": "B",
                "OuterCartNo": 12345678945623123,
                "OuterGoodsNo": "B123456",
                "OrderDate": "2020-01-03T10:39:52.4+09:00",
                "GoodsName": "상품명",
                "OptValue": "색상1",
                "RcverInfoNa": "고객명",
                "RcverInfoCp": "010-1234-5678",
                "RcverInfoHt": "010-1111-2222",
                "RcverInfoAd1": "서울시 강남구 테헤란로 152",
                "RcverInfoAd2": "GFC 35층 ",
                "ZipCode": "15236",
                "Memo": "",
                "EfmCartSeqNo": 449574,
                "DeliveryReqDate": "2020-01-03T17:29:00+09:00",
                "ClaimStatus": "1",
                "WarehouseInDate": "2021-02-03T16:27:22.143",
                "IsReporting": 1,
                "Reporting": {
                    "ClaimSkuDetail": [
                        {
                            "EfmOrderNo": 3312982,
                            "SkuId": 42460,
                            "IwScheduledQty": 1,
                            "IwDetrmQty": 1,
                            "RestockYn": "Y",
                            "WarehouseNo": 217705046
                        }
                    ],
                    "DistrCenterClaimCode": "4",
                    "Memo": "메모",
                    "ImageUrl1": "/inbound/return/reporting/3312982-3/photo1.png",
                    "ImageUrl2": null,
                    "ImageUrl3": null,
                    "ImageUrl4": null,
                    "ImageUrl5": null,
                    "InsDate": "2021-02-03T16:01:17.99",
                    "UpdDate": "2021-02-03T16:01:17.99",
                    "ReturnChangeBlame": 1
                }
            }
        ]
    }
}

Error Code

결과코드 메시지 원인
1400 검색조건 입력 시 외부장바구니번호(OUTER_CART_NO), 외부주문번호(OUTER_ORDER_NO), 스마일주문번호(SMILE_ORDER_NO), 클레임일자(CLAIM_DATE), 반품입고일자(WAREHOUSE_IN_DATE)만 유효합니다. SearchType > 유효하지 않은 값 입력 시
1400 조회일자를 확인해주세요. 시작일자가 유효하지 않습니다. StartDate > SearchType이 일자(DATE)일 때 시작일자 미입력 시
1400 조회일자를 확인해주세요. 미래일자로 설정되어 있습니다. : {입력값} StartDate > 미래일자 입력 시
1400 조회일자를 확인해주세요. 종료일자가 유효하지 않습니다. EndDate > SearchType이 일자(DATE)일 때 종료일자 미입력 시
1400 조회일자를 확인해주세요. 종료일자는 시작일자보다 과거일 수 없습니다. : {입력값} EndDate > 시작일이 종료일보다 과거일 경우
1400 검색어가 필수인 검색조건입니다. 검색어를 입력해주세요. SearchType > 검색어가 필요한 검색조건(외부장바구니번호, 외부주문번호, 스마일주문번호 등)일 때 검색어 미입력 시
1400 숫자 검색어만 입력 가능한 검색조건입니다. : {입력값} SearchString > SearchType이 스마일주문번호일 때 문자열 입력 시
1400 유효하지 않은 클레임처리상태 입니다. ClaimStatus > 유효하지 않은 값 입력 시
1400 PageIndex는 1 이상이어야 합니다. PageIndex > 미입력 or 0 or 음수 입력할 경우
1400 PageSize는 1 이상이어야 합니다. PageSize > 미입력 or 0 or 음수 입력할 경우
1400 PageSize는 최대 1000까지 입력할 수 있습니다. PageSize > 제한값 초과하여 입력했을 경우

 

'스마일배송 API > 외부주문' 카테고리의 다른 글

외부주문 출고요청 API  (0) 2022.11.03
외부주문 출고취소 API  (0) 2022.11.03
외부주문 삭제 API  (0) 2022.11.03
반품/교환입고 등록 API  (0) 2022.11.03
사이트 코드  (0) 2022.10.07