기획전

기획전 조회

get

기능설명

• 해당 사이트,몰 기준 기획전 정보를 조회하는 API 입니다.

---

상세설명

• 사이트, 몰 기준으로 기획전 정보를 조회합니다.

• 기획전번호가 있을경우 기획전 번호에 해당하는 정보들을 조회합니다.

• 브랜드 번호, 정렬타입(최신순, 마감순), 진행여부에 따라 기획전 정보를 조회합니다.

• 회원등급 및 임직원 여부에 따른 권한 체크를 통해 기획전 노출이 제한됩니다.

---

특이사항

• 권한 체크 기준은 And 기준으로 ① 전시회원등급(GREEN), ② 임직원전용에 체크한 경우 해당 기획전은 ‘임직원 + GREEN에게만 노출됩니다.

  • 전체 미 체크 시 비회원을 포함한 모든 사용자에게 노출합니다.

Query parameters

dispMediaCdstringRequired

string

Example: 20

brandNostringOptional

string

Example: 10051

sortTypestringOptional

string

Example: recent

pageNostringOptional

integer

Example: 1

pageSizestringOptional

integer

Example: 10

progressYnstringOptional

string

Example: y

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

기획전 조회 성공

application/json

totalCountinteger · int64Optional

총 개수

Example: 10

400

기획전 조회 실패

application/json

get

/v1/plan/planList

HTTPcURLJavaScriptPython

GET /api/display/v1/plan/planList?dispMediaCd=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "totalCount": 10,
  "planInfoList": [
    {
      "mkdpNo": 14862,
      "mkdpNm": "기획전명",
      "tmplNo": 10020,
      "brefDesc": "간략설명 내용",
      "introConts": "소개글 내용",
      "pcTopYn": "N",
      "dispSeq": 1,
      "totalCount": 20,
      "startDate": "2023-01-01 00:00:00",
      "endDate": "2023-12-31 00:00:00",
      "wishContYn": "N",
      "imageList": [
        {
          "mkdpNo": 14862,
          "imgTypCd": "02",
          "contGbCd": 10,
          "bnrImgPathNm": "/imagePath",
          "bnrImgAltCont": "이미지 대체텍스트"
        }
      ]
    }
  ]
}

기획전 조회

get

기능설명

• 해당 사이트,몰 기준 기획전 정보를 조회하는 API 입니다.

---

상세설명

• 사이트, 몰 기준으로 기획전 정보를 조회합니다.

• 기획전번호가 있을경우 기획전 번호에 해당하는 정보들을 조회합니다.

• 브랜드 번호, 정렬타입(최신순, 마감순), 진행여부에 따라 기획전 정보를 조회합니다.

• 회원등급 및 임직원 여부에 따른 권한 체크를 통해 기획전 노출이 제한됩니다.

---

특이사항

• 권한 체크 기준은 And 기준으로 ① 전시회원등급(GREEN), ② 임직원전용에 체크한 경우 해당 기획전은 ‘임직원 + GREEN에게만 노출됩니다.

  • 전체 미 체크 시 비회원을 포함한 모든 사용자에게 노출합니다.

Query parameters

dispMediaCdstringRequired

string

Example: 20

brandNostringOptional

string

Example: 10051

sortTypestringOptional

string

Example: recent

pageNostringOptional

integer

Example: 1

pageSizestringOptional

integer

Example: 10

progressYnstringOptional

string

Example: y

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

기획전 조회 성공

application/json

totalCountinteger · int64Optional

총 개수

Example: 10

400

기획전 조회 실패

application/json

get

/v1/plan/planWishList

HTTPcURLJavaScriptPython

GET /api/display/v1/plan/planWishList?dispMediaCd=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "totalCount": 10,
  "planInfoList": [
    {
      "mkdpNo": 14862,
      "mkdpNm": "기획전명",
      "tmplNo": 10020,
      "brefDesc": "간략설명 내용",
      "introConts": "소개글 내용",
      "pcTopYn": "N",
      "dispSeq": 1,
      "totalCount": 20,
      "startDate": "2023-01-01 00:00:00",
      "endDate": "2023-12-31 00:00:00",
      "wishContYn": "N",
      "imageList": [
        {
          "mkdpNo": 14862,
          "imgTypCd": "02",
          "contGbCd": 10,
          "bnrImgPathNm": "/imagePath",
          "bnrImgAltCont": "이미지 대체텍스트"
        }
      ]
    }
  ]
}

기획전 구분자별 상품 조회

get

기능설명

• 해당 기획전 번호와 구분자 번호를 통해 구분자별 상품을 조회하는 API 입니다.

---

상세설명

• 구분자 번호 없을 시 전체 구분자 정보를 조회합니다.

  • 기획전 구분자는 전시순서, 구분자번호 순으로 노출됩니다.

