추가구성 항목 조회 API

Description

[GET] https://sa2.esmplus.com/item/v1/addon-service/{sdCatCode}

ESM 카테고리 기준으로 등록 가능 추가구성 유형과 항목을 조회 합니다.

Request Description

항목	항목명	필수여부	Type	Description
sdCatCode	ESM 카테고리코드	Y	path

JSON
URL만 호출 / Request Body 없음
[GET] https://sa2.esmplus.com/item/v1/addon-service/{sdCatCode}

 

Response Description

항목	항목명	필수여부	Type	Description
type	추가구성유형		int	1 : 선택형 2 : 판매자 입력형 3 : 텍스트형
limitCount	상품당 항목개수 제한		int	상품당 입력 가능 항목수
valueLimitCount	항목값 개수 제한		int	최대 입력 가능 항목수
priceType	추가금 유형		int	1 : 판매가 기준 2 : 특정금액 기준
minPrice	추가금 최소 입력값		int	최소 입력 가능한 추가금액
maxPrice	추가금 최대입력값		int	최대 입력 가능한 추가금액
addonServiceName	추가구성 항목명		string
addonServiceNameId	추가구성 항목 코드		int
addonServiceValues > valueName	추가구성 항목값명		string
addonServiceValues > valueId	추가구성 항목값 코드		int

JSON_Success

[
  {
    "type": 0,
    "valueLimitCount": 0,
    "limitCount": 0,
    "priceType": 0,
    "minPrice": 0,
    "maxPrice": 0,
    "addonServiceName": "string",
    "addonServiceNameId": 0,
    "addonServiceValues": [
      {
        "valueName": "string",
        "valueId": 0
      }
    ]
  }
]

JSON_Fail

{
   "resultCode": 0,
   "message": "string"
}

Sample Code_Success

[
    {
        "type": 2,
        "valueLimitCount": 10,
        "limitCount": 3,
        "priceType": 2,
        "minPrice": 0,
        "maxPrice": 0,
        "addonServiceName": "사은품",
        "addonServiceNameId": 6,
        "addonServiceValues": []
    },
    {
        "type": 3,
        "valueLimitCount": 0,
        "limitCount": 3,
        "priceType": 2,
        "minPrice": 0,
        "maxPrice": 3000,
        "addonServiceName": "감사 메세지",
        "addonServiceNameId": 8,
        "addonServiceValues": []
    },
    {
        "type": 1,
        "valueLimitCount": 0,
        "limitCount": 3,
        "priceType": 2,
        "minPrice": 0,
        "maxPrice": 5000,
        "addonServiceName": "선물포장 타입",
        "addonServiceNameId": 1007,
        "addonServiceValues": [
            {
                "valueName": "보자기",
                "valueId": 1003
            },
            {
                "valueName": "쇼핑백",
                "valueId": 1004
            },
            {
                "valueName": "케이스",
                "valueId": 1005
            },
            {
                "valueName": "박스포장",
                "valueId": 1006
            },
            {
                "valueName": "보냉박스",
                "valueId": 1007
            },
            {
                "valueName": "선물용 박스",
                "valueId": 1008
            },
            {
                "valueName": "리본",
                "valueId": 1009
            }
        ]
    },
    {
        "type": 3,
        "valueLimitCount": 0,
        "limitCount": 3,
        "priceType": 2,
        "minPrice": 0,
        "maxPrice": 3000,
        "addonServiceName": "발송자 표시",
        "addonServiceNameId": 1008,
        "addonServiceValues": []
    }
]

Sample Code_Fail

{
    "resultCode": 3000,
    "message": "00290001000100010000 카테고리코드는 추가구성 사용불가능한 카테고리입니다."
}

Error Code

결과코드	메시지	원인
3000	추가구성정보는 ESM(SD) 최하위 카테고리코드로만 조회가능합니다.	조회한 카테고리가 리프 카테고리가 아닌 경우
3000	카테고리코드는 추가구성 사용불가능한 카테고리입니다	추가구성 사용 불가 카테고리인 경우