3.8 구버전옵션 관리 API – ESM Trading API

3.8 구버전옵션 관리 API

옵션 등록/수정 : [PUT] https://sa.esmplus.com/item/v1/goods/{goodsNo}/order-options

등록한 옵션 조회 : [GET] https://sa.esmplus.com/item/v1/goods/{goodsNo}/order-options

등록한 옵션 삭제 : [DELETE] https://sa.esmplus.com/item/v1/goods/{goodsNo}/order-options

Description
구버전옵션은 제한된 API입니다
주문옵션으로 구현되어야 하며 구버전옵션을 사용하셔야 할 경우에는 별도 협의부탁드립니다
구버전옵션은, 판매자가 옵션명/옵션값을 등록하여 사용합니다
구버전옵션을 사용하는 상품의 경우는 상품수정 > 구버전옵션용 상품수정 URL 호출하여 수정합니다
Request Description
G마켓 / 옥션 상품 동시 관리 시, G마켓 ID & 옥션 ID 토큰으로 사용합니다
G마켓 상품만 관리 시, G마켓 ID의 토큰으로 사용합니다
옥션 상품만 관리 시, 옥션 ID의 토큰으로 사용합니다
항목항목명필수여부TypeDescription
type 옵션 타입
(ESM상 주문옵션)
Y int옵션 사용여부
0 : 옵션미사용
1 : 선택형 (최대 50개까지 가능), independent 로 입력
2 : 2개 조합형 (최대 500개까지 가능), combination 로 입력
3 : 3개 조합형 (최대 500개까지 가능), combination 로 입력
4 : 계산형, calculation 로 입력
5 : 텍스트형
6 : 선택형 + 텍스트형
7 : 2개조합형 + 텍스트형
8 : 3개 조합형 + 텍스트형
9 : 선택형 + 계산형
* 옵션 타입이 선택형일 경우, independent / 2개 조합형일 경우, combination 항목값으로 필수 연동
* 텍스트형(type : 5) 옵션 사용하는 경우 itemAddtionalInfo > orderOpts > isStockManage(옵션재고관리여부)를 false로 연동
isStockManage 옵션재고관리 Y Boolean옵션 사용일 경우 필수
independent/combination > name > kor(선택형/조합형)
옵션그룹명
Y string 옵션 사용일 경우 필수
independent/combination > details > value > kor(선택형/조합형)
옵션항목값
Y string 옵션 사용일 경우 필수
independent/combination > details > isSoldOut(선택형/조합형)
품절여부
Y string 옵션 사용일 경우 필수
옵션의 품절여부 제어(옵션 재고수량으로 제어하지 않음)
true : 품절
false : 판매
independent/combination > details > isDisplay(선택형/조합형)
노출여부
Y Boolean 옵션 사용일 경우 필수
옵션의 노출여부 제어
true : 노출
false : 미노출
independent/combination > details > qty > gmkt(선택형/조합형)
G마켓 재고수량
Y int옵션 사용일 경우 필수
G마켓 옵션 재고수량 입력
independent/combination > details > qty > iac(선택형/조합형)
옥션 재고수량
Y int옵션 사용일 경우 필수
옥션 옵션 재고수량 입력
independent/combination > details > manageCode(선택형/조합형)
판매자옵션관리코드
Y string옵션 사용일 경우 필수
해당 옵션의 판매자가 관리하는 코드 입력
20 byte 이내 입력 가능
text > name > kor(텍스트형)
텍스트형 옵션명
string 모델명 또는 각인문구 등 추가로 문구를 입력받고자 할 때 사용
텍스트형 사용할 경우 필수
최대 20byte까지 입력 가능
text > details > value > isDisplay(텍스트형)
노출여부
string 텍스트형 사용할 경우 필수
텍스트형을 상품상세페이지에 노출할 것인지 여부 설정
text > details > value > manageCode(텍스트형)
판매자옵션관리코드
string 해당 옵션의 판매자가 관리하는 코드 입력
최대 20byte까지 입력 가능
calculation > name1 > kor(계산형)
옵션명1
string
calculation > name2 > kor(계산형)
옵션명2
string
calculation > minValue1(계산형)
옵션명1 (name 1) 판매 최소값
int1 이상 입력 가능
calculation > minValue2(계산형)
옵션명2 (name 2) 판매 최소값
int1 이상 입력 가능
calculation > maxValue1(계산형)
옵션명1 (name 1) 판매 최대값
int1 이상 입력 가능
calculation > maxValue2(계산형)
옵션명2 (name 2) 판매 최대값
int1 이상 입력 가능
calculation > unitPrice(계산형)
단가 기준값
int1 이상 입력 가능
calculation > unitType(계산형)
판매 단위
string"mm", "cm", "m", "mg", "g", "kg", "ml", "l“ 만 입력 가능
calculation > unitValue(계산형)
판매 단위값
int1 이상 입력 가능
calculation > manageCode(계산형)
옵션관리코드
string최대 20byte까지 입력 가능
JSON_등록/수정JSON_조회Sample Code_등록/수정1Sample Code_등록/수정2Sample Code_등록/수정3
{
  "type": "Unknown",
  "isStockManage": true,
  "independent": [
    {
      "name": {
        "kor": "string"
      },
      "details": [
        {
          "value": {
            "kor": "string"
          },
          "isSoldOut": true,
          "isDisplay": true,
          "qty": {
            "iac": 0,
            "gmkt": 0
          },
          "manageCode": "string",
          "epinCode": 0
        }
      ]
    }
  ],
  "combination": {
    "name1": {
      "kor": "string"
    },
    "name2": {
      "kor": "string"
    },
    "details": [
      {
        "value1": {
          "kor": "string"
        },
        "value2": {
          "kor": "string"
        },
        "isSoldOut": true,
        "isDisplay": true,
        "qty": {
          "iac": 0,
          "gmkt": 0
        },
        "manageCode": "string",
        "epinCode": 0
      }
    ]
  },
  "text": [
    {
      "name": {
        "kor": "string"
      },
      "isDisplay": true
    }
  ]
}

