반출현황조회 API

Description

[POST] https://sa2.esmplus.com/efm/v1/api/service/GetWarehouseOutList

판매자가 등록한 반출번호의 반출현황을 조회하는 API입니다.

 

Request Description

항목	항목명	필수여부	Type	Description
WarehouseStatus	반출상태	Y	Int	반출번호의 반출진행상태 ALL : 전체 1 : 반출신청완료 2 : 반출진행중 3 : 반출완료 4 : 반출요청취소
SearchType	조회조건	Y	string	ALL : 전체 WAREHOUSE_NO : 반출번호로 조회 SKU_ID : SKU번호로 조회 REGISTER_DATE : 반출등록일자 조회 CANCEL_DATE : 반출취소일자 조회 COMPLETE_DATE : 반출완료일자 조회 WISH_DATE : 반출희망일자 조회
SearchString	상세검색		string	검색조건 > WAREHOUSE_NO / SKU_ID 선택 시 필수 이 때, 날짜검색조건 무시
StartDate	조회시작일자		Date-Time	검색조건 일자 조회일 경우 필수
EndDate	조회종료일자		Date-Time	검색조건 일자 조회일 경우 필수
pageIndex	페이지번호	Y	Int	정수: Page 구분
pageSize	페이지사이즈	Y	Int	1페이지에 출력하려는 리스트 Max값 1000까지 지원 가능

JSON
{
  "WarehouseStatus": "ALL",
  "SearchType": "ALL",
  "SearchString": "",
  "StartDate": "2021-02-18T16:32:12.785Z",
  "EndDate": "2021-02-18T16:32:12.785Z",
  "PageIndex": 1,
  "PageSize": 100
}

 

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 > WarehouseOutNo	반출번호	long	조회된 반출번호 내려감
Data > WarehouseStatus	반출상태	Int	1 : 반출신청완료 2 : 반출진행중 3 : 반출완료 4 : 반출요청취소
Data > WarehouseName	반출명	string	판매자가 입력한 반출명 내려감
Data > RcverInfoNa	반출담당자성함	string	판매자가 입력한 담당자성함 내려감
Data > InsDate	반출등록일시	DateTime
Data > RcverInfoHt	반출담당자연락처	string	판매자가 입력한 담당자연락처 내려감
Data > OutWishDate	반출희망일시	DateTime
Data > RcverInfoCp	반출담당자휴대폰번호	string	판매자가 입력한 담당자휴대폰번호 내려감
Data > CompleteDate	반출완료일시	DateTime
Data > ZipCode	반출택배주소 우편번호	string	판매자가 입력한 반출할 주소 우편번호 내려감
Data > CancelDate	반출취소일시	DateTime
Data > RcverAddress	반출택배주소	string	판매자가 입력한 반출할 주소 내려감
Data > OutCode	반출방식	Int	판매자가 선택한 반출방식 내려감 1. 택배반출 2. 차량반출(AJU) 3. 차량반출(KPP) 4. 방문(직접회수)
Data > StorageType	창고구분	Int
Data > StorageDesc	창고명	string
Data > OutDetail > SkuId	[]SKU번호	long	반출된 SKU번호 내려감
Data > OutDetail > SkuStockCode	[]SKU재고유형	string	반출된 SKU재고유형 내려감 SA : 판매가능재고 UP : 신규주문재고 HS : 일반보류재고 RH : 반품보류재고 EH : 소비기한보류재고
Data > OutDetail > OutReqQty	[]SKU반출요청수량	string	반출된 SKU반출요청수량 내려감
Data > OutDetail > OutDetrmQty	[]SKU반출수량	string	반출된 SKU반출수량 내려감
Data > OutDetail > DeliveryCompCode	[]택배사명	string	스마일배송 물류센터에서 발송한 택배사명 내려감(택배사코드는 나중에 적용됨)
Data > OutDetail > InvoiceNo	[]송장번호	string	스마일배송 물류센터에서 발송한 송장번호 내려감
Data > OutDetail > Memo	[]메모	string	스마일배송 물류센터에서 입력한 메모 내려감
Data > StorageType	창고구분	string	입고된 창고구분 내려감
Data > StorageDesc	창고명	string	입고된 창고명 내려감

JSON_Success

