본문 바로가기
상품API/옵션 | 추가구성 API

추천옵션 항목 조회 API

Description
카테고리별 추천옵션 조회 : [GET] https://sa2.esmplus.com/item/v1/options/recommended-opts?catCode={siteCatCode}
추천옵션별 선택항목 조회 : [GET] https://sa2.esmplus.com/item/v1/options/recommended-opts/{recommendedOptNo}
카테고리별 추천옵션 조회시 recommendedOptNo = 0 이 포함된 경우 해당 카테고리는 직접입력 옵션 허용됩니다.
선택형(2, 3개 조합 포함), 텍스트형 직접입력 허용 여부가 카테고리별로 다르니 등록 가능한 옵션 유형 확인하시길 바랍니다.

카테고리별 추천옵션 조회시 조회하는 사이트 ID 만 포함된 인증토큰으로 조회하셔야 합니다.
(지마켓 카테고리 조회시 지마켓 ID 만 포함된 인증토큰으로, 옥션 카테고리 조회시 옥션 ID 만 포함된 인증토큰으로)

 

Request Description

카테고리별 추천옵션 조회

항목 항목명 필수여부 Type Description
siteCatCode 사이트 카테고리 코드 Y path  

추천옵션별 선택 항목 조회

항목 항목명 필수여부 Type Description
recommendedOptNo 추천옵션코드 Y path ※ 0 : 직접입력 경우 조회 항목 없음
JSON
카테고리별 추천옵션코드 조회
[GET] https://sa2.esmplus.com/item/v1/options/recommended-opts?catCode=300023931

추천옵션별 선택항목코드 조회
[GET] https://sa2.esmplus.com/item/v1/options/recommended-opts/976

 

Response Description

카테고리별 추천옵션 조회

항목 항목명 Type Description
recommendedOptNo 추천옵션 코드 int  
recommendedOptName > kor 추천옵션 한글명 string  
recommendedOptName > eng 추천옵션 영문명 string  
recommendedOptName > chi 추천옵션 중문명 string  
recommendedOptName > jpn 추천옵션 일문명 string  
recommendedOptTypeName 추천옵션 유형명 string  

추천옵션별 선택 항목 조회

항목 항목명 Type Description
type 유형코드 int  
typeName 추천옵션 유형명 string  
recommendedOptNo 추천옵션 코드 int  
recommendedOptName > kor 추천옵션 한글명 string  
recommendedOptName > eng 추천옵션 영문명 string  
recommendedOptName > chi 추천옵션 중문명 string  
recommendedOptName > jpn 추천옵션 일문명 string  
isTextOption 텍스트형 여부 boolean  
recommendedOptValueNo 추천옵션값 코드 int "recommendedOptValueNo": 0 이 포함된 경우만
옵션값 직접입력 가능
recommendedOptValueName > korEng   string  
recommendedOptValueName > kor 추천옵션값 한글명 string  
recommendedOptValueName > eng 추천옵션값 영문명 string  
ecommendedOptValueName > chi 추천옵션값 중문명 string  
ecommendedOptValueName > jpn 추천옵션값 일문명 string  

 

JSON_Success

카테고리별 추천옵션 조회시
{
    "details": [
        {
            "recommendedOptNo": 976,
            "recommendedOptName": {
                "kor": "사이즈",
                "eng": "Size",
                "chi": "尺寸",
                "jpn": "サイズ"
            },
            "recommendedOptTypeName": "의류"
        },
        {
            "recommendedOptNo": 1,
            "recommendedOptName": {
                "kor": "색상",
                "eng": "Color",
                "chi": "颜色",
                "jpn": "いろ"
            },
            "recommendedOptTypeName": "공통"
        },
        {
            "recommendedOptNo": 0,
            "recommendedOptName": {
                "kor": "직접입력",
                "eng": null,
                "chi": null,
                "jpn": null
            },
            "recommendedOptTypeName": "선택형"
        }
    ]
}

추천옵션별 선택항목 조회시
{
    "type": 1,
    "typeName": "공통",
    "recommendedOptNo": 1,
    "recommendedOptName": {
        "kor": "색상",
        "eng": "Color",
        "chi": "颜色",
        "jpn": "いろ"
    },
    "isTextOption": false,
    "details": [
        {
            "recommendedOptValueNo": 0,
            "recommendedOptValueName": {
                "korEng": null,
                "kor": null,
                "eng": null,
                "chi": null,
                "jpn": null
            }
        },
        {
            "recommendedOptValueNo": 9,
            "recommendedOptValueName": {
                "korEng": "네이비",
                "kor": "네이비",
                "eng": "Navy",
                "chi": "藏青色",
                "jpn": "ネイビー"
            }
        },
        {
            "recommendedOptValueNo": 15,
            "recommendedOptValueName": {
                "korEng": "",
                "kor": "골드(금)",
                "eng": "Gold",
                "chi": "金色",
                "jpn": ""
            }
        },
        {
            "recommendedOptValueNo": 16,
            "recommendedOptValueName": {
                "korEng": "",
                "kor": "실버(은)",
                "eng": "Silver",
                "chi": "银色",
                "jpn": ""
            }
        }
    ]
}

JSON_Fail

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

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "조회 된 데이터가 없습니다."
}