추천옵션 관리 API

Description

등록/수정 : [PUT] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/recommended-options 조회 : [GET] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/recommended-options

선택형 (2, 3개 조합 포함) / 텍스트형 / 계산형 옵션 등록/수정 할 수 있습니다. 카테고리별 사용 가능한 주문옵션의 유형이 다르므로 추천옵션코드/선택항목코드 조회 API를 통해 조회된 코드를 사용합니다. 선택형은 최대 50개까지, 조합형은 500개까지 등록 가능합니다. 추천옵션은 G마켓/옥션 등록 카테고리 내 추천옵션 모두 허용시 등록/수정 가능 합니다.

 

Request Description

항목	항목명	필수여부	Type	Description
type	추천옵션 타입	Y	int	0 : 옵션 미사용 1 : 선택형, independent 로 입력 2 : 2개 조합형, combination 로 입력 3 : 3개 조합형, combination 로 입력 4 : 계산형, calculation 로 입력 5 : 텍스트형, text 로 입력 6 : 선택형 + 텍스트형 7 : 2개조합형 + 텍스트형 8 : 3개 조합형 + 텍스트형 9 : 선택형 + 계산형
isStockManage	옵션재고관리	Y	boolean	- 추천옵션 사용일 경우 필수 - 텍스트형 경우 false 로 연동
independent/combination > recommendedOptNo	(선택형/조합형) 추천옵션코드	Y	int	추천옵션코드조회 API 로 확인후 입력
independent > recommendedOptName > koreanText	(선택형/조합형) 추천옵션명 (국문) 직접입력		string	직접입력 허용 카테고리에 옵션명 직접입력 설정하는 경우
independent > recommendedOptName > englishText	(선택형/조합형) 추천옵션명 (영문) 직접입력		string
independent > recommendedOptName > chineseText	(선택형/조합형) 추천옵션명 (중문) 직접입력		string
independent > recommendedOptName > japaneseText	(선택형/조합형) 추천옵션명 (일문) 직접입력		string
independent > recommendedOptName > exposeLanguage	노출언어 선택		int	1 : 한국어 2 : 영어 한글 표시 3 : 영어 *조회 API 는 0 으로만 내려감
independent > details > recommendedOptValueNo	(선택형/조합형) 추천옵션항목코드	Y	int	추천옵션코드조회 API 로 확인후 입력
independent > details > recommendedOptValue > koreanText	(선택형/조합형) 추천옵션항목 (국문)직접입력		string	- 추천옵션항목코드 대신 직접입력 경우 - 색상 등 직접입력 허용 추천옵션코드에서만 사용 가능
independent > details > recommendedOptValue > englishText	(선택형/조합형) 추천옵션항목 (영문)직접입력		string
independent > details > recommendedOptValue > chineseText	(선택형/조합형) 추천옵션항목 (중문)직접입력		string
independent > details > recommendedOptValue > japaneseText	(선택형/조합형) 추천옵션항목 (일문)직접입력		string
independent > details > recommendedOptValue > exposeLanguage	노출언어 선택			- 다국어 중 노출되고 싶은 언어 선택 1 :한국어 2: 영어한글표시 3: 영어 - 직접입력 경우 영어한글표시가 없기때문에 한국어가 영어한글표시로 들어감 - 조회시 무조건 0으로 내려감
independent > details > imageUrl	옵션 이미지 url			사용하지 않음, 입력 불가
independent > details > isSoldOut	(선택형/조합형) 품절여부	Y	boolean	- 옵션 품절여부 제어 - 옵션 재고수량으로 제어하지 않음 true : 품절 false : 판매
independent > details > isDisplay	(선택형/조합형) 노출여부	Y	boolean	- 옵션 노출여부 제어 true : 노출 false : 미노출
independent > details > qty > gmkt	(선택형/조합형) G마켓 재고수량	Y	int	- 옥션 옵션 재고수량 입력 - 1~99999로 설정
independent > details > qty > iac	(선택형/조합형) 옥션 재고수량	Y	int	- G마켓 옵션 재고수량 입력 - 1~99999로 설정
independent > details > manageCode	(선택형/조합형) 판매자옵션관리코드		string	- 판매자 관리 코드 입력 - 20 byte 이내 입력 가능
independent > details > skuInfo > skuId	SKU 번호		int	- 스마일배송 상품 경우만 사용 - 해당 추천옵션의 SKU코드 입력
independent > details > skuInfo > owQty	SKU 출고방식		int	- 스마일배송 상품 경우만 사용 -해당 추천옵션 SKU당 출고수 입력
independent > details > addAmnt	주문옵션 추가금			- 2천원 미만 (0 ~ 100%) - 1만원 미만 (-50 ~ 100%) - 1만원이상 (기본값 -50 ~ 50%, 일부 카테고리 별도 정책)
text > details > isDisplay	(텍스트형) 노출여부		boolean	- 텍스트형 사용할 경우 필수 - 텍스트형을 상품상세페이지에 노출할 것인지 여부 설정 true : 노출 false : 미노출
text > details > recommendedOptNo	(텍스트형) 추천옵션코드		int	추천옵션코드조회 API 로 확인후 입력
text > details > Value	(텍스트형) 텍스트형 옵션명		string	텍스트형 옵션명 직접입력 설정하는 경우
calculation > name1 > kor	(계산형) 옵션명1		string
calculation > name2 > kor	(계산형) 옵션명2		string
calculation > minValue1	(계산형) 옵션명1 (name 1) 판매 최소값		int	1 이상 입력 가능
calculation > minValue2	(계산형) 옵션명2 (name 2) 판매 최소값		int	1 이상 입력 가능
calculation > maxValue1	(계산형) 옵션명1 (name 1) 판매 최대값		int	1 이상 입력 가능
calculation > maxValue2	(계산형) 옵션명2 (name 2) 판매 최대값		int	1 이상 입력 가능
calculation > unitPrice	(계산형) 단가 기준값		int	1 이상 입력 가능
calculation > unitType	(계산형) 판매 단위		string	"mm", "cm", "m", "mg", "g", "kg", "ml", "l“ 만 입력 가능
calculation > unitValue	(계산형) 판매 단위값		int	1 이상 입력 가능
calculation > manageCode	(계산형) 옵션관리코드		string	20 byte 이내 입력 가능

