Special Exhibition

Retrieve Special Exhibition

get

Function Description

API for retrieving special exhibition information based on the corresponding site/mall.

Detailed Description

Retrieves special exhibition information based on site and mall.
If a special exhibition number is provided, retrieves the information corresponding to that number.
Retrieves special exhibition information according to brand number, sort type (latest, closing soon), and progress status.
Special exhibition exposure is restricted through authority checks based on membership grade and employee status.

Special Notes

The authority check criteria are based on AND conditions: if ① Display Membership Grade (GREEN) and ② Employee-Only are both checked, the special exhibition is exposed only to 'employees + GREEN members'.
- If none are checked, it is exposed to all users, including non-members.

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

Retrieve Special Exhibition Success

application/json

totalCountinteger · int64Optional

Total Count

Example: 10

400

Retrieve Special Exhibition Failure

application/json

get/v1/plan/planList

GET /api/display/v1/plan/planList?dispMediaCd=text HTTP/1.1
Host: api-display.x2bee.com/
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": "이미지 대체텍스트"
        }
      ]
    }
  ]
}

Retrieve Special Exhibition

get

Function Description

API for retrieving special exhibition information based on the corresponding site/mall.

Detailed Description

Retrieves special exhibition information based on site and mall.
If a special exhibition number is provided, retrieves the information corresponding to that number.
Retrieves special exhibition information according to brand number, sort type (latest, closing soon), and progress status.
Special exhibition exposure is restricted through authority checks based on membership grade and employee status.

Special Notes

The authority check criteria are based on AND conditions: if ① Display Membership Grade (GREEN) and ② Employee-Only are both checked, the special exhibition is exposed only to 'employees + GREEN members'.
- If none are checked, it is exposed to all users, including non-members.

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

Retrieve Special Exhibition Success

application/json

totalCountinteger · int64Optional

Total Count

Example: 10

400

Retrieve Special Exhibition Failure

application/json

get/v1/plan/planWishList

GET /api/display/v1/plan/planWishList?dispMediaCd=text HTTP/1.1
Host: api-display.x2bee.com/
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": "이미지 대체텍스트"
        }
      ]
    }
  ]
}

Retrieve Products by Promotion Divider

get

Function Description

This API retrieves products by divider using the promotion number and divider number.

Detailed Description

If no divider number is provided, retrieves information for all dividers.
- Promotion dividers are displayed in order of display order, then divider number.
The product sort code can be used to set the display order of products. (default: 10)
If there are no products for the divider, an empty value is returned.

Notes

The language code (dataLangCd) can be set via the promotion preview in the BO.

Code Summary

Product Sort Code : 10: Newest, 20: Best-selling, 30: Highest price, 40: Lowest price, 50: Most reviewed

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

Products by promotion divider retrieved successfully

application/json

Promotion Divider DTO

divobjNostringOptional

Classifier No.

Example: 1

divobjNmstringOptional

Delimiter Name

Example: 구분자 이름명

divobjGbCdstringOptional

Divider Type Code

Example: 20

dispSeqstringOptional

Display Order

Example: 1

tmplNostringOptional

Display Template No.

Example: 10020

textDivobjNmstringOptional

Text Delimiter Name

Example: 텍스트구분자명

bnrImgPathNmstringOptional

Divider Image Path

Example: 구분자이미지경로명

bnrImgAltContstringOptional

Divider Image Alt Text

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

htmlFileContstringOptional

HTML File Content

Example: HTML내용

cpnDnldYnstringOptional

Coupon Download Status

Example: N

cpnNostringOptional

Coupon No.

Example: C1001442

cpnBnrImgPathNmstringOptional

Coupon Banner Path

Example: 쿠폰경로명

goodsNostringOptional

Product No.

Example: 10002031

400

Failed to retrieve products by promotion divider

application/json

get/v1/plan/planGoodsInfo

GET /api/display/v1/plan/planGoodsInfo?mkdpNo=text&dispMediaCd=text HTTP/1.1
Host: api-display.x2bee.com/
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"
    }
  ]
}