• 상품정렬코드를 통해 상품에 대한 전시순서를 설정할 수 있습니다.(default: 10)

• 해당 구분자에 상품이 없을경우 빈값으로 리턴됩니다.

---

특이사항

• BO에서 기획전 미리보기를 통해 언어코드를 설정할 수 있습니다.(dataLangCd)

---

코드정리

• 상품정렬코드 : 10:신상순,20:판매순,30:고가순,40:저가순,50:상품평순

Query parameters

mkdpNostringRequired

string

Example: 14862

dispMediaCdstringRequired

string

Example: 20

divobjNostringOptional

string

Example: 1

sortstringOptional

string

Example: 10

dataLangCdstringOptional

string

Example: ko

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

기획전 구분자별 상품 조회 성공

application/json

가획전 구분자 DTO

divobjNostringOptional

구분자번호

Example: 1

divobjNmstringOptional

구분자명

Example: 구분자 이름명

divobjGbCdstringOptional

구분자구분코드

Example: 20

dispSeqstringOptional

전시순서

Example: 1

tmplNostringOptional

전시템플릿번호

Example: 10020

textDivobjNmstringOptional

텍스트구분자명

Example: 텍스트구분자명

bnrImgPathNmstringOptional

구분자이미지경로

Example: 구분자이미지경로명

bnrImgAltContstringOptional

구분자이미지대체텍스트

Example: 구분자이미지대체텍스트

htmlFileContstringOptional

HTML파일컨텐츠

Example: HTML내용

cpnDnldYnstringOptional

쿠폰다운여부

Example: N

cpnNostringOptional

쿠폰번호

Example: C1001442

cpnBnrImgPathNmstringOptional

쿠폰배너경로

Example: 쿠폰경로명

goodsNostringOptional

상품번호

Example: 10002031

400

기획전 구분자별 상품 조회 실패

application/json

get

/v1/plan/planGoodsInfo

HTTPcURLJavaScriptPython

GET /api/display/v1/plan/planGoodsInfo?mkdpNo=text&dispMediaCd=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "divobjNo": 1,
  "divobjNm": "구분자 이름명",
  "divobjGbCd": 20,
  "dispSeq": 1,
  "tmplNo": 10020,
  "textDivobjNm": "텍스트구분자명",
  "bnrImgPathNm": "구분자이미지경로명",
  "bnrImgAltCont": "구분자이미지대체텍스트",
  "htmlFileCont": "HTML내용",
  "cpnDnldYn": "N",
  "cpnNo": "C1001442",
  "cpnBnrImgPathNm": "쿠폰경로명",
  "goodsNo": 10002031,
  "goodsList": [
    {
      "goodsNo": 100000001,
      "goodsNm": "상품명",
      "entrNo": 1000001,
      "goodsCompCd": 10,
      "goodsTypCd": 10,
      "saleMethCd": 10,
      "brandNo": 1000001,
      "brandNm": "브랜드명",
      "buyrAgeLmtCd": 0,
      "dispYn": "Y",
      "saleStatCd": 10,
      "goodsRegDtm": "2021-01-01 00:00:00",
      "saleStrDtm": "2021-01-01 00:00:00",
      "saleEndDtm": "2029-01-01 00:00:00",
      "stkMgrYn": "Y",
      "deliProcTypCd": 10,
      "deliGoodsGbCd": "01",
      "deliWayCd": 10,
      "deliDday": 1,
      "deliPolcNo": 1,
      "prcHistStrDtm": "2021-01-01 00:00:00",
      "prcHistEndDtm": "2029-01-01 00:00:00",
      "rcntSalePrc": 10000,
      "salePrc": 10000,
      "aplyPrc": 10000,
      "dispCtgNo": 1,
      "dlexTypCd": 10,
      "goodsImmedDcCpnNo": 1,
      "goodsImmedDcAplyStrDtm": "2021-01-01 00:00:00",
      "goodsImmedDcAplyEndDtm": "2029-01-01 00:00:00",
      "goodsRepImgContSn": 1,
      "rservSaleYn": "Y",
      "rservStrDtm": "2021-01-01 00:00:00",
      "rservEndDtm": "2029-01-01 00:00:00",
      "goodsRevCnt": 1,
      "goodsRevHlpfulCnt": 1,
      "goodsRevStarscrAvgVal": 1,
      "fixamtFxrtGbCd": "01",
      "dcRateAmt": 1,
      "dcRate": 1,
      "wishListCnt": 10,
      "goodsRepImgPathNm": "text",
      "trnfTextCont": "text",
      "adlCertiYn": "text",
      "iconList": [
        "text"
      ],
      "prcTimeDealYn": "text"
    }
  ]
}

기획전 상세 조회

get

기능설명