{
  "ResultCode": 0,
  "Message": "string",
  "Data": {
    "TotalCount": 0,
    "PageSize": 0,
    "PageIndex": 0,
    "Data": [
      {
        "OutDetail": [
          {
            "SkuId": 0,
            "SkuName": "string",
            "SkuStockCode": "string",
            "OutReqQty": 0,
            "OutDetrmQty": 0,
            "DeliveryCompCode": "string",
            "InvoiceNo": "string",
            "Memo": "string"
          }
        ],
        "WarehouseOutNo": 0,
        "WarehouseStatus": 0,
        "WarehouseName": "string",
        "RcverInfoNa": "string",
        "RcverInfoHt": "string",
        "RcverInfoCp": "string",
        "ZipCode": "string",
        "RcverAddress": "string",
        "OutCode": 0,
        "StorageType": 0,
        "StorageDesc": "string",
        "InsDate": "2021-02-18T16:32:12.946Z",
        "OutWishDate": "2021-02-18T16:32:12.946Z",
        "CompleteDate": "2021-02-18T16:32:12.946Z",
        "CancelDate": "2021-02-18T16:32:12.946Z"
      }
    ]
  }
}

 

Sample Code_Success

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "TotalCount": 1,
        "PageSize": 100,
        "PageIndex": 1,
        "Data": [
            {
                "OutDetail": [
                    {
                        "SkuId": 41347,
                        "SkuName": "SKU명",
                        "SkuStockCode": "SA",
                        "OutReqQty": 1,
                        "OutDetrmQty": 0,
                        "DeliveryCompCode": null,
                        "InvoiceNo": null,
                        "Memo": ""
                    }
                ],
                "WarehouseOutNo": 217781630,
                "WarehouseStatus": 1,
                "WarehouseName": "반출명",
                "RcverInfoNa": "인수자",
                "RcverInfoHt": "010-1234-5678",
                "RcverInfoCp": "070-1234-5678",
                "ZipCode": "27858",
                "RcverAddress": "서울특별시 강남구 테헤란로 인수자앞",
                "OutCode": 2,
                "StorageType": 14,
                "StorageDesc": "스마일배송 동탄메가센터 3층 3R",
                "SkuStockType": 1,
                "InsDate": "2021-02-19T00:34:15.173",
                "OutWishDate": "2021-02-25T12:00:00",
                "CompleteDate": null,
                "CancelDate": null
            }
        ]
    }
}

 

Error Code

결과코드	메시지	원인
1400	반출상태는 필수 입력값입니다. 반출상태 전체일 경우 ALL을 입력해주세요.	WarehouseStatus > 반출상태 미입력 혹은 빈 값 입력 시
1400	반출상태는 숫자만 입력 가능합니다.	WarehouseStatus > 문자열 입력 시
1400	유효하지 않은 반출상태입니다.	WarehouseStatus > 유효하지 않은 반출상태 입력 시
1400	조회조건은 필수 입력값입니다. 전체를 조회할 경우 ALL을 입력해주세요.	SearchType > 미입력 시
1400	조회조건 입력 시 반출번호(WAREHOUSE_NO), SKU번호(SKU_ID), 반출등록일자(REGISTER_DATE), 반출취소일자(CANCEL_DATE), 반출완료일자(COMPLETE_DATE), 반출희망일자(WISH_DATE)만 유효합니다.	SearchType > 유효하지 않은 값 입력 시
1400	조회일자를 확인해주세요. 시작일자가 유효하지 않습니다.	StartDate > SearchType이 일자(DATE)일 때 시작일자 미입력 시
1400	조회일자를 확인해주세요. 종료일자가 유효하지 않습니다.	EndDate > SearchType이 일자(DATE)일 때 종료일자 미입력 시
1400	조회일자를 확인해주세요. 종료일자는 시작일자보다 과거일 수 없습니다.	EndDate > 종료일자가 시작일자보다 과거일 경우
1400	검색어가 필수인 검색조건입니다. 검색어를 입력해주세요.	SearchType > 검색어가 필요한 검색조건(입고번호, SKU번호 등)일 때 검색어 미입력 시
1400	숫자 검색어만 입력 가능한 검색조건입니다. : {입력값}	SearchString > SearchType이 반출번호, SKU번호일 때 문자열 입력 시
1400	PageIndex는 1 이상이어야 합니다.	PageIndex > 미입력 or 0 or 음수 입력할 경우
1400	PageSize는 1 이상이어야 합니다.	PageSize > 미입력 or 0 or 음수 입력할 경우
1400	PageSize는 최대 1000까지 입력할 수 있습니다.	PageSize > 제한값 초과하여 입력했을 경우