URL만 호출 / Request Body 없음
등록한 옵션 조회
GET https://sa.esmplus.com/item/v1/goods/1158058309/order-options

{
  "type": "1",
  "isStockManage":true,
  "independent": [
    {
      "name": {
        "kor": "옵션명1"
      },
      "details": [
        {
          "value": {
            "kor": "옵션값1"
          },
          "isSoldOut": false,
          "isDisplay": true,
          "qty": {
            "gmkt": 2,
            "iac": 3
          },
          "manageCode": "테스트1"
        },
        {
          "value": {
            "kor": "옵션값2"
          },
          "isSoldOut": false,
          "isDisplay": true,
          "qty": {
            "gmkt": 4,
            "iac": 5
          },
          "manageCode": "테스트2"
        }
      ]
    }
  ],
  "combination": null,
  "threeCombination": null,
  "text": null
}
{
  "type": "2",
  "isStockManage": false,
  "independent": null,
  "combination": {
    "name1": {
      "kor": "옵션명1"
    },
    "name2": {
      "kor": "옵션명2"
    },
    "details": [
      {
        "value1": {
          "kor": "옵션값1"
        },
        "value2": {
          "kor": "옵션값1"
        },
        "isSoldOut": false,
        "isDisplay": true,
        "qty": {
          "gmkt": 0,
          "iac": 0
        },
        "manageCode": "테스트1",
        "epinCode": 0
      },
      {
        "value1": {
          "kor": "옵션값1"
        },
        "value2": {
          "kor": "옵션값2"
        },
        "isSoldOut": false,
        "isDisplay": true,
        "qty": {
          "gmkt": 0,
          "iac": 0
        },
        "manageCode": "테스트2",
        "epinCode": 0
      },
      {
        "value1": {
          "kor": "옵션값2"
        },
        "value2": {
          "kor": "옵션값1"
        },
        "isSoldOut": false,
        "isDisplay": true,
        "qty": {
          "gmkt": 0,
          "iac": 0
        },
        "manageCode": "테스트3",
        "epinCode": 0
      },
      {
        "value1": {
          "kor": "옵션값2"
        },
        "value2": {
          "kor": "옵션값2"
        },
        "isSoldOut": false,
        "isDisplay": true,
        "qty": {
          "gmkt": 0,
          "iac": 0
        },
        "manageCode": "테스트4",
        "epinCode": 0
      }
    ]
  },
  "threeCombination": null,
  "text": null
}


{
  "type": "5",
  "isStockManage": true,
  "independent": null,
  "combination": null,
  "threeCombination": null,
  "text": [
    {
      "name": {
        "kor": "텍스트형 옵션"
      },
      "isDisplay": true
    }
  ]
}