JSON
등록/수정
{
  "type": "Unknown",
  "isStockManage": true,
  "independent": {
    "details": [
      {
        "recommendedOptValueNo": 0,
        "recommendedOptValue": {
          "koreanText": "string",
          "englishText": "string",
          "chineseText": "string",
          "japaneseText": "string",
          "exposeLanguage": "Unknown"
        },
        "imageUrl": "string",
        "isSoldOut": true,
        "isDisplay": true,
        "qty": {
          "iac": 0,
          "gmkt": 0
        },
        "manageCode": "string",
        "skuInfo": [
          {
            "skuId": 0,
            "owQty": 0
          }
        ],
        "addAmnt": 0
      }
    ],
    "recommendedOptNo": 0,
    "recommendedOptName": {
      "koreanText": "string",
      "englishText": "string",
      "chineseText": "string",
      "japaneseText": "string",
      "exposeLanguage": "Unknown"
    }
  },
  "combination": {
    "details": [
      {
        "recommendedOptValueNo1": 0,
        "recommendedOptValueNo2": 0,
        "recommendedOptValueNo3": 0,
        "recommendedOptValue1": {
          "koreanText": "string",
          "englishText": "string",
          "chineseText": "string",
          "japaneseText": "string",
          "exposeLanguage": "Unknown"
        },
        "recommendedOptValue2": {
          "koreanText": "string",
          "englishText": "string",
          "chineseText": "string",
          "japaneseText": "string",
          "exposeLanguage": "Unknown"
        },
        "recommendedOptValue3": {
          "koreanText": "string",
          "englishText": "string",
          "chineseText": "string",
          "japaneseText": "string",
          "exposeLanguage": "Unknown"
        },
        "isSoldOut": true,
        "isDisplay": true,
        "qty": {
          "iac": 0,
          "gmkt": 0
        },
        "manageCode": "string",
        "skuInfo": [
          {
            "skuId": 0,
            "owQty": 0
          }
        ],
        "addAmnt": 0
      }
    ],
    "recommendedOptNo1": 0,
    "recommendedOptNo2": 0,
    "recommendedOptNo3": 0,
    "imageInfo": {
      "imageLevel": 0,
      "details": [
        {
          "recommendedOptValueNo": 0,
          "imageUrl": "string"
        }
      ]
    },
    "recommendedOptName1": {
      "koreanText": "string",
      "englishText": "string",
      "chineseText": "string",
      "japaneseText": "string",
      "exposeLanguage": "Unknown"
    },
    "recommendedOptName2": {
      "koreanText": "string",
      "englishText": "string",
      "chineseText": "string",
      "japaneseText": "string",
      "exposeLanguage": "Unknown"
    },
    "recommendedOptName3": {
      "koreanText": "string",
      "englishText": "string",
      "chineseText": "string",
      "japaneseText": "string",
      "exposeLanguage": "Unknown"
    }
  },
  "text": {
    "details": [
      {
        "recommendedOptNo": 0,
        "isDisplay": true,
        "Value": "string"
      }
    ]
  },
  "calculation": {
    "name1": {
      "kor": "string",
      "eng": "string",
      "chi": "string",
      "jpn": "string"
    },
    "name2": {
      "kor": "string",
      "eng": "string",
      "chi": "string",
      "jpn": "string"
    },
    "minValue1": 0,
    "minValue2": 0,
    "maxValue1": 0,
    "maxValue2": 0,
    "unitPrice": 0,
    "unitType": "string",
    "unitValue": 0,
    "manageCode": "string"
  }
}