Retrieve Promotion Details

get

Function Description

This API retrieves the basic information, divider information, and related product information for a promotion using the promotion number.

Detailed Description

Retrieves the promotion's basic information, divider list, related product list, recent promotion list, and promotion image list.
Products per divider are displayed in the configured display order.
If there are no products for the divider, an empty value is returned.
Promotion exposure is restricted based on a permission check according to member grade and employee status.

Notes

The permission check applies an AND condition: if ① display member grade (GREEN) and ② employees-only are both checked, the promotion is displayed only to 'employees + GREEN'.
- If neither is checked, the promotion is displayed to all users, including non-members.
If previewDate has a value, the promotion is displayed regardless of member grade or display status.
The language code (dataLangCd) can be set via the promotion preview in the BO.

Validation Details

Error code 1003: No promotion data
Error code 7010: Promotion requires login
Error code 7020: Promotion member grade restricted

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

Promotion details retrieved successfully

application/json

Promotion Detail Response DTO

resultCdstringOptional

Error Result Code

Example: 1003

resultMsgstringOptional

Error Result Message

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

mkdpNostringOptional

Special Exhibition No.

Example: 14862

mkdpNmstringOptional

Special Exhibition Name

Example: 기획전 명

tmplNostringOptional

Template No.

Example: 10020

tmplFileNmstringOptional

Template File Name

Example: MarketingTemplate1

startDatestring · date-timeOptional

Start Date

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

endDatestring · date-timeOptional

End Date

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

introContstringOptional

Introduction

Example: 소개글 내용

briefDescriptionstringOptional

Brief Description

Example: 간략설명 내용

titleHtmlstringOptional

Title HTML

Example: 타이틀HTML 내용

titleHtmlPcstringOptional

PC Title HTML

Example: PC타이틀HTML 내용

footerContentsstringOptional

Footer File Content

Example: 푸터파일 내용

wishContYnstringOptional

Wishlist Status

Example: N

pcTopYnstringOptional

Pinned Status

Example: N

staffYnstringOptional

Employee Status

Example: N

1003

No promotion data

application/json

7010

Member login required

application/json

7020

Promotion member grade restricted

application/json

get/v1/plan/planDetail/{mkdpNo}

GET /api/display/v1/plan/planDetail/{mkdpNo}?dispMediaCd=text HTTP/1.1
Host: api-display.x2bee.com/
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"
}

Retrieve Special Exhibition Group List

get

Function Description

This API retrieves the list of promotion groups for the site and mall.

Detailed Description

Retrieves the promotion group list using the site number and mall number from the cookie value.
Retrieves only information where the usage status is Y and the current date falls within the display period.
The promotion group list is displayed in ascending order of display order.

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Promotion group retrieved successfully

application/json

Promotion Group Information DTO

dispGrpNostringOptional

Display Group No.

Example: 132

dispGrpNmstringOptional

Display Group Name

Example: 통합몰 그룹

dispSeqstringOptional

Display Order

Example: 1

400

Failed to retrieve promotion group

application/json

get/v1/plan/group

GET /api/display/v1/plan/group HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

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

Retrieve Promotion Brand

get

Function Description

This API retrieves the list of promotion brands for the site and mall.

Detailed Description

Retrieves the promotion brand list using the site number and mall number from the cookie value.

Query parameters

dispMediaCdstringRequired

Display Media Code (DP018)

Example: 20

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Promotion brand retrieved successfully

application/json

Brand DTO

brandNostringOptional

Brand No.

useYnstringOptional

Usage Status

brandImgPathNmstringOptional

Brand Image Path

brandImgFileNmstringOptional

Brand Image File Name

brandNmstringOptional

Brand Name

brandDescCmtstringOptional

Brand Description

schKwdNmstringOptional

Search Keyword

400

Failed to retrieve promotion brand

application/json

get/v1/plan/brand

GET /api/display/v1/plan/brand?dispMediaCd=text HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

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

PreviousDisplay Store

NextDisplay Category

Last updated 1 month ago