물류카테고리 조회 API

Description

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

물류카테고리 및 카테고리별 소비기한을 조회합니다.

 

Request Description

항목	항목명	필수여부	Type	Description
SearchType	조회조건	Y	int	0 : 검색어 조건 없이 전체 카테고리 조회 1: 카테고리 명 2: 카테고리 코드
SearchString	검색어		string	SearchType > 1 or 2일 경우 필수 조회할 검색어 입력
ExpireDateManageCode	소비기한관리구분	Y	int	카테고리 조회 시, 소비기한 관리구분에 따른 조회 가능 필수 or 선택 시 소비기한(상미기일)구간 중 택1하여 입력 ALL : 전체 1 : 소비기한 관리필수 2 : 소비기한 미관리 3 : 소비기한 관리선택
ExpireDaysLimitCode	소비기한(상미기일)코드		string	소비기한(상미기일) 특정코드를 보유한 카테고리 조회 ALL : 전체 단일코드 입력 가능
PageIndex	페이지번호	Y	Int	정수: Page 구분
PageSize	페이지사이즈	Y	Int	1페이지에 출력하려는 리스트 Max값 1000까지 지원 가능

JSON
{
  "SearchType": 0,
  "SearchString": "",
  "ExpireDateManageCode": "ALL",
  "ExpireDaysLimitCode": "ALL",
  "PageIndex": 1,
  "PageSize": 100
}

 

Response Description

항목	항목명	Type	Description
ResultCode	결과코드	int	성공: 0 실패 :Error Massage 참고
Message	메시지	string
Data	Data	string
Data > TotalCount	전체대상건수	int	조회조건 범위 전체 건수
Data > PageIndex	Response PageNo	int	조회시 입력한 PageNo
Data > PageSize	Response PageSize	Int	조회시 입력한 PageSize
Data > Data > ExpireDaysLimitCodeList[]	소비기한(상미기일)코드리스트	int	해당카테고리에 설정가능한 소비기한(상미기일) 코드 리스트 내려감
Data > Data > CategoryCode	물류최하위카테고리코드	string	조회된 물류카테고리 Leaf코드 내려감
Data > Data > CategoryLevel	카테고리구분	string	리프카테고리가 대/중/소분류 중 무엇인지 구분값 내려감 1 : 대분류 2 : 중분류 3 : 소분류
Data > Data > CategoryName1	대분류카테고리명	string	조회된 물류 대분류카테고리명 내려감
Data > Data > CategoryName2	중분류카테고리명	string	조회된 물류 중분류카테고리명 내려감
Data > Data > CategoryName3	소분류카테고리명	string	조회된 물류 소분류카테고리명 내려감
Data > Data > ExpireDateManageCode	소비기한관리구분	int	1 : 소비기한 관리필수 2 : 소비기한 미관리 3 : 소비기한 관리선택
Data > Data > InsDate	등록일자	DateTime	물류최하위카테고리 코드의 등록일자 내려감
Data > Data > UpdDate	최종변경일자	DateTime	물류최하위카테고리 코드 정보의 변경일자 내려감

 JSON_Success

{
  "ResultCode": 0,
  "Message": "",
  "Data": {
    "TotalCount": 0,
    "PageSize": 0,
    "PageIndex": 0,
    "Data": [
      {
        "ExpireDaysLimitCodeList": [
          0
        ],
        "CategoryCode": "",
        "CategoryLevel": "",
        "CategoryName1": "",
        "CategoryName2": "",
        "CategoryName3": "",
        "ExpireDateManageCode": "",
        "InsDate": "2020-05-29T00:04:03.266Z",
        "UpdDate": "2020-05-29T00:04:03.266Z"
      }
    ]
  }
}

JSON_Fail

{
    "ResultCode": int,
    "Message": "string",
    "Data": null
}

Sample Code_Success

{
    "ResultCode": 0,
    "Message": "success",
    "Data": {
        "TotalCount": 3,
        "PageSize": 3,
        "PageIndex": 1,
        "Data": [
            {
                "ExpireDaysLimitList": [
                    5
                ],
                "CategoryCode": "C001009001",
                "CategoryLevel": "3",
                "CategoryName1": "식품",
                "CategoryName2": "커피/차류",
                "CategoryName3": "커피믹스/코코아",
                "ExpireDateManageCode": "1",
                "InsDate": "2018-11-01T11:12:39.013",
                "UpdDate": "2018-11-01T11:12:39.013"
            },
            {
                "ExpireDaysLimitList": [
                    5
                ],
                "CategoryCode": "C001009002",
                "CategoryLevel": "3",
                "CategoryName1": "식품",
                "CategoryName2": "커피/차류",
                "CategoryName3": "액상차류",
                "ExpireDateManageCode": "1",
                "InsDate": "2018-11-01T11:12:39.013",
                "UpdDate": "2018-11-01T11:12:39.013"
            },
            {
                "ExpireDaysLimitList": [
                    7,
                    8
                ],
                "CategoryCode": "C001009003",
                "CategoryLevel": "3",
                "CategoryName1": "식품",
                "CategoryName2": "커피/차류",
                "CategoryName3": "녹차/홍차/티백차",
                "ExpireDateManageCode": "1",
                "InsDate": "2018-11-01T11:12:39.013",
                "UpdDate": "2018-11-01T11:12:39.013"
            }
        ]
    }

Sample Code_Fail

{
    "ResultCode": 1400,
    "Message": "소비기한관리구분은 전체(ALL), 필수(1), 미관리(2), 선택(3) 중에서만 조회 가능합니다.",
    "Data": null
}

 

Error Code

결과코드	메시지	원인
1400	조회조건 입력 시 전체(0), 카테고리명(1), 카테고리코드(2)만 유효합니다.	SearchType > 유효하지 않은 값 입력 시
1400	검색어가 필수인 검색조건입니다. 검색어를 입력해주세요.	SearchString > SearchType이 카테고리명(1), 카테고리코드(2) 일 때 미입력 시
1400	검색어은/는 최대 1000Byte까지만 입력 가능합니다. 입력값:{입력값}	SearchString > 제한값 초과하여 입력했을 경우
1400	소비기한관리구분은 전체(ALL), 필수(1), 미관리(2), 선택(3) 중에서만 조회 가능합니다.	ExpireDateManageCode > 유효하지 않은 값 입력 시
1400	PageIndex는 1 이상이어야 합니다.	PageIndex > 미입력 시
1400	PageSize는 1 이상이어야 합니다.	PageSize > 미입력 시
1400	PageSize는 최대 1000까지 입력할 수 있습니다.	PageSize > 제한값 초과하여 입력했을 경우