등록 옵션 조회
[GET] https://sa2.esmplus.com/item/v1/goods/1158387297/recommended-options

카테고리별 추천옵션코드 조회
[GET] https://sa2.esmplus.com/item/v1/options/recommended-opts?catCode=300023931

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

 

선택형 추천옵션 샘플
{
    "type": 1,
    "isStockManage": false,
    "independent": {
        "details": [
            {
                "recommendedOptValueNo": 23901,
                "recommendedOptValue": {
                    "koreanText": "연청"
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 0,
                    "gmkt": 0
                },
                "manageCode": "AAAA",
                "addAmnt": null
            },
            {
                "recommendedOptValueNo": 23902,
                "recommendedOptValue": {
                    "koreanText": "진청"
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 0,
                    "gmkt": 0
                },
                "manageCode": "BBB",
                "addAmnt": null
            }
        ],
        "recommendedOptNo": 1
    }
}

선택형 직접입력 샘플
{
    "type": 1,
    "isStockManage": true,
    "independent": {
        "details": [
            {
                "recommendedOptValueNo": 0,
                "recommendedOptValue": {
                    "koreanText": "골드",
                    "exposeLanguage": 1
                },
                "imageUrl": null,
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 50,
                    "gmkt": 60
                },
                "manageCode": null,
                "skuInfo": null,
                "addAmnt": null
            },
            {
                "recommendedOptValueNo": 0,
                "recommendedOptValue": {
                    "koreanText": "실버",
                    "exposeLanguage": 1
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 70,
                    "gmkt": 80
                },
                "manageCode": null,
                "skuInfo": null,
                "addAmnt": null
            }
        ],
        "recommendedOptNo": 0,
        "recommendedOptName": {
            "koreanText": "단일옵션",
            "exposeLanguage": 1
        }
    }
}

조합형 샘플
{
    "type": 2,
    "isStockManage": true,
    "combination": {
        "details": [
            {
                "recommendedOptValueNo1": 14897,
                "recommendedOptValueNo2": 14993,
                "recommendedOptValue1": {
                    "koreanText": "검정"
                },
                "recommendedOptValue2": {
                    "koreanText": "L"
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 9,
                    "gmkt": 9
                },
                "manageCode": "BL",
                "addAmnt": null
            },
            {
                "recommendedOptValueNo1": 14897,
                "recommendedOptValueNo2": 15043,
                "recommendedOptValue1": {
                    "koreanText": "검정",
                },
                "recommendedOptValue2": {
                    "koreanText": "XL"
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 9,
                    "gmkt": 9
                },
                "manageCode": "BXL",
                "addAmnt": null
            },
            {
                "recommendedOptValueNo1": 15198,
                "recommendedOptValueNo2": 14993,
                "recommendedOptValue1": {
                    "koreanText": "흰색"
                },
                "recommendedOptValue2": {
                    "koreanText": "L"
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 9,
                    "gmkt": 9
                },
                "manageCode": "WL",
                "addAmnt": null
            },
            {
                "recommendedOptValueNo1": 15198,
                "recommendedOptValueNo2": 15043,
                "recommendedOptValue1": {
                    "koreanText": "흰색"
                },
                "recommendedOptValue2": {
                    "koreanText": "XL"
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 9,
                    "gmkt": 9
                },
                "manageCode": "WXL",
                "addAmnt": null
            }
        ],
        "recommendedOptNo1": 1,
        "recommendedOptNo2": 976
    }
}