• 기획전 번호를 통해 기본정보,구분자 정보 및 해당 상품정보를 조회하는 API 입니다.

---

상세설명

• 기획전 기본정보, 구분자 리스트 및 해당 상품리스트, 최근 기획전리스트, 기획전 이미지리스트를 조회합니다.

• 구분자별 상품은 설정한 전시순서순으로 노출됩니다.

• 해당 구분자에 상품이 없을경우 빈값으로 리턴됩니다.

• 회원등급 및 임직원 여부에 따른 권한 체크를 통해 기획전 노출이 제한됩니다.

---

특이사항

• 권한 체크 기준은 And 기준으로 ① 전시회원등급(GREEN), ② 임직원전용에 체크한 경우 해당 기획전은 ‘임직원 + GREEN에게만 노출됩니다.

  • 전체 미 체크 시 비회원을 포함한 모든 사용자에게 노출합니다.

• previewDate에 값이 있을경우 회원등급 및 전시여부에 상관없이 노출됩니다.

• BO에서 기획전 미리보기를 통해 언어코드를 설정할 수 있습니다.(dataLangCd)

---

검증내용

• 에러코드 1003 : 기획전 데이터 없음

• 에러코드 7010 : 기획전 로그인 필요

• 에러코드 7020 : 기획전 회원등급 제한

Path parameters

mkdpNostringRequired

string

Example: 14862

Query parameters

dispMediaCdstringRequired

string

Example: 20

previewDatestringOptional

localDate

Example: 2024-12-31

dataLangCdstringOptional

string

Example: ko

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

기획전 상세 조회 성공

application/json

가획전 상세 Response DTO

resultCdstringOptional

에러결과코드

Example: 1003

resultMsgstringOptional

에러결과메시지

Example: 데이터가 존재하지 않습니다.

mkdpNostringOptional

기획전번호

Example: 14862

mkdpNmstringOptional

기획전명

Example: 기획전 명

tmplNostringOptional

템플릿번호

Example: 10020

tmplFileNmstringOptional

템플릿파일명

Example: MarketingTemplate1

startDatestring · date-timeOptional

시작날짜

Example: 2023-01-01 00:00:00

endDatestring · date-timeOptional

종료날짜

Example: 2023-12-31 00:00:00

introContstringOptional

소개글

Example: 소개글 내용

briefDescriptionstringOptional

간략설명

Example: 간략설명 내용

titleHtmlstringOptional

타이틀HTML

Example: 타이틀HTML 내용

titleHtmlPcstringOptional

PC타이틀HTML

Example: PC타이틀HTML 내용

footerContentsstringOptional

푸터파일내용

Example: 푸터파일 내용

wishContYnstringOptional

찜여부

Example: N

pcTopYnstringOptional

상단고정여부

Example: N

staffYnstringOptional

임직원여부

Example: N

1003

기획전 데이터 없음

application/json

7010

회원 로그인 필요

application/json

7020

기획전 회원등급 제한

application/json

get

/v1/plan/planDetail/{mkdpNo}

HTTPcURLJavaScriptPython

