본문 바로가기
스마일배송 API/입고 | 반출

입고현황조회 API

Description
[POST] https://sa2.esmplus.com/efm/v1/api/service/GetWarehouseInList
판매자가 등록한 입고번호의 입고현황을 조회하는 API입니다.

 

Request Description

항목 항목명 필수여부 Type Description
WarehouseStatus 입고상태 Y Int 입고번호의 현재 입고진행상태
ALL : 전체
1 : 입고대기
2 : 입고완료
3 : 하차스캔
4 : 검수
5 : 반송
6 : 취소
7 : 등록중(EFM 미노출)
SearchType 조회조건 Y string
ALL : 전체
WAREHOUSE_NO : 입고번호로 조회 (ASN_NO 가능)
SKU_ID : SKU번호로 조회
REGISTER_DATE : 입고등록일자 조회
CANCEL_DATE : 입고취소일자 조회
COMPLETE_DATE : 입고완료일자 조회
SCHEDULED_DATE : 입고예정일자 조회
SCAN_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-01-06T00:00:00.000Z",
  "EndDate": "2021-01-09T00:00:00.000Z",
  "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 > WarehouseNo 입고번호 long 조회된 입고번호 내려감
Data > WarehouseStatus 입고상태 Int 1 : 입고대기
2 : 입고완료
3 : 하차스캔
4 : 검수
5 : 반송
6 : 취소
7 : 등록중
Data > WarehouseName 입고명 string 판매자가 입력한 입고명 내려감
Data > IwMthdType 입고방식 Int 판매자가 선택한 입고방식 내려감
1. 화물입고
2. 택배입고
3. 밀크런
Data > InsDate 입고등록일시 DateTime  
Data > IwScheduledDate 입고예정일시 DateTime  
Data > CompleteDate 입고완료일시 DateTime  
Data > CancelDate 입고취소일시 DateTime  
Data > ScanDate 하차스캔일시 DateTime  
Data > DeliveryCompCode 택배사코드 string 입력된 택배사코드 내려감
Data > InvoiceNo 송장번호 string 입력된 송장번호 내려감
Data > IwDetail > SkuId []SKU번호 long 입고된 SKU번호 내려감
Data > IwDetail > SkuName []SKU명 string 입고된 SKU명 내려감
Data > IwDetail > StockQty []현재수량 Int 해당 SKU의 현재수량 내려감
Data > IwDetail > IwScheduledQty []입고예정수량 Int 해당 SKU의 입고예정수량 내려감
Data > IwDetail > IwDetrmQty []입고완료수량 Int 해당 SKU의 입고완료수량 내려감
Data > IwDetail > IwReasonCode []입고오류코드 string 해당 SKU의 입고오류코드 내려감
OR : 과입고
PR : 부분 미입고
NR : 전체 미입고
ES : 바코드스캔오류
EB : 바코드오류
ER : 오입고(타상품 입고)
EE : 소비기한오류
EU :입수오류
ET : 출고타입오류
D : 파손
EC : 기타
CR : 입고취소
Data > IwDetail > IwReasonMsg []입고오류사유 string 해당 SKU의 입고오류사유 내려감
Data > StorageType 창고구분 string 입고된 창고구분 내려감
Data > StorageDesc 창고명 string 입고된 창고명 내려감


JSON_Success

{
  "ResultCode": 0,
  "Message": "",
  "Data": {
    "TotalCount": 0,
    "PageSize": 0,
    "PageIndex": 0,
    "Data": [
      {
        "IwDetail": [
          {
            "SkuId": 0,
            "SkuName": "",
            "StockQty": 0,
            "IwScheduledQty": 0,
            "IwDetrmQty": 0,
            "IwReasonCode": "",
            "IwReasonMsg": ""
          }
        ],
        "WarehouseNo": 0,
        "WarehouseStatus": 0,
        "WarehouseName": "",
        "IwMthdType": 0,
        "StorageType": 0,
        "StorageDesc": "",
        "InsDate": "2021-02-18T14:08:04.944Z",
        "IwScheduledDate": "2021-02-18T14:08:04.944Z",
        "CompleteDate": "2021-02-18T14:08:04.944Z",
        "CancelDate": "2021-02-18T14:08:04.944Z",
        "ScanDate": "2021-02-18T14:08:04.944Z",
        "DeliveryCompCode": "",
        "InvoiceNo": ""
      }
    ]
  }
}

 

Sample Code_Success

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "TotalCount": 1,
        "PageSize": 100,
        "PageIndex": 1,
        "Data": [
            {
                "IwDetail": [
                    {
                        "SkuId": 42887,
                        "SkuName": "테스트SKU",
                        "StockQty": 2,
                        "IwScheduledQty": 1,
                        "IwDetrmQty": 0,
                        "IwReasonCode": null,
                        "IwReasonMsg": null
                    }
                ],
                "WarehouseNo": 217729807,
                "WarehouseStatus": 6,
                "WarehouseName": "입고명",
                "IwMthdType": 1,
                "StorageType": 15,
                "StorageDesc": "스마일배송 물류센터 4층",
                "InsDate": "2021-02-09T07:56:37.18",
                "IwScheduledDate": "2021-02-15T09:00:00",
                "CompleteDate": null,
                "CancelDate": "2021-02-13T23:08:21.277",
                "ScanDate": null,
                "DeliveryCompCode": null,
                "InvoiceNo": 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), 입고예정일자(SCHEDULED_DATE), 하차스캔일자(SCAN_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 > 제한값 초과하여 입력했을 경우

 

'스마일배송 API > 입고 | 반출' 카테고리의 다른 글

입고등록 API  (0) 2022.11.03
입고요청취소 API  (0) 2022.11.03
입고수용량조회 API  (0) 2022.11.03
반출요청 API  (0) 2022.11.03
반출요청취소 API  (0) 2022.11.03