조합형 직접입력 샘플
{
    "type": 2,
    "isStockManage": true,
    "combination": {
        "details": [
            {
                "recommendedOptValueNo1": 0,
                "recommendedOptValueNo2": 0,
                "recommendedOptValue1": {
                    "koreanText": "라일락",
                    "exposeLanguage": 1
                },
                "recommendedOptValue2": {
                    "koreanText": "110mm",
                    "exposeLanguage": 1
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 50,
                    "gmkt": 60
                },
                "manageCode": "lilac_110",
                "skuInfo": null,
                "addAmnt": 0.0000
            },
            {
                "recommendedOptValueNo1": 0,
                "recommendedOptValueNo2": 0,
                "recommendedOptValue1": {
                    "koreanText": "라일락",
                    "exposeLanguage": 1
                },
                "recommendedOptValue2": {
                    "koreanText": "220mm",
                    "exposeLanguage": 1
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 70,
                    "gmkt": 80
                },
                "manageCode": "lilac_220",
                "skuInfo": null,
                "addAmnt": 0.0000
            },
            {
                "recommendedOptValueNo1": 0,
                "recommendedOptValueNo2": 0,
                "recommendedOptValue1": {
                    "koreanText": "라임",
                    "exposeLanguage": 1
                },
                "recommendedOptValue2": {
                    "koreanText": "110mm",
                    "exposeLanguage": 1
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 100,
                    "gmkt": 110
                },
                "manageCode": "lime_110",
                "skuInfo": null,
                "addAmnt": 0.0000
            },
            {
                "recommendedOptValueNo1": 0,
                "recommendedOptValueNo2": 0,
                "recommendedOptValue1": {
                    "koreanText": "라임",
                    "exposeLanguage": 1
                },
                "recommendedOptValue2": {
                    "koreanText": "220mm",
                    "exposeLanguage": 1
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 150,
                    "gmkt": 200
                },
                "manageCode": "lime_220",
                "skuInfo": null,
                "addAmnt": 0.0000
            }
        ],
        "recommendedOptNo1": 0,
        "recommendedOptNo2": 0,
        "recommendedOptName1": {
            "koreanText": "컬러",
            "exposeLanguage": 1
        },
        "recommendedOptName2": {
            "koreanText": "길이",
            "exposeLanguage": 1
        }
    }
}

계산형 샘플
{
    "type": 4,
    "isStockManage": false,
    "calculation": {
        "name1": {
            "kor": "가로"
        },
        "name2": {
            "kor": "세로"
        },
        "minValue1": 1,
        "minValue2": 10,
        "maxValue1": 10,
        "maxValue2": 20,
        "unitPrice": 1000.0000,
        "unitType": "cm",
        "unitValue": 1,
        "manageCode": "cm"
    }
}

텍스트형 샘플
{
    "type": 5,
    "isStockManage": false,
    "text": {
        "details": [
            {
                "recommendedOptNo": 877,
                "isDisplay": true,
                "Value": "문구입력"
            }
        ]
    }
}

 

Response Description

항목	항목명	Type	Description
goodsNo	마스터상품번호	int
resultCode	결과코드	int	실패 시 내려가는 정보
message	메시지	string	실패 시 내려가는 정보

 JSON_Success

등록/수정
{
  "goodsNo": 0
}

JSON_Fail

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

Sample Code_Success

등록/수정
{
  "goodsNo": 1158387297
}

조회
{
    "type": 1,
    "isStockManage": false,
    "independent": {
        "details": [
            {
                "recommendedOptValueNo": 885,
                "recommendedOptValue": {
                    "koreanText": "초코브라운",
                    "englishText": null,
                    "chineseText": null,
                    "japaneseText": null,
                    "exposeLanguage": 0
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 0,
                    "gmkt": 0
                },
                "manageCode": null,
                "epinCode": null
            }
        ],
        "recommendedOptNo": 1
    },
    "combination": null,
    "text": null
}

Sample Code_Fail

{
  "resultCode":1000,
  "message":"선택형(Independent) 상세정보(Details) 항목은 50개까지 입력 가능합니다"
}

 

Error Code

결과코드	메시지	원인
3000	모든 옵션이 품절인 상태로 등록이 불가합니다	모든 옵션의 isSoldOut이 true일 경우
1000	[InvalidApiRequestEx][\"Gmkt 필드는 1에서 99999 사이에 있어야 합니다.\",\"Iac 필드는 1에서 99999 사이에 있어야 합니다.\"]	재고수량 설정이 1~99999범위 벗어날 경우
3000	[Independent] 옵션 번호 오류 (0)	선택형의 옵션코드가 아닐 경우
1000	설정하신 텍스트형 추천옵션은 해당 카테고리에서 사용하실 수 없습니다	텍스트형의 옵션코드가 사용 불가한 카테고리 등록 상품인 경우
3000	시퀀스에 요소가 없습니다.	카테고리 코드 잘 못 되었거나 없는 카테고리 코드인 경우
1000	조회 된 데이터가 없습니다.	카테고리에 매칭된 옵션이 없을 경우
1000	선택형(Independent) 상세정보(Details) 항목은 50개까지 입력 가능합니다	선택형 항목 값 50개 초과했을 경우
1000	No Return Data	isLeaf가 true가 아닌 카테고리나 추천옵션이 없는 경우