Response Description
항목항목명TypeDescription
goodsNo 마스터상품번호 int 성공/조회 시 내려가는 정보
resultCode 결과코드 int 실패 시 내려가는 정보
message 메시지 string 실패 시 내려가는 정보
data 데이터 object 실패 시 내려가는 정보
type옵션타입string조회 시 내려가는 정보
isStockManage재고관리여부boolean조회 시 내려가는 정보
independent > name > kor선택형 옵션그룹명string조회 시 내려가는 정보
independent > details > value > isSoldOut선택형 품절여부boolean조회 시 내려가는 정보
independent > details > value > isDisplay선택형 노출여부boolean조회 시 내려가는 정보
independent > details > value > qty > iac선택형 옥션 재고수량int조회 시 내려가는 정보
independent > details > value > qty > gmkt선택형 G마켓 재고수량int조회 시 내려가는 정보
independent > details > value > manageCode선택형 판매자옵션관리코드string조회 시 내려가는 정보
combination > name1 > kor조합형 옵션그룹명1string조회 시 내려가는 정보
combination > name2 > kor조합형 옵션그룹명2string조회 시 내려가는 정보
combination > details > value1 > kor조합형 옵션항목명1string조회 시 내려가는 정보
combination > details > value2 > kor조합형 옵션항목명2string조회 시 내려가는 정보
combination > details > value > isSoldOut조합형 품절여부boolean조회 시 내려가는 정보
combination > details > value > isDisplay조합형 노출여부boolean조회 시 내려가는 정보
combination > details > value > qty > iac조합형 옥션 재고수량int조회 시 내려가는 정보
combination > details > value > qty > gmkt조합형 G마켓 재고수량int조회 시 내려가는 정보
combination > details > value > manageCode조합형 판매자옵션관리코드string조회 시 내려가는 정보
text > name > kor텍스트형 옵션그룹명string조회 시 내려가는 정보
independent > details > value > isDisplay텍스트형 노출여부boolean조회 시 내려가는 정보
independent > details > value > manageCode텍스트형 판매자옵션관리코드string조회 시 내려가는 정보
JSON_Success_등록/수정JSON_Success_옵션조회JSON_FailSample Code_Success_등록/수정Sample Code_Success_옵션조회Sample Code_Fail
{
  "goodsNo": 0
}
{
  "type": "Unknown",
  "isStockManage": true,
  "independent": [
    {
      "name": {
        "kor": "string"
      },
      "details": [
        {
          "value": {
            "kor": "string"
          },
          "isSoldOut": true,
          "isDisplay": true,
          "qty": {
            "iac": 0,
            "gmkt": 0
          },
          "manageCode": "string",
          "epinCode": 0
        }
      ]
    }
  ],
  "combination": {
    "name1": {
      "kor": "string"
    },
    "name2": {
      "kor": "string"
    },
    "details": [
      {
        "value1": {
          "kor": "string"
        },
        "value2": {
          "kor": "string"
        },
        "isSoldOut": true,
        "isDisplay": true,
        "qty": {
          "iac": 0,
          "gmkt": 0
        },
        "manageCode": "string",
        "epinCode": 0
      }
    ]
  },
  "text": [
    {
      "name": {
        "kor": "string"
      },
      "isDisplay": true
    }
  ]
}
{
   "ResultCode": 0,
   "Message": "string",
   "Data": {}
}
{
  "goodsNo": 1158387297
}
{
    "type": 2,
    "isStockManage": false,
    "independent": null,
    "combination": {
        "name1": {
            "kor": "색상",
            "eng": null,
            "chi": null,
            "jpn": null
        },
        "name2": {
            "kor": "사이즈",
            "eng": null,
            "chi": null,
            "jpn": null
        },
        "details": [
            {
                "value1": {
                    "kor": "빨강",
                    "eng": null,
                    "chi": null,
                    "jpn": null
                },
                "value2": {
                    "kor": "스몰",
                    "eng": null,
                    "chi": null,
                    "jpn": null
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 0,
                    "gmkt": 0
                },
                "manageCode": "테스트1",
                "epinCode": null
            },
            {
                "value1": {
                    "kor": "파랑",
                    "eng": null,
                    "chi": null,
                    "jpn": null
                },
                "value2": {
                    "kor": "라지",
                    "eng": null,
                    "chi": null,
                    "jpn": null
                },
                "isSoldOut": false,
                "isDisplay": true,
                "qty": {
                    "iac": 0,
                    "gmkt": 0
                },
                "manageCode": "테스트3",
                "epinCode": null
            }
        ]
    },
    "text": null
}
{
  "ResultCode":1000,
  "Message":"선택형(Independent) 상세정보(Details) 항목은 20개까지 입력 가능합니다",
  "Data":null
}
Error Code
결과코드메시지원인