이벤트 홍보 등록/수정/삭제 API

Description

등록 : [POST] https://sa2.esmplus.com/item/v1/event-promotions 수정 : [PUT] https://sa2.esmplus.com/item/v1/event-promotions/{promotionNo}  조회 : [GET] https://sa2.esmplus.com/item/v1/event-promotions/{promotionNo}  삭제 : [DELETE] https://sa2.esmplus.com/item/v1/event-promotions/{promotionNo}

광고/프로모션 등 이벤트 홍보를 상품상세에 노출할 수 있습니다. 이벤트 홍보는 상품별로 한 개만 노출 가능하며 이벤트 홍보를 노출할 상품을 최대 1,000개 까지 추가할 수 있습니다. 상품별 설정 아닌 전체 상품에 노출을 이벤트 홍보에서 설정 가능하며 전체 노출은 한개만 설정 가능합니다.

Request Description

항목	항목명	필수여부	Type	Description
promotionNo	이벤트 홍보 번호		path	수정, 조회, 삭제시 필수 입력
isExposure	노출 여부	Y	boolean	이벤트 홍보 노출 여부
name	이벤트 홍보명	Y	string	50 byte 이내 입력 가능
detail	상세내용	Y	string	- 외부 링크, 일부 스크립트 및 태그는 자동으로 삭제될 수 있습니다. - 이미지 권장크기 : 가로 860px
isApplyAll	전체 적용 여부	Y	boolean	Y 로 설정시 전체 상품에 노출
exposureDate > startDate	노출 시작일		date	- YYYY-MM-DD hh:mm 입력 가능 - 분은 00 으로만 입력 가능
exposureDate > endDate	노출 종료일		date	- YYYY-MM-DD hh:mm 입력 가능 - 분은 00 으로만 입력 가능

JSON
이벤트 홍보 등록/수정
{
  "isExposure": true,
  "name": "string",
  "detail": "string",
  "isApplyAll": true,
  "exposureDate": {
    "startDate": "2024-03-28",
    "endDate": "2024-03-28"
  }
}

조회 [GET] https://sa2.esmplus.com/item/v1/event-promotions/1
삭제 [DELETE] https://sa2.esmplus.com/item/v1/event-promotions/2

전체 조회 [GET] https://sa2.esmplus.com/item/v1/event-promotions

Response Description

항목	항목명	Type	Description
resultCode	결과코드	int	실패시 내려가는 정보
message	메시지	string	실패시 내려가는 정보
promotionNo	이벤트 홍보 번호	int	등록, 수정, 조회, 삭제시 내려가는 항목
isExposure	노출 여부	boolean	조회시 내려가는 항목
insertDate	등록일	date	조회시 내려가는 항목
updateDate	수정일	date	조회시 내려가는 항목
name	이벤트 홍보명	string	조회시 내려가는 항목
detail	상세내용	string	조회시 내려가는 항목
isApplyAll	전체 적용 여부	boolean	조회시 내려가는 항목
exposureDate > startDate	노출 시작일	date	조회시 내려가는 항목
exposureDate > endDate	노출 종료일	date	조회시 내려가는 항목

JSON_Success

등록/수정시
{
    "PromotionNo": int
}

조회시
{
    "promotionNo": 139,
    "isExposure": true,
    "insertDate": "2024-03-28T16:53:52.167+09:00",
    "updateDate": "2024-03-28T16:53:52.167+09:00",
    "name": "이벤트 홍보",
    "detail": "상세 설명",
    "isApplyAll": false,
    "exposureDate": {
        "startDate": "2024-05-02T03:00:00+09:00",
        "endDate": "2024-05-04T07:00:00+09:00"
    }
}

JSON_Fail

{
  "ResultCode": "Success",
  "Message": "string",
  "Data": {}
}

Sample Code_Success

{
    "PromotionNo": 138
}

Sample Code_Fail

{
    "resultCode": 1000,
    "message": "[\"Required property 'isApplyAll' not found in JSON. Path '', line 9, position 1.\"]",
    "data": null
}