본문 바로가기
상품API/고객혜택 | 광고 API

사은품 API

Description
등록 : [POST] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/free-gift
수정 : [PUT] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/free-gift
조회 : [GET] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/free-gift
삭제 : [DELETE] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/free-gift
고객이 상품 구매시 제공받을 수 있는 사은품 정보 등록/수정/삭제/조회 기능을 제공합니다.

Request Description

항목 항목명 필수여부 Type Description
goodsNo 마스터상품번호 Y path  
name 사은품명   string 특수문자/기호 입력 불가
manageCode 사은품 관리 코드   string 영문/숫자만 입력 가능
JSON
{
  "name" : "string",
  "manageCode" : "string"
}

삭제/조회 - URL만 호출 / Request Body 없음
삭제 [DELETE] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/free-gift
조회 [GET] https://sa2.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/free-gift

 

Response Description

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

JSON_Success

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

조회
{
  "name" : "string",
  "manageCode" : "string"
}

JSON_Fail

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

Sample Code_Success

{
  "goodsNo": 1158387297
}

Sample Code_Fail

{
  "resultCode":1000,
  "message":"오류메시지"
}

Error Code

결과코드 메시지 원인
1000 [G마켓/옥션] 토큰을 확인 해 주세요. 동시등록한 상품코드를 지마켓,옥션 개별토큰으로 진행 시
1000 사은품은 정확한 내용으로 기재해주세요. (특수문자/기호 사용불가) 사은품명 내 특수문자, 기호 등 입력한 경우
1000 사은품/덤 관리코드 항목은 영/숫자만 등록 가능합니다.(공백불가) 관리코드 항목내 특수문자,한글,기호 등 입력한 경우
1000 상품 번호가 잘 못 되었습니다.(GoodsMaster) 마스터 상품코드 아닌 사이트 상품코드 적용,호출 한 경우
1000 해당 판매자의 상품이 아닙니다. 조회하려는 상품번호와 토큰 매칭이 되지 않을 경우
1000 [G마켓/옥션] 상품번호가 생성 되지 않았습니다. 개별사이트 상품번호만 채번되어있는 상품의 경우 두 사이트 토큰, 사이트와 상이한 토큰 사용 한 경우
3000 request benefitValue cannot be empty or null 사은품 명 공백 시

 

'상품API > 고객혜택 | 광고 API' 카테고리의 다른 글

리스팅 부가서비스 API  (0) 2022.09.27
후원/나눔쇼핑 API  (0) 2022.09.27
옥션 복수 할인 API  (0) 2022.09.27
지마켓 복수구매할인 API  (0) 2022.09.27
덤 API  (0) 2022.09.27