GET /api/display/v1/plan/planDetail/{mkdpNo}?dispMediaCd=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "resultCd": 1003,
  "resultMsg": "데이터가 존재하지 않습니다.",
  "mkdpNo": 14862,
  "mkdpNm": "기획전 명",
  "tmplNo": 10020,
  "tmplFileNm": "MarketingTemplate1",
  "startDate": "2023-01-01 00:00:00",
  "endDate": "2023-12-31 00:00:00",
  "introCont": "소개글 내용",
  "briefDescription": "간략설명 내용",
  "titleHtml": "타이틀HTML 내용",
  "titleHtmlPc": "PC타이틀HTML 내용",
  "footerContents": "푸터파일 내용",
  "wishContYn": "N",
  "pcTopYn": "N",
  "staffYn": "N",
  "planDivObjList": [
    {
      "divobjNo": 1,
      "divobjNm": "구분자 이름명",
      "divobjGbCd": 20,
      "dispSeq": 1,
      "tmplNo": 10020,
      "textDivobjNm": "텍스트구분자명",
      "bnrImgPathNm": "구분자이미지경로명",
      "bnrImgAltCont": "구분자이미지대체텍스트",
      "htmlFileCont": "HTML내용",
      "cpnDnldYn": "N",
      "cpnNo": "C1001442",
      "cpnBnrImgPathNm": "쿠폰경로명",
      "goodsNo": 10002031,
      "goodsList": [
        {
          "goodsNo": 100000001,
          "goodsNm": "상품명",
          "entrNo": 1000001,
          "goodsCompCd": 10,
          "goodsTypCd": 10,
          "saleMethCd": 10,
          "brandNo": 1000001,
          "brandNm": "브랜드명",
          "buyrAgeLmtCd": 0,
          "dispYn": "Y",
          "saleStatCd": 10,
          "goodsRegDtm": "2021-01-01 00:00:00",
          "saleStrDtm": "2021-01-01 00:00:00",
          "saleEndDtm": "2029-01-01 00:00:00",
          "stkMgrYn": "Y",
          "deliProcTypCd": 10,
          "deliGoodsGbCd": "01",
          "deliWayCd": 10,
          "deliDday": 1,
          "deliPolcNo": 1,
          "prcHistStrDtm": "2021-01-01 00:00:00",
          "prcHistEndDtm": "2029-01-01 00:00:00",
          "rcntSalePrc": 10000,
          "salePrc": 10000,
          "aplyPrc": 10000,
          "dispCtgNo": 1,
          "dlexTypCd": 10,
          "goodsImmedDcCpnNo": 1,
          "goodsImmedDcAplyStrDtm": "2021-01-01 00:00:00",
          "goodsImmedDcAplyEndDtm": "2029-01-01 00:00:00",
          "goodsRepImgContSn": 1,
          "rservSaleYn": "Y",
          "rservStrDtm": "2021-01-01 00:00:00",
          "rservEndDtm": "2029-01-01 00:00:00",
          "goodsRevCnt": 1,
          "goodsRevHlpfulCnt": 1,
          "goodsRevStarscrAvgVal": 1,
          "fixamtFxrtGbCd": "01",
          "dcRateAmt": 1,
          "dcRate": 1,
          "wishListCnt": 10,
          "goodsRepImgPathNm": "text",
          "trnfTextCont": "text",
          "adlCertiYn": "text",
          "iconList": [
            "text"
          ],
          "prcTimeDealYn": "text"
        }
      ]
    }
  ],
  "recentPlanList": [
    {
      "mkdpNo": 14862,
      "mkdpNm": "기획전명",
      "tmplNo": 10020,
      "brefDesc": "간략설명 내용",
      "introConts": "소개글 내용",
      "pcTopYn": "N",
      "dispSeq": 1,
      "totalCount": 20,
      "startDate": "2023-01-01 00:00:00",
      "endDate": "2023-12-31 00:00:00",
      "wishContYn": "N",
      "imageList": [
        {
          "mkdpNo": 14862,
          "imgTypCd": "02",
          "contGbCd": 10,
          "bnrImgPathNm": "/imagePath",
          "bnrImgAltCont": "이미지 대체텍스트"
        }
      ]
    }
  ],
  "titleImgMovList": "리스트 이미지1, 리스트 이미지2"
}

기획전 그룹 목록 조회

get

기능설명

• 해당 사이트,몰 기준 기획전 그룹 목록을 조회하는 API 입니다.

---

상세설명

• 쿠키값에 사이트번호,몰번호를 받아 기획전 그룹 목록을 조회합니다.

• 사용 여부가 Y이고 현재날짜 기준으로 전시 기간에 해당하는 정보만 조회합니다.

• 기획전 그룹 목록은 전시순서 오름차순으로 노출됩니다.

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

기획전 그룹 조회 성공

application/json

기획전그룹 정보 DTO

dispGrpNostringOptional

전시그룹번호

Example: 132

dispGrpNmstringOptional

전시그룹명

Example: 통합몰 그룹

dispSeqstringOptional

전시순서

Example: 1

400

기획전 그룹 조회 실패

application/json

get

/v1/plan/group

HTTPcURLJavaScriptPython

GET /api/display/v1/plan/group HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "dispGrpNo": 132,
  "dispGrpNm": "통합몰 그룹",
  "dispSeq": 1
}

기획전 브랜드 조회

get

기능설명

• 해당 사이트,몰 기준 기획전 브랜드 목록을 조회하는 API 입니다.

---

상세설명

• 쿠키값에 사이트번호,몰번호를 받아 기획전 브랜드 목록을 조회합니다.

Query parameters

dispMediaCdstringRequired

전시매체코드(DP018)

Example: 20

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

기획전 브랜드 조회 성공

application/json

브랜드 DTO

brandNostringOptional

브랜드번호

useYnstringOptional

사용여부

brandImgPathNmstringOptional

브랜드이미지경로명

brandImgFileNmstringOptional

브랜드이미지파일명

brandNmstringOptional

브랜드명

brandDescCmtstringOptional

브랜드설명

schKwdNmstringOptional

검색키워드명

400

기획전 브랜드 조회 실패

application/json

get

/v1/plan/brand

HTTPcURLJavaScriptPython

GET /api/display/v1/plan/brand?dispMediaCd=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "brandNo": "text",
  "useYn": "text",
  "brandImgPathNm": "text",
  "brandImgFileNm": "text",
  "brandNm": "text",
  "brandDescCmt": "text",
  "schKwdNm": "text"
}