5.5 후원쇼핑, 나눔쇼핑 API – ESM Trading API

5.5 후원쇼핑, 나눔쇼핑 API

등록 : [POST] http://sa.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/sponsorship

수정 : [PUT] http://sa.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/sponsorship

해제 : [DELETE] http://sa.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/sponsorship

조회 : [GET] http://sa.esmplus.com/item/v1/goods/{goodsNo}/customer-benefit/sponsorship

Description
후원쇼핑 (지마켓 상품만 해당) 상품 설정하면 ‘후원쇼핑’ 공간에 추가 전시됩니다. 해당 상품이 판매될 때마다 G마켓과 지정한 금액이 사회단체에 기부되어 좋은 일에 쓰입니다.
나눔쇼핑 (옥션 상품만 해당) 설정하면 판매될 때마다 판매자가 부담한 나눔 금액(판매수량당 50원/VAT 제외)이 옥션 명의로 기부될 수 있도록 약속한 상품을 말합니다.
발생된 후원/나눔쇼핑 금액은 판매자 정산대금에서 그 내역이 이용료에 포함되어 공제금으로 차감됩니다.
Request Description
G마켓 / 옥션 상품 동시 관리 시, G마켓 ID & 옥션 ID 토큰으로 사용합니다
G마켓 상품만 관리 시, G마켓 ID의 토큰으로 사용합니다
옥션 상품만 관리 시, 옥션 ID의 토큰으로 사용합니다
항목항목명필수여부TypeDescription
goodsNo마스터상품번호Ypath
gmkt > isUse후원쇼핑 사용 여부Yboolean
gmarket > amount후원금액Ynumber100원 이상 등록가능
판매가 80% 까지 설정 가능
gmarket > maxAmount누적적립한도액 Ynumber10,000원 이상만 등록 가능
gmarket > field후원분야Yint1 : 아동복지
2 : 여성권익
3 : 환경보호
4 : 국제구호
5 : 소비자권익
6 : 기타
gmarket > startDate후원 시작일YstringYYYY-MM-DD 형태로 입력 가능
gmarket > endDate후원 종료일YstringYYYY-MM-DD 형태로 입력 가능
auction > isUse나눔쇼핑 사용 여부Yboolean
auction > startDate나눔 시작일YstringYYYY-MM-DD 형태로 입력 가능
auction > endDate나눔 종료일YstringYYYY-MM-DD 형태로 입력 가능
JSON_등록/수정JSON_해제/조회Sample Code_등록/수정
{
  "gmarket": {
    "isUse": true,
    "amount": 0,
    "maxAmount": 0,
    "field": int,
    "startDate": "string",
    "endDate": "string"
  },
  "auction": {
    "isUse": true,
    "startDate": "string",
    "endDate": "string"
  }
}
URL만 호출/Request Body없음
후원쇼핑, 나눔쇼핑 해제
DELETE http://sa.esmplus.com/item/v1/goods/1765352303/customer-benefit/sponsorship

후원쇼핑, 나눔쇼핑 조회
GET http://sa.esmplus.com/item/v1/goods/1765352303/customer-benefit/sponsorship
{
    "gmarket": {
        "isUse": true,
        "amount": 300,
        "maxAmount": 30000,
        "field": 4,
        "startDate": "2022-03-29",
        "endDate": "2022-04-03"
    },
    "auction": {
        "isUse": true,
        "startDate": "2022-03-29",
        "endDate": "2022-04-30"
    }
}
Response Description
항목항목명필수여부TypeDescription
goodsNo마스터상품번호
JSON_Success_등록/수정/해제JSON_Success_조회JSON_FailSample Code_Success_등록/수정/해제Sample Code_Fail
{
  "goodsNo": 0
}
{
  "gmarket": {
    "isUse": true,
    "amount": 0,
    "maxAmount": 0,
    "field": "Unknown",
    "startDate": "string",
    "endDate": "string"
  },
  "auction": {
    "isUse": true,
    "startDate": "string",
    "endDate": "string"
  }
}
{
   "ResultCode": 0,
   "Message": "string",
   "Data": {}
}
{
  "goodsNo": 1158387297
}
{
  "ResultCode":1000,
  "Message":"에러메시지.",
  "Data":null
}