For the complete documentation index, see llms.txt. This page is also available as Markdown.

Special Exhibition Information Management

Save Special Exhibition Register/Modify Popup Divider Tab

post

Function Description

  • API for registering/modifying/deleting the Special Exhibition Register/Modify popup Divider tab.


Detailed Description

  • Text, banner, and HTML can be registered as divider types, and one is required.

  • The divider name is used as the divider name that separates products in the divider product list.

  • Input parameters (* : required)

    • create : divobjNm *, divobjGbCd *, tmplNo *, dispYn *, dispSeq *, dispMediaCd *, langCd *, bnrImgPathNm, bnrImgFileNm, cpnBnrImgPathNm, cpnBnrImgFileNm, htmlFileCont, textDivobjNm ,stateForm *

    • update : divobjNo *, divobjNm *, divobjGbCd *, tmplNo *, dispYn *, dispSeq *, dispMediaCd *, langCd *, bnrImgPathNm, bnrImgFileNm, cpnBnrImgPathNm, cpnBnrImgFileNm, htmlFileCont, textDivobjNm ,stateForm *

    • delete : mkdpNo *, divobjNo *

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filesstring · binary[]Optional
Responses
200

Special Exhibition Divider Tab Save Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/savePrMkdpDivobj
POST /api/bo/v1/display/marketingDisplayMgmt/savePrMkdpDivobj HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 885

{
  "files": [
    "binary"
  ],
  "prMkdpDivobjInfoList": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "dispMediaCd": 99,
      "divobjGbCd": 10,
      "divobjNm": "구분자명",
      "dispYn": "Y",
      "dispSeq": 1,
      "tmplNo": 10020,
      "cpnNo": "C1001442",
      "textDivobjNm": "텍스트구분자명",
      "bnrImgPathNm": "/이미지경로명",
      "bnrImgFileNm": "이미지파일명",
      "cpnBnrImgPathNm": "/쿠폰이미지경로명",
      "bnrImgAltCont": "쿠폰이미지대체텍스트",
      "cpnBnrImgFileNm": "쿠폰이미지파일명",
      "htmlFileCont": "HTML내용",
      "imgList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "stateForm": "I"
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Special Exhibition Register/Modify Popup Basic Info Tab - Save Special Exhibition Divider Multilingual

post

Function Description

  • API for saving special exhibition divider multilingual information.


Detailed Description

  • Multilingual information can be entered according to the divider basic information type. (HTML -> HTML, Banner -> Banner, Text -> Text)

  • The divider multilingual name is used as the multilingual divider name that separates products in the divider product list.

  • Input parameters (* : required)

    • update : mkdpNo *, divobjNo *, divobjNm *, txtDivobjNm, bnrImagPathNm, bnrImgFileNm, cpnBnrImgPathNm, cpnBnrImgFileNm, htmlFileCont, langCd *

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filesstring · binary[]Optional
Responses
200

Special Exhibition Divider Information Multilingual Save Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/savePrMkdpDivobjMl
POST /api/bo/v1/display/marketingDisplayMgmt/savePrMkdpDivobjMl HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 879

{
  "files": [
    "binary"
  ],
  "prMkdpDivobjInfo": {
    "langCd": "ko",
    "mkdpNo": 14862,
    "divobjNo": 1,
    "dispMediaCd": 99,
    "divobjGbCd": 10,
    "divobjNm": "구분자명",
    "dispYn": "Y",
    "dispSeq": 1,
    "tmplNo": 10020,
    "cpnNo": "C1001442",
    "textDivobjNm": "텍스트구분자명",
    "bnrImgPathNm": "/이미지경로명",
    "bnrImgFileNm": "이미지파일명",
    "cpnBnrImgPathNm": "/쿠폰이미지경로명",
    "bnrImgAltCont": "쿠폰이미지대체텍스트",
    "cpnBnrImgFileNm": "쿠폰이미지파일명",
    "htmlFileCont": "HTML내용",
    "imgList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "stateForm": "I"
  }
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Save Special Exhibition Register/Modify Popup Basic Info Tab

post

Function Description

  • API for registering and modifying the Special Exhibition Register/Modify popup Basic Info tab.


Detailed Description

  • A site, a mall under the site, and a group under the mall can be selected.

  • List Content 1 and List Content 2 are required. Also, the display medium PC and MO can be registered individually or as common.

  • FO exposure is restricted according to member grade and employee status.

  • Input parameters (* : required)

    • create : mkdpNm *, siteNo *, dpmlNo *, tmplNo *, dispYn *, dispSeq *, dispStrDtm *, dispEndDtm *, mdId *, mkdpTtlHtml, mkdpTtlHtmlPc , htmlContYn, kwdNm, brefDsec, introConts, fotrFileConts, aplyBrand, pcTtopExpYn, langCd *, dispMediaCd *, dispStafYn, mbrDispGradCd

    • update : mkdpNo *, mkdpNm *, siteNo *, dpmlNo *, tmplNo *, dispYn *, dispSeq *, dispStrDtm *, dispEndDtm *, mdId *, mkdpTtlHtml, mkdpTtlHtmlPc , htmlContYn, kwdNm, brefDsec,introConts,fotrFileConts, aplyBrand, pcTtopExpYn, langCd *, dispMediaCd *, dispStafYn, mbrDispGradCd

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filesstring · binary[]Optional
Responses
200

Special Exhibition Basic Info Tab Register/Modify Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/savePrMkdpBase
POST /api/bo/v1/display/marketingDisplayMgmt/savePrMkdpBase HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1531

{
  "files": [
    "binary"
  ],
  "prMkdpBase": {
    "siteNo": 1,
    "langCd": "ko",
    "mkdpNo": 14862,
    "mkdpNm": "기획전 제목",
    "siteNm": "플래티어닷컴",
    "dpmlNo": 10001,
    "tmplNo": 10020,
    "dispYn": "Y",
    "dispSeq": 1,
    "dispStrDtm": "2023-01-01 00:00:00.000",
    "dispEndDtm": "2023-12-31 00:00:00.000",
    "mdId": "tester",
    "mkdpTtlHtml": "HTML_MO",
    "mkdpTtlHtmlPc": "HTML_PC",
    "htmlContYn": "N",
    "kwdNm": "키워드명",
    "brefDesc": "간략설명",
    "introConts": "소개글",
    "fotrFileConts": "푸터파일내용",
    "brandInfoMap": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "aplyBrand": [
      100001,
      100002
    ],
    "pcTtopExpYn": "Y",
    "dispGrpNo": 132,
    "imgList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "deleteList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "dispMediaCd": 20,
    "dispStafYn": "Y",
    "mbrDispGradeCd": [
      30,
      40
    ],
    "bnrImgPathNm": "text",
    "bnrImgAltCont": "text",
    "totalCount": 1,
    "fileIdx": 1,
    "dispStatName": "text",
    "dispMediaNm": "text",
    "dispStat": "text"
  }
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "siteNo": 1,
    "langCd": "ko",
    "mkdpNo": 14862,
    "mkdpNm": "기획전 제목",
    "siteNm": "플래티어닷컴",
    "dpmlNo": 10001,
    "tmplNo": 10020,
    "dispYn": "Y",
    "dispSeq": 1,
    "dispStrDtm": "2023-01-01 00:00:00.000",
    "dispEndDtm": "2023-12-31 00:00:00.000",
    "mdId": "tester",
    "mkdpTtlHtml": "HTML_MO",
    "mkdpTtlHtmlPc": "HTML_PC",
    "htmlContYn": "N",
    "kwdNm": "키워드명",
    "brefDesc": "간략설명",
    "introConts": "소개글",
    "fotrFileConts": "푸터파일내용",
    "brandInfoMap": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "aplyBrand": [
      100001,
      100002
    ],
    "pcTtopExpYn": "Y",
    "dispGrpNo": 132,
    "imgList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "deleteList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "dispMediaCd": 20,
    "dispStafYn": "Y",
    "mbrDispGradeCd": [
      30,
      40
    ],
    "bnrImgPathNm": "text",
    "bnrImgAltCont": "text",
    "totalCount": 1,
    "fileIdx": 1,
    "dispStatName": "text",
    "dispMediaNm": "text",
    "dispStat": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}
Deprecated

Special Exhibition Registration/Modification Popup Product Information Tab - Bulk Save Product Excel

post

Function Description

  • API for bulk-saving products via Excel on the Product Info tab > Product Bulk Registration tab.


Detailed Description

  • Registers products excluding duplicates when registering products via Excel.

  • If duplicate products exist, the duplicate products are returned in list form.

  • Input parameters (* : required)

    • Required values: mkdpNo *, divobjNo *, goodsNo *, itmNo *, dispSeq *

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · PrMkdpGoodsInfo[]

Promotion Product Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002131
goodsNmstringOptional

Product Name

Example: 상품명
dispSeqinteger · int32Optional

Display Order

Example: 1
saleStatCdstringOptional

Sales Status Code

Example: 10
saleStatCdNmstringOptional

Sales Status Code Name

Example: 판매중
entrNostringOptional

Vendor No.

Example: 1000002
entrNmstringOptional

Vendor Name

Example: 플래티어 협력사
norPrcnumberOptional

Regular Price

Example: 25000
salePrcnumberOptional

Discounted Price

Example: 20000
errorMessagestringOptional

Error Message

Example: 해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.
validStatstringOptional

Error Status

timeDealYnstringOptional

Time Deal Application Status

tmdlHistStrDtmstring · date-timeOptional

Time Deal Start Date/Time

tmdlHistEndDtmstring · date-timeOptional

Time Deal End Date/Time

tmdlSalePrcnumberOptional

Time Deal Selling Price

Responses
200

Bulk Save Special Exhibition Product Excel Success

*/*

Promotion Product Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002131
goodsNmstringOptional

Product Name

Example: 상품명
dispSeqinteger · int32Optional

Display Order

Example: 1
saleStatCdstringOptional

Sales Status Code

Example: 10
saleStatCdNmstringOptional

Sales Status Code Name

Example: 판매중
entrNostringOptional

Vendor No.

Example: 1000002
entrNmstringOptional

Vendor Name

Example: 플래티어 협력사
norPrcnumberOptional

Regular Price

Example: 25000
salePrcnumberOptional

Discounted Price

Example: 20000
errorMessagestringOptional

Error Message

Example: 해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.
validStatstringOptional

Error Status

timeDealYnstringOptional

Time Deal Application Status

tmdlHistStrDtmstring · date-timeOptional

Time Deal Start Date/Time

tmdlHistEndDtmstring · date-timeOptional

Time Deal End Date/Time

tmdlSalePrcnumberOptional

Time Deal Selling Price

post/v1/display/marketingDisplayMgmt/saveMarketingMgmtExcelGoodsList
POST /api/bo/v1/display/marketingDisplayMgmt/saveMarketingMgmtExcelGoodsList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 472

[
  {
    "langCd": "ko",
    "mkdpNo": 14862,
    "divobjNo": 1,
    "goodsNo": 10002131,
    "goodsNm": "상품명",
    "dispSeq": 1,
    "saleStatCd": 10,
    "saleStatCdNm": "판매중",
    "entrNo": 1000002,
    "entrNm": "플래티어 협력사",
    "norPrc": 25000,
    "salePrc": 20000,
    "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
    "validStat": "text",
    "timeDealYn": "text",
    "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
    "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
    "tmdlSalePrc": 1
  }
]
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "goodsNo": 10002131,
  "goodsNm": "상품명",
  "dispSeq": 1,
  "saleStatCd": 10,
  "saleStatCdNm": "판매중",
  "entrNo": 1000002,
  "entrNm": "플래티어 협력사",
  "norPrc": 25000,
  "salePrc": 20000,
  "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
  "validStat": "text",
  "timeDealYn": "text",
  "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
  "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
  "tmdlSalePrc": 1
}

Save Special Exhibition Information Management List

post

Function Description

  • API for modifying/deleting the special exhibition information management list.


Detailed Description

  • Modifies/deletes the special exhibition management - special exhibition information via realGrid.

  • Input parameters (* : required)

    • update : mkdpNo *, dispYn *, dispSeq *, dispStrDtm *, dispEndDtm *

    • delete : mkdpNo *

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Special Exhibition List Save Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/saveMarketingDisplayMgmtList
POST /api/bo/v1/display/marketingDisplayMgmt/saveMarketingDisplayMgmtList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6034

{
  "all": [
    {
      "siteNo": 1,
      "langCd": "ko",
      "mkdpNo": 14862,
      "mkdpNm": "기획전 제목",
      "siteNm": "플래티어닷컴",
      "dpmlNo": 10001,
      "tmplNo": 10020,
      "dispYn": "Y",
      "dispSeq": 1,
      "dispStrDtm": "2023-01-01 00:00:00.000",
      "dispEndDtm": "2023-12-31 00:00:00.000",
      "mdId": "tester",
      "mkdpTtlHtml": "HTML_MO",
      "mkdpTtlHtmlPc": "HTML_PC",
      "htmlContYn": "N",
      "kwdNm": "키워드명",
      "brefDesc": "간략설명",
      "introConts": "소개글",
      "fotrFileConts": "푸터파일내용",
      "brandInfoMap": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "aplyBrand": [
        100001,
        100002
      ],
      "pcTtopExpYn": "Y",
      "dispGrpNo": 132,
      "imgList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "deleteList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "dispMediaCd": 20,
      "dispStafYn": "Y",
      "mbrDispGradeCd": [
        30,
        40
      ],
      "bnrImgPathNm": "text",
      "bnrImgAltCont": "text",
      "totalCount": 1,
      "fileIdx": 1,
      "dispStatName": "text",
      "dispMediaNm": "text",
      "dispStat": "text"
    }
  ],
  "create": [
    {
      "siteNo": 1,
      "langCd": "ko",
      "mkdpNo": 14862,
      "mkdpNm": "기획전 제목",
      "siteNm": "플래티어닷컴",
      "dpmlNo": 10001,
      "tmplNo": 10020,
      "dispYn": "Y",
      "dispSeq": 1,
      "dispStrDtm": "2023-01-01 00:00:00.000",
      "dispEndDtm": "2023-12-31 00:00:00.000",
      "mdId": "tester",
      "mkdpTtlHtml": "HTML_MO",
      "mkdpTtlHtmlPc": "HTML_PC",
      "htmlContYn": "N",
      "kwdNm": "키워드명",
      "brefDesc": "간략설명",
      "introConts": "소개글",
      "fotrFileConts": "푸터파일내용",
      "brandInfoMap": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "aplyBrand": [
        100001,
        100002
      ],
      "pcTtopExpYn": "Y",
      "dispGrpNo": 132,
      "imgList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "deleteList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "dispMediaCd": 20,
      "dispStafYn": "Y",
      "mbrDispGradeCd": [
        30,
        40
      ],
      "bnrImgPathNm": "text",
      "bnrImgAltCont": "text",
      "totalCount": 1,
      "fileIdx": 1,
      "dispStatName": "text",
      "dispMediaNm": "text",
      "dispStat": "text"
    }
  ],
  "update": [
    {
      "siteNo": 1,
      "langCd": "ko",
      "mkdpNo": 14862,
      "mkdpNm": "기획전 제목",
      "siteNm": "플래티어닷컴",
      "dpmlNo": 10001,
      "tmplNo": 10020,
      "dispYn": "Y",
      "dispSeq": 1,
      "dispStrDtm": "2023-01-01 00:00:00.000",
      "dispEndDtm": "2023-12-31 00:00:00.000",
      "mdId": "tester",
      "mkdpTtlHtml": "HTML_MO",
      "mkdpTtlHtmlPc": "HTML_PC",
      "htmlContYn": "N",
      "kwdNm": "키워드명",
      "brefDesc": "간략설명",
      "introConts": "소개글",
      "fotrFileConts": "푸터파일내용",
      "brandInfoMap": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "aplyBrand": [
        100001,
        100002
      ],
      "pcTtopExpYn": "Y",
      "dispGrpNo": 132,
      "imgList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "deleteList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "dispMediaCd": 20,
      "dispStafYn": "Y",
      "mbrDispGradeCd": [
        30,
        40
      ],
      "bnrImgPathNm": "text",
      "bnrImgAltCont": "text",
      "totalCount": 1,
      "fileIdx": 1,
      "dispStatName": "text",
      "dispMediaNm": "text",
      "dispStat": "text"
    }
  ],
  "delete": [
    {
      "siteNo": 1,
      "langCd": "ko",
      "mkdpNo": 14862,
      "mkdpNm": "기획전 제목",
      "siteNm": "플래티어닷컴",
      "dpmlNo": 10001,
      "tmplNo": 10020,
      "dispYn": "Y",
      "dispSeq": 1,
      "dispStrDtm": "2023-01-01 00:00:00.000",
      "dispEndDtm": "2023-12-31 00:00:00.000",
      "mdId": "tester",
      "mkdpTtlHtml": "HTML_MO",
      "mkdpTtlHtmlPc": "HTML_PC",
      "htmlContYn": "N",
      "kwdNm": "키워드명",
      "brefDesc": "간략설명",
      "introConts": "소개글",
      "fotrFileConts": "푸터파일내용",
      "brandInfoMap": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "aplyBrand": [
        100001,
        100002
      ],
      "pcTtopExpYn": "Y",
      "dispGrpNo": 132,
      "imgList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "deleteList": [
        {
          "langCd": "ko",
          "dispShopGbCd": "01",
          "shopCtgNo": 132,
          "imgTypCd": "01",
          "imgSn": 133,
          "bnrImgPathNm": "/배너이미지경로",
          "bnrImgFileNm": "배너이미지파일명",
          "bnrImgAltCont": "배너이미지 대체텍스트",
          "linkUrlAddr": "/연결URL주소",
          "dispMediaCd": 99,
          "dispStat": 10,
          "contPathNm": "/썸네일이미지경로",
          "contGbCd": "text",
          "copyShopCtgNo": "text",
          "fileIdx": 1
        }
      ],
      "dispMediaCd": 20,
      "dispStafYn": "Y",
      "mbrDispGradeCd": [
        30,
        40
      ],
      "bnrImgPathNm": "text",
      "bnrImgAltCont": "text",
      "totalCount": 1,
      "fileIdx": 1,
      "dispStatName": "text",
      "dispMediaNm": "text",
      "dispStat": "text"
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Special Exhibition Register/Modify Popup Basic Info Tab - Save Special Exhibition Basic Info Multilingual

post

Function Description

  • API for saving special exhibition basic information multilingual data.


Detailed Description

  • List Content 1 and List Content 2 are required. Also, the display medium PC and MO can be registered individually or as common.

  • Input parameters (* : required)

    • update : mkdpNo *, mkdpNm *, mkdpTtlHtml , mkdpTtlHtmlPc , brefDesc, introConts, fotrFileConts, langcd *

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filesstring · binary[]Optional
Responses
200

Special Exhibition Basic Information Multilingual Save Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/saveMarketingDisplayMgmtBaseMl
POST /api/bo/v1/display/marketingDisplayMgmt/saveMarketingDisplayMgmtBaseMl HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1531

{
  "files": [
    "binary"
  ],
  "prMkdpBase": {
    "siteNo": 1,
    "langCd": "ko",
    "mkdpNo": 14862,
    "mkdpNm": "기획전 제목",
    "siteNm": "플래티어닷컴",
    "dpmlNo": 10001,
    "tmplNo": 10020,
    "dispYn": "Y",
    "dispSeq": 1,
    "dispStrDtm": "2023-01-01 00:00:00.000",
    "dispEndDtm": "2023-12-31 00:00:00.000",
    "mdId": "tester",
    "mkdpTtlHtml": "HTML_MO",
    "mkdpTtlHtmlPc": "HTML_PC",
    "htmlContYn": "N",
    "kwdNm": "키워드명",
    "brefDesc": "간략설명",
    "introConts": "소개글",
    "fotrFileConts": "푸터파일내용",
    "brandInfoMap": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "aplyBrand": [
      100001,
      100002
    ],
    "pcTtopExpYn": "Y",
    "dispGrpNo": 132,
    "imgList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "deleteList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "dispMediaCd": 20,
    "dispStafYn": "Y",
    "mbrDispGradeCd": [
      30,
      40
    ],
    "bnrImgPathNm": "text",
    "bnrImgAltCont": "text",
    "totalCount": 1,
    "fileIdx": 1,
    "dispStatName": "text",
    "dispMediaNm": "text",
    "dispStat": "text"
  }
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "siteNo": 1,
    "langCd": "ko",
    "mkdpNo": 14862,
    "mkdpNm": "기획전 제목",
    "siteNm": "플래티어닷컴",
    "dpmlNo": 10001,
    "tmplNo": 10020,
    "dispYn": "Y",
    "dispSeq": 1,
    "dispStrDtm": "2023-01-01 00:00:00.000",
    "dispEndDtm": "2023-12-31 00:00:00.000",
    "mdId": "tester",
    "mkdpTtlHtml": "HTML_MO",
    "mkdpTtlHtmlPc": "HTML_PC",
    "htmlContYn": "N",
    "kwdNm": "키워드명",
    "brefDesc": "간략설명",
    "introConts": "소개글",
    "fotrFileConts": "푸터파일내용",
    "brandInfoMap": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "aplyBrand": [
      100001,
      100002
    ],
    "pcTtopExpYn": "Y",
    "dispGrpNo": 132,
    "imgList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "deleteList": [
      {
        "langCd": "ko",
        "dispShopGbCd": "01",
        "shopCtgNo": 132,
        "imgTypCd": "01",
        "imgSn": 133,
        "bnrImgPathNm": "/배너이미지경로",
        "bnrImgFileNm": "배너이미지파일명",
        "bnrImgAltCont": "배너이미지 대체텍스트",
        "linkUrlAddr": "/연결URL주소",
        "dispMediaCd": 99,
        "dispStat": 10,
        "contPathNm": "/썸네일이미지경로",
        "contGbCd": "text",
        "copyShopCtgNo": "text",
        "fileIdx": 1
      }
    ],
    "dispMediaCd": 20,
    "dispStafYn": "Y",
    "mbrDispGradeCd": [
      30,
      40
    ],
    "bnrImgPathNm": "text",
    "bnrImgAltCont": "text",
    "totalCount": 1,
    "fileIdx": 1,
    "dispStatName": "text",
    "dispMediaNm": "text",
    "dispStat": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Special Exhibition Register/Modify Popup Product Info Tab - Save Product Grid

post

Function Description

  • API for registering/modifying/deleting the Product Info tab - product grid.


Detailed Description

  • Saves the corresponding product list information via realGrid.

  • Input parameters (* : required)

    • create : mkdpNo *, divobjNo *, goodsNo *, itmNo *, dispSeq *

    • update : mkdpNo *, divobjNo *, goodsNo *, itmNo *, dispSeq *

    • delete : mkdpNo *, divobjNo *, goodsNo *, itmNo *

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Special Exhibition Product Information Save Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/saveDivobjGoodsGridList
POST /api/bo/v1/display/marketingDisplayMgmt/saveDivobjGoodsGridList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1926

{
  "all": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "goodsNo": 10002131,
      "goodsNm": "상품명",
      "dispSeq": 1,
      "saleStatCd": 10,
      "saleStatCdNm": "판매중",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "norPrc": 25000,
      "salePrc": 20000,
      "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
      "validStat": "text",
      "timeDealYn": "text",
      "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
      "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
      "tmdlSalePrc": 1
    }
  ],
  "create": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "goodsNo": 10002131,
      "goodsNm": "상품명",
      "dispSeq": 1,
      "saleStatCd": 10,
      "saleStatCdNm": "판매중",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "norPrc": 25000,
      "salePrc": 20000,
      "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
      "validStat": "text",
      "timeDealYn": "text",
      "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
      "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
      "tmdlSalePrc": 1
    }
  ],
  "update": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "goodsNo": 10002131,
      "goodsNm": "상품명",
      "dispSeq": 1,
      "saleStatCd": 10,
      "saleStatCdNm": "판매중",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "norPrc": 25000,
      "salePrc": 20000,
      "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
      "validStat": "text",
      "timeDealYn": "text",
      "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
      "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
      "tmdlSalePrc": 1
    }
  ],
  "delete": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "goodsNo": 10002131,
      "goodsNm": "상품명",
      "dispSeq": 1,
      "saleStatCd": 10,
      "saleStatCdNm": "판매중",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "norPrc": 25000,
      "salePrc": 20000,
      "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
      "validStat": "text",
      "timeDealYn": "text",
      "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
      "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
      "tmdlSalePrc": 1
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Special Exhibition Registration/Modification Popup Product Information Tab - Bulk Save Product Excel

post

Function Description

  • API for bulk-saving products via Excel on the Product Info tab > Product Bulk Registration tab.


Detailed Description

  • Registers products excluding duplicates when registering products via Excel.

  • If a product exception occurs, an error message is included with the product and returned as the result.

  • Only general products can be registered.

  • Input parameters (* : required)

    • Required values: mkdpNo *, divobjNo *, goodsNo *, itmNo *, dispSeq *


Notes (Error Messages)

  • Not found or bundle product: The corresponding product number does not exist or is a bundle product.

  • Duplicate product, duplicate entered product: This product has already been added.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · PrMkdpGoodsInfo[]

Promotion Product Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002131
goodsNmstringOptional

Product Name

Example: 상품명
dispSeqinteger · int32Optional

Display Order

Example: 1
saleStatCdstringOptional

Sales Status Code

Example: 10
saleStatCdNmstringOptional

Sales Status Code Name

Example: 판매중
entrNostringOptional

Vendor No.

Example: 1000002
entrNmstringOptional

Vendor Name

Example: 플래티어 협력사
norPrcnumberOptional

Regular Price

Example: 25000
salePrcnumberOptional

Discounted Price

Example: 20000
errorMessagestringOptional

Error Message

Example: 해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.
validStatstringOptional

Error Status

timeDealYnstringOptional

Time Deal Application Status

tmdlHistStrDtmstring · date-timeOptional

Time Deal Start Date/Time

tmdlHistEndDtmstring · date-timeOptional

Time Deal End Date/Time

tmdlSalePrcnumberOptional

Time Deal Selling Price

Responses
200

Bulk Save Special Exhibition Product Excel Success

*/*

Promotion Product Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002131
goodsNmstringOptional

Product Name

Example: 상품명
dispSeqinteger · int32Optional

Display Order

Example: 1
saleStatCdstringOptional

Sales Status Code

Example: 10
saleStatCdNmstringOptional

Sales Status Code Name

Example: 판매중
entrNostringOptional

Vendor No.

Example: 1000002
entrNmstringOptional

Vendor Name

Example: 플래티어 협력사
norPrcnumberOptional

Regular Price

Example: 25000
salePrcnumberOptional

Discounted Price

Example: 20000
errorMessagestringOptional

Error Message

Example: 해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.
validStatstringOptional

Error Status

timeDealYnstringOptional

Time Deal Application Status

tmdlHistStrDtmstring · date-timeOptional

Time Deal Start Date/Time

tmdlHistEndDtmstring · date-timeOptional

Time Deal End Date/Time

tmdlSalePrcnumberOptional

Time Deal Selling Price

post/v1/display/marketingDisplayMgmt/saveBulkDivobjGoodsUpload
POST /api/bo/v1/display/marketingDisplayMgmt/saveBulkDivobjGoodsUpload HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 472

[
  {
    "langCd": "ko",
    "mkdpNo": 14862,
    "divobjNo": 1,
    "goodsNo": 10002131,
    "goodsNm": "상품명",
    "dispSeq": 1,
    "saleStatCd": 10,
    "saleStatCdNm": "판매중",
    "entrNo": 1000002,
    "entrNm": "플래티어 협력사",
    "norPrc": 25000,
    "salePrc": 20000,
    "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
    "validStat": "text",
    "timeDealYn": "text",
    "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
    "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
    "tmdlSalePrc": 1
  }
]
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "goodsNo": 10002131,
  "goodsNm": "상품명",
  "dispSeq": 1,
  "saleStatCd": 10,
  "saleStatCdNm": "판매중",
  "entrNo": 1000002,
  "entrNm": "플래티어 협력사",
  "norPrc": 25000,
  "salePrc": 20000,
  "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
  "validStat": "text",
  "timeDealYn": "text",
  "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
  "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
  "tmdlSalePrc": 1
}

Special Exhibition Management - Copy Single Special Exhibition

post

Function Description

  • API for copying a single special exhibition.


Detailed Description

  • When a special exhibition is copied, the copied special exhibition name is saved in the format 'Special Exhibition Name + (Copy)'.

  • The display status of the copied special exhibition is fixed to Not Displayed.

  • Input parameters (* : required)

    • Required values: mkdpNo *


Revision History

  • Release v1.05_231204 : Sprint 5 PO1 defect/improvement - Improved query WHERE clause

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Promotion Basic

siteNostringOptional

Site No.

Example: 1
langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
mkdpNmstringOptional

Special Exhibition Name

Example: 기획전 제목
siteNmstringOptional

Site Name

Example: 플래티어닷컴
dpmlNostringOptional

Mall No.

Example: 10001
tmplNostringOptional

Template No.

Example: 10020
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
dispStrDtmstring · date-timeOptional

Display Start Date/Time

Example: 2023-01-01 00:00:00.000
dispEndDtmstring · date-timeOptional

Display End Date/Time

Example: 2023-12-31 00:00:00.000
mdIdstringOptional

MD in Charge

Example: tester
mkdpTtlHtmlstringOptional

Promotion Title HTML_MO

Example: HTML_MO
mkdpTtlHtmlPcstringOptional

Promotion Title HTML_PC

Example: HTML_PC
htmlContYnstringOptional

HTML Content Availability

Example: N
kwdNmstringOptional

Keyword Name

Example: 키워드명
brefDescstringOptional

Brief Description

Example: 간략설명
introContsstringOptional

Introduction

Example: 소개글
fotrFileContsstringOptional

Footer File Content

Example: 푸터파일내용
aplyBrandstring[]Optional

Promotion Brand List

Example: [100001,100002]
pcTtopExpYnstringOptional

PC Top Exposure Status

Example: Y
dispGrpNostringOptional

Display Group No.

Example: 132
dispMediaCdstringOptional

Display Media Code

Example: 20
dispStafYnstringOptional

Employee Status

Example: Y
mbrDispGradeCdstring[]Optional

Display Member Code Array

Example: [30,40]
bnrImgPathNmstringOptional

Banner Image Path Name

bnrImgAltContstringOptional

Banner Image Alt Text

totalCountinteger · int32Optional

Total Count

fileIdxinteger · int32Optional

Uploaded File Sequence No.

dispStatNamestringOptional
dispMediaNmstringOptional
dispStatstringOptional
Responses
200

Special Exhibition Copy Successful

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/registerCopyMarketingDisplayMgmt
POST /api/bo/v1/display/marketingDisplayMgmt/registerCopyMarketingDisplayMgmt HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1497

{
  "siteNo": 1,
  "langCd": "ko",
  "mkdpNo": 14862,
  "mkdpNm": "기획전 제목",
  "siteNm": "플래티어닷컴",
  "dpmlNo": 10001,
  "tmplNo": 10020,
  "dispYn": "Y",
  "dispSeq": 1,
  "dispStrDtm": "2023-01-01 00:00:00.000",
  "dispEndDtm": "2023-12-31 00:00:00.000",
  "mdId": "tester",
  "mkdpTtlHtml": "HTML_MO",
  "mkdpTtlHtmlPc": "HTML_PC",
  "htmlContYn": "N",
  "kwdNm": "키워드명",
  "brefDesc": "간략설명",
  "introConts": "소개글",
  "fotrFileConts": "푸터파일내용",
  "brandInfoMap": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "aplyBrand": [
    100001,
    100002
  ],
  "pcTtopExpYn": "Y",
  "dispGrpNo": 132,
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "deleteList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "dispMediaCd": 20,
  "dispStafYn": "Y",
  "mbrDispGradeCd": [
    30,
    40
  ],
  "bnrImgPathNm": "text",
  "bnrImgAltCont": "text",
  "totalCount": 1,
  "fileIdx": 1,
  "dispStatName": "text",
  "dispMediaNm": "text",
  "dispStat": "text"
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}
Deprecated

Retrieve Duplicate/Non-Existent Product Exclusion List for Special Exhibition Product Bulk Registration

post

Function Description

  • API that returns the corresponding list excluding duplicate and non-existent products from the special exhibition product bulk registration.


Detailed Description

  • If a product exception occurs, an error message is included with the product and returned as the result.

  • Only general products can be registered.


Notes (Error Messages)

  • Not found or bundle product: The corresponding product number does not exist or is a bundle product.

  • Duplicate product: Product numbers cannot be duplicated.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
divobjNostringRequired

Classifier No.

Example: 1
goodsInfoListListRequired

Product Information List

Body

Promotion Product Information Search Model

mkdpNostringOptional

Special Exhibition No.

divobjNostringOptional

Classifier No.

goodsNostringOptional

Product No.

dispSeqinteger · int32Optional

Display Order

goodsArraystring[]Optional

Product No. Array

Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v1/display/marketingDisplayMgmt/getValidPlanShopGoodsList
POST /api/bo/v1/display/marketingDisplayMgmt/getValidPlanShopGoodsList?mkdpNo=text&divobjNo=text&goodsInfoList=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 575

{
  "mkdpNo": "text",
  "divobjNo": "text",
  "goodsNo": "text",
  "dispSeq": 1,
  "goodsArray": [
    "text"
  ],
  "goodsInfoList": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "goodsNo": 10002131,
      "goodsNm": "상품명",
      "dispSeq": 1,
      "saleStatCd": 10,
      "saleStatCdNm": "판매중",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "norPrc": 25000,
      "salePrc": 20000,
      "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
      "validStat": "text",
      "timeDealYn": "text",
      "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
      "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
      "tmdlSalePrc": 1
    }
  ]
}
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": [
    {
      "langCd": "ko",
      "mkdpNo": 14862,
      "divobjNo": 1,
      "goodsNo": 10002131,
      "goodsNm": "상품명",
      "dispSeq": 1,
      "saleStatCd": 10,
      "saleStatCdNm": "판매중",
      "entrNo": 1000002,
      "entrNm": "플래티어 협력사",
      "norPrc": 25000,
      "salePrc": 20000,
      "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
      "validStat": "text",
      "timeDealYn": "text",
      "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
      "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
      "tmdlSalePrc": 1
    }
  ],
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Special Exhibition Popup Divider Tab - Retrieve Divider Multilingual Information

get

Function Description

  • API for retrieving special exhibition divider multilingual information.


Detailed Description

  • Retrieves special exhibition divider multilingual information by receiving the special exhibition number and language code.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
divobjNostringRequired

Classifier No.

Example: 1
langCdstringRequired

Language Code

Example: en
Responses
200

Special Exhibition Divider Multilingual Information Inquiry Successful

*/*

Promotion Divider Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
dispMediaCdstringOptional

Display Media Code (DP018)

Example: 99
divobjGbCdstringOptional

Divider Type Code (DP024)

Example: 10
divobjNmstringOptional

Delimiter Name

Example: 구분자명
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
tmplNostringOptional

Template No.

Example: 10020
cpnNostringOptional

Coupon No.

Example: C1001442
textDivobjNmstringOptional

Text Delimiter Name

Example: 텍스트구분자명
bnrImgPathNmstringOptional

Banner Image Path Name

Example: /이미지경로명
bnrImgFileNmstringOptional

Banner Image File Name

Example: 이미지파일명
cpnBnrImgPathNmstringOptional

Coupon Banner Image Path

Example: /쿠폰이미지경로명
bnrImgAltContstringOptional

Coupon Banner Image Alt Text

Example: 쿠폰이미지대체텍스트
cpnBnrImgFileNmstringOptional

Coupon Banner Image File Name

Example: 쿠폰이미지파일명
htmlFileContstringOptional

HTML File Content

Example: HTML내용
stateFormstringOptional

Divider Status

Example: I
get/v1/display/marketingDisplayMgmt/getPrMkdpDivobjMultiLanguage
GET /api/bo/v1/display/marketingDisplayMgmt/getPrMkdpDivobjMultiLanguage?mkdpNo=text&divobjNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "dispMediaCd": 99,
  "divobjGbCd": 10,
  "divobjNm": "구분자명",
  "dispYn": "Y",
  "dispSeq": 1,
  "tmplNo": 10020,
  "cpnNo": "C1001442",
  "textDivobjNm": "텍스트구분자명",
  "bnrImgPathNm": "/이미지경로명",
  "bnrImgFileNm": "이미지파일명",
  "cpnBnrImgPathNm": "/쿠폰이미지경로명",
  "bnrImgAltCont": "쿠폰이미지대체텍스트",
  "cpnBnrImgFileNm": "쿠폰이미지파일명",
  "htmlFileCont": "HTML내용",
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "stateForm": "I"
}

Special Exhibition Popup Basic Info Tab - Retrieve Basic Info Multilingual

get

Function Description

  • API for retrieving special exhibition basic information multilingual detail information.


Detailed Description

  • Retrieves special exhibition multilingual basic information by receiving the special exhibition number and language code.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
langCdstringRequired

Language Code

Example: en
Responses
200

Special Exhibition Basic Information Multilingual Inquiry Successful

*/*

Promotion Basic

siteNostringOptional

Site No.

Example: 1
langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
mkdpNmstringOptional

Special Exhibition Name

Example: 기획전 제목
siteNmstringOptional

Site Name

Example: 플래티어닷컴
dpmlNostringOptional

Mall No.

Example: 10001
tmplNostringOptional

Template No.

Example: 10020
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
dispStrDtmstring · date-timeOptional

Display Start Date/Time

Example: 2023-01-01 00:00:00.000
dispEndDtmstring · date-timeOptional

Display End Date/Time

Example: 2023-12-31 00:00:00.000
mdIdstringOptional

MD in Charge

Example: tester
mkdpTtlHtmlstringOptional

Promotion Title HTML_MO

Example: HTML_MO
mkdpTtlHtmlPcstringOptional

Promotion Title HTML_PC

Example: HTML_PC
htmlContYnstringOptional

HTML Content Availability

Example: N
kwdNmstringOptional

Keyword Name

Example: 키워드명
brefDescstringOptional

Brief Description

Example: 간략설명
introContsstringOptional

Introduction

Example: 소개글
fotrFileContsstringOptional

Footer File Content

Example: 푸터파일내용
aplyBrandstring[]Optional

Promotion Brand List

Example: [100001,100002]
pcTtopExpYnstringOptional

PC Top Exposure Status

Example: Y
dispGrpNostringOptional

Display Group No.

Example: 132
dispMediaCdstringOptional

Display Media Code

Example: 20
dispStafYnstringOptional

Employee Status

Example: Y
mbrDispGradeCdstring[]Optional

Display Member Code Array

Example: [30,40]
bnrImgPathNmstringOptional

Banner Image Path Name

bnrImgAltContstringOptional

Banner Image Alt Text

totalCountinteger · int32Optional

Total Count

fileIdxinteger · int32Optional

Uploaded File Sequence No.

dispStatNamestringOptional
dispMediaNmstringOptional
dispStatstringOptional
get/v1/display/marketingDisplayMgmt/getPrMkdpBaseMultiLanguage
GET /api/bo/v1/display/marketingDisplayMgmt/getPrMkdpBaseMultiLanguage?mkdpNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "siteNo": 1,
  "langCd": "ko",
  "mkdpNo": 14862,
  "mkdpNm": "기획전 제목",
  "siteNm": "플래티어닷컴",
  "dpmlNo": 10001,
  "tmplNo": 10020,
  "dispYn": "Y",
  "dispSeq": 1,
  "dispStrDtm": "2023-01-01 00:00:00.000",
  "dispEndDtm": "2023-12-31 00:00:00.000",
  "mdId": "tester",
  "mkdpTtlHtml": "HTML_MO",
  "mkdpTtlHtmlPc": "HTML_PC",
  "htmlContYn": "N",
  "kwdNm": "키워드명",
  "brefDesc": "간략설명",
  "introConts": "소개글",
  "fotrFileConts": "푸터파일내용",
  "brandInfoMap": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "aplyBrand": [
    100001,
    100002
  ],
  "pcTtopExpYn": "Y",
  "dispGrpNo": 132,
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "deleteList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "dispMediaCd": 20,
  "dispStafYn": "Y",
  "mbrDispGradeCd": [
    30,
    40
  ],
  "bnrImgPathNm": "text",
  "bnrImgAltCont": "text",
  "totalCount": 1,
  "fileIdx": 1,
  "dispStatName": "text",
  "dispMediaNm": "text",
  "dispStat": "text"
}

Special Exhibition Information Management - Retrieve Special Exhibition Information List

get

Function Description

  • API for retrieving the special exhibition information list.


Detailed Description

  • Retrieves special exhibition information according to the inquiry conditions of Special Exhibition No., Special Exhibition Name, MD in charge, User ID, Display Status, Brand Name, Display Start Date, Display End Date, Special Exhibition Status, Site No., and Group No.

    • Retrieved by Site No., Mall No. under the site, and Display Group No. under the mall.

  • The special exhibition information list is displayed in descending order of display order and descending order of display start date.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringOptional

Special Exhibition No.

Example: 14862
mkdpNmstringOptional

Special Exhibition Name

Example: 성능테스트 기획전
mdIdstringOptional

MD in Charge

dispMediaCdstringOptional

Display Media Code (DP018)

Example: 99
userIdstringOptional

User ID

dispYnstringOptional

Display Status

Example: Y
brandNmstringOptional

Brand Name

startDatestringOptional

Display Start Date

Example: 20230101
endDatestringOptional

Display End Date

Example: 20991231
dispStatstringOptional

Special Exhibition Status

Example: 20
siteNostringOptional

Site No.

Example: 1
dpmlNostringOptional

Mall No.

Example: 10001
dispGrpNostringOptional

Display Group No.

Example: 132
rowsPerPagestringRequired

Rows per Page

Example: 100
pageIdxstringRequired

Current Page

Example: 1
Responses
200

Special Exhibition Information Inquiry Successful

*/*

Promotion Basic

siteNostringOptional

Site No.

Example: 1
langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
mkdpNmstringOptional

Special Exhibition Name

Example: 기획전 제목
siteNmstringOptional

Site Name

Example: 플래티어닷컴
dpmlNostringOptional

Mall No.

Example: 10001
tmplNostringOptional

Template No.

Example: 10020
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
dispStrDtmstring · date-timeOptional

Display Start Date/Time

Example: 2023-01-01 00:00:00.000
dispEndDtmstring · date-timeOptional

Display End Date/Time

Example: 2023-12-31 00:00:00.000
mdIdstringOptional

MD in Charge

Example: tester
mkdpTtlHtmlstringOptional

Promotion Title HTML_MO

Example: HTML_MO
mkdpTtlHtmlPcstringOptional

Promotion Title HTML_PC

Example: HTML_PC
htmlContYnstringOptional

HTML Content Availability

Example: N
kwdNmstringOptional

Keyword Name

Example: 키워드명
brefDescstringOptional

Brief Description

Example: 간략설명
introContsstringOptional

Introduction

Example: 소개글
fotrFileContsstringOptional

Footer File Content

Example: 푸터파일내용
aplyBrandstring[]Optional

Promotion Brand List

Example: [100001,100002]
pcTtopExpYnstringOptional

PC Top Exposure Status

Example: Y
dispGrpNostringOptional

Display Group No.

Example: 132
dispMediaCdstringOptional

Display Media Code

Example: 20
dispStafYnstringOptional

Employee Status

Example: Y
mbrDispGradeCdstring[]Optional

Display Member Code Array

Example: [30,40]
bnrImgPathNmstringOptional

Banner Image Path Name

bnrImgAltContstringOptional

Banner Image Alt Text

totalCountinteger · int32Optional

Total Count

fileIdxinteger · int32Optional

Uploaded File Sequence No.

dispStatNamestringOptional
dispMediaNmstringOptional
dispStatstringOptional
get/v1/display/marketingDisplayMgmt/getPrMkdpBaseList
GET /api/bo/v1/display/marketingDisplayMgmt/getPrMkdpBaseList?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "siteNo": 1,
  "langCd": "ko",
  "mkdpNo": 14862,
  "mkdpNm": "기획전 제목",
  "siteNm": "플래티어닷컴",
  "dpmlNo": 10001,
  "tmplNo": 10020,
  "dispYn": "Y",
  "dispSeq": 1,
  "dispStrDtm": "2023-01-01 00:00:00.000",
  "dispEndDtm": "2023-12-31 00:00:00.000",
  "mdId": "tester",
  "mkdpTtlHtml": "HTML_MO",
  "mkdpTtlHtmlPc": "HTML_PC",
  "htmlContYn": "N",
  "kwdNm": "키워드명",
  "brefDesc": "간략설명",
  "introConts": "소개글",
  "fotrFileConts": "푸터파일내용",
  "brandInfoMap": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "aplyBrand": [
    100001,
    100002
  ],
  "pcTtopExpYn": "Y",
  "dispGrpNo": 132,
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "deleteList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "dispMediaCd": 20,
  "dispStafYn": "Y",
  "mbrDispGradeCd": [
    30,
    40
  ],
  "bnrImgPathNm": "text",
  "bnrImgAltCont": "text",
  "totalCount": 1,
  "fileIdx": 1,
  "dispStatName": "text",
  "dispMediaNm": "text",
  "dispStat": "text"
}

Special Exhibition Popup - Retrieve Special Exhibition Information Detail

get

Function Description

  • API for retrieving special exhibition detail information.


Detailed Description

  • Retrieves special exhibition detail information by receiving the special exhibition number and language code.


Revision History

  • Release v1.05_231204 : Sprint 5 PO1 defect/improvement - Improved query WHERE clause

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
langCdstringRequired

Language Code

Example: ko
Responses
200

Special Exhibition Detail Information Inquiry Successful

*/*

Promotion Basic

siteNostringOptional

Site No.

Example: 1
langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
mkdpNmstringOptional

Special Exhibition Name

Example: 기획전 제목
siteNmstringOptional

Site Name

Example: 플래티어닷컴
dpmlNostringOptional

Mall No.

Example: 10001
tmplNostringOptional

Template No.

Example: 10020
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
dispStrDtmstring · date-timeOptional

Display Start Date/Time

Example: 2023-01-01 00:00:00.000
dispEndDtmstring · date-timeOptional

Display End Date/Time

Example: 2023-12-31 00:00:00.000
mdIdstringOptional

MD in Charge

Example: tester
mkdpTtlHtmlstringOptional

Promotion Title HTML_MO

Example: HTML_MO
mkdpTtlHtmlPcstringOptional

Promotion Title HTML_PC

Example: HTML_PC
htmlContYnstringOptional

HTML Content Availability

Example: N
kwdNmstringOptional

Keyword Name

Example: 키워드명
brefDescstringOptional

Brief Description

Example: 간략설명
introContsstringOptional

Introduction

Example: 소개글
fotrFileContsstringOptional

Footer File Content

Example: 푸터파일내용
aplyBrandstring[]Optional

Promotion Brand List

Example: [100001,100002]
pcTtopExpYnstringOptional

PC Top Exposure Status

Example: Y
dispGrpNostringOptional

Display Group No.

Example: 132
dispMediaCdstringOptional

Display Media Code

Example: 20
dispStafYnstringOptional

Employee Status

Example: Y
mbrDispGradeCdstring[]Optional

Display Member Code Array

Example: [30,40]
bnrImgPathNmstringOptional

Banner Image Path Name

bnrImgAltContstringOptional

Banner Image Alt Text

totalCountinteger · int32Optional

Total Count

fileIdxinteger · int32Optional

Uploaded File Sequence No.

dispStatNamestringOptional
dispMediaNmstringOptional
dispStatstringOptional
get/v1/display/marketingDisplayMgmt/getPrMkdpBaseDetail
GET /api/bo/v1/display/marketingDisplayMgmt/getPrMkdpBaseDetail?mkdpNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "siteNo": 1,
  "langCd": "ko",
  "mkdpNo": 14862,
  "mkdpNm": "기획전 제목",
  "siteNm": "플래티어닷컴",
  "dpmlNo": 10001,
  "tmplNo": 10020,
  "dispYn": "Y",
  "dispSeq": 1,
  "dispStrDtm": "2023-01-01 00:00:00.000",
  "dispEndDtm": "2023-12-31 00:00:00.000",
  "mdId": "tester",
  "mkdpTtlHtml": "HTML_MO",
  "mkdpTtlHtmlPc": "HTML_PC",
  "htmlContYn": "N",
  "kwdNm": "키워드명",
  "brefDesc": "간략설명",
  "introConts": "소개글",
  "fotrFileConts": "푸터파일내용",
  "brandInfoMap": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "aplyBrand": [
    100001,
    100002
  ],
  "pcTtopExpYn": "Y",
  "dispGrpNo": 132,
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "deleteList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "dispMediaCd": 20,
  "dispStafYn": "Y",
  "mbrDispGradeCd": [
    30,
    40
  ],
  "bnrImgPathNm": "text",
  "bnrImgAltCont": "text",
  "totalCount": 1,
  "fileIdx": 1,
  "dispStatName": "text",
  "dispMediaNm": "text",
  "dispStat": "text"
}

Special Exhibition Popup - Retrieve Special Exhibition Image Detail

get

Function Description

  • API for retrieving special exhibition image detail information.


Detailed Description

  • Retrieves special exhibition image detail information by receiving the special exhibition number and language code.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
langCdstringRequired

Language Code

Example: ko
Responses
200

Special Exhibition Detail Image Inquiry Successful

*/*

Display Image Information

langCdstringOptional

Language Code

Example: ko
dispShopGbCdstringOptional

Display Store Type Code (DP009)

Example: 01
shopCtgNostringOptional

Store Category No.

Example: 132
imgTypCdstringOptional

Image Type Code (DP013)

Example: 01
imgSnstringOptional

Image Serial No.

Example: 133
bnrImgPathNmstringOptional

Banner Image Path Name

Example: /배너이미지경로
bnrImgFileNmstringOptional

Banner Image File Name

Example: 배너이미지파일명
bnrImgAltContstringOptional

Banner Image Alt Text

Example: 배너이미지 대체텍스트
linkUrlAddrstringOptional

Linked URL

Example: /연결URL주소
dispMediaCdstringOptional

Display Media Code (DP018)

Example: 99
dispStatstringOptional

Special Exhibition Status

Example: 10
contPathNmstringOptional

Thumbnail Image Path

Example: /썸네일이미지경로
contGbCdstringOptional

Content Type Code (SN007)

copyShopCtgNostringOptional

Store Category No. (Copy)

fileIdxinteger · int32Optional

Image Upload Sequence No.

get/v1/display/marketingDisplayMgmt/getPrDispImgInfoDetail
GET /api/bo/v1/display/marketingDisplayMgmt/getPrDispImgInfoDetail?mkdpNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "ko",
  "dispShopGbCd": "01",
  "shopCtgNo": 132,
  "imgTypCd": "01",
  "imgSn": 133,
  "bnrImgPathNm": "/배너이미지경로",
  "bnrImgFileNm": "배너이미지파일명",
  "bnrImgAltCont": "배너이미지 대체텍스트",
  "linkUrlAddr": "/연결URL주소",
  "dispMediaCd": 99,
  "dispStat": 10,
  "contPathNm": "/썸네일이미지경로",
  "contGbCd": "text",
  "copyShopCtgNo": "text",
  "fileIdx": 1
}

Special Exhibition Popup Divider Tab - Retrieve Divider Information

get

Function Description

  • API for retrieving special exhibition divider detail information.


Detailed Description

  • Retrieves special exhibition divider information by receiving the special exhibition number and language code.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
langCdstringRequired

Language Code

Example: ko
Responses
200

Special Exhibition Divider Information Inquiry Successful

*/*

Promotion Divider Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
dispMediaCdstringOptional

Display Media Code (DP018)

Example: 99
divobjGbCdstringOptional

Divider Type Code (DP024)

Example: 10
divobjNmstringOptional

Delimiter Name

Example: 구분자명
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
tmplNostringOptional

Template No.

Example: 10020
cpnNostringOptional

Coupon No.

Example: C1001442
textDivobjNmstringOptional

Text Delimiter Name

Example: 텍스트구분자명
bnrImgPathNmstringOptional

Banner Image Path Name

Example: /이미지경로명
bnrImgFileNmstringOptional

Banner Image File Name

Example: 이미지파일명
cpnBnrImgPathNmstringOptional

Coupon Banner Image Path

Example: /쿠폰이미지경로명
bnrImgAltContstringOptional

Coupon Banner Image Alt Text

Example: 쿠폰이미지대체텍스트
cpnBnrImgFileNmstringOptional

Coupon Banner Image File Name

Example: 쿠폰이미지파일명
htmlFileContstringOptional

HTML File Content

Example: HTML내용
stateFormstringOptional

Divider Status

Example: I
get/v1/display/marketingDisplayMgmt/getMarketingDisplayMgmtDivobj
GET /api/bo/v1/display/marketingDisplayMgmt/getMarketingDisplayMgmtDivobj?mkdpNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "dispMediaCd": 99,
  "divobjGbCd": 10,
  "divobjNm": "구분자명",
  "dispYn": "Y",
  "dispSeq": 1,
  "tmplNo": 10020,
  "cpnNo": "C1001442",
  "textDivobjNm": "텍스트구분자명",
  "bnrImgPathNm": "/이미지경로명",
  "bnrImgFileNm": "이미지파일명",
  "cpnBnrImgPathNm": "/쿠폰이미지경로명",
  "bnrImgAltCont": "쿠폰이미지대체텍스트",
  "cpnBnrImgFileNm": "쿠폰이미지파일명",
  "htmlFileCont": "HTML내용",
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "stateForm": "I"
}

Special Exhibition Register/Modify Popup Product Info Tab - Retrieve Special Exhibition Divider Grid List

get

Function Description

  • API for retrieving the Product Info tab - special exhibition divider grid list.


Detailed Description

  • Retrieves the special exhibition divider list by receiving the special exhibition number.

  • The special exhibition divider list is displayed in ascending order of display order and divider number.


Revision History

Release v1.02_231023 : Sprint 2 PO1 defect/improvement

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
Responses
200

Special Exhibition Divider Information List Inquiry Successful

*/*

Promotion Divider Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
dispMediaCdstringOptional

Display Media Code (DP018)

Example: 99
divobjGbCdstringOptional

Divider Type Code (DP024)

Example: 10
divobjNmstringOptional

Delimiter Name

Example: 구분자명
dispYnstringOptional

Display Status

Example: Y
dispSeqinteger · int32Optional

Display Order

Example: 1
tmplNostringOptional

Template No.

Example: 10020
cpnNostringOptional

Coupon No.

Example: C1001442
textDivobjNmstringOptional

Text Delimiter Name

Example: 텍스트구분자명
bnrImgPathNmstringOptional

Banner Image Path Name

Example: /이미지경로명
bnrImgFileNmstringOptional

Banner Image File Name

Example: 이미지파일명
cpnBnrImgPathNmstringOptional

Coupon Banner Image Path

Example: /쿠폰이미지경로명
bnrImgAltContstringOptional

Coupon Banner Image Alt Text

Example: 쿠폰이미지대체텍스트
cpnBnrImgFileNmstringOptional

Coupon Banner Image File Name

Example: 쿠폰이미지파일명
htmlFileContstringOptional

HTML File Content

Example: HTML내용
stateFormstringOptional

Divider Status

Example: I
get/v1/display/marketingDisplayMgmt/getMarketingDisplayDivobjGridList
GET /api/bo/v1/display/marketingDisplayMgmt/getMarketingDisplayDivobjGridList?mkdpNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "dispMediaCd": 99,
  "divobjGbCd": 10,
  "divobjNm": "구분자명",
  "dispYn": "Y",
  "dispSeq": 1,
  "tmplNo": 10020,
  "cpnNo": "C1001442",
  "textDivobjNm": "텍스트구분자명",
  "bnrImgPathNm": "/이미지경로명",
  "bnrImgFileNm": "이미지파일명",
  "cpnBnrImgPathNm": "/쿠폰이미지경로명",
  "bnrImgAltCont": "쿠폰이미지대체텍스트",
  "cpnBnrImgFileNm": "쿠폰이미지파일명",
  "htmlFileCont": "HTML내용",
  "imgList": [
    {
      "langCd": "ko",
      "dispShopGbCd": "01",
      "shopCtgNo": 132,
      "imgTypCd": "01",
      "imgSn": 133,
      "bnrImgPathNm": "/배너이미지경로",
      "bnrImgFileNm": "배너이미지파일명",
      "bnrImgAltCont": "배너이미지 대체텍스트",
      "linkUrlAddr": "/연결URL주소",
      "dispMediaCd": 99,
      "dispStat": 10,
      "contPathNm": "/썸네일이미지경로",
      "contGbCd": "text",
      "copyShopCtgNo": "text",
      "fileIdx": 1
    }
  ],
  "stateForm": "I"
}

Special Exhibition Register/Modify Popup Product Info Tab - Retrieve Special Exhibition Product Information Detail

get

Function Description

  • API for retrieving the Product Info tab - product detail information by special exhibition divider.


Detailed Description

  • Retrieves the product detail information by divider by receiving the special exhibition number and divider number.

  • If duplicate products exist, the duplicate product is excluded, and the display order of the products is set starting from 1.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
divobjNostringRequired

Classifier No.

Example: 1
goodsArrayarrayRequired

Product Number Array

Responses
200

Special Exhibition Divider-Based Product List Inquiry and Setup Successful

*/*

Promotion Product Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002131
goodsNmstringOptional

Product Name

Example: 상품명
dispSeqinteger · int32Optional

Display Order

Example: 1
saleStatCdstringOptional

Sales Status Code

Example: 10
saleStatCdNmstringOptional

Sales Status Code Name

Example: 판매중
entrNostringOptional

Vendor No.

Example: 1000002
entrNmstringOptional

Vendor Name

Example: 플래티어 협력사
norPrcnumberOptional

Regular Price

Example: 25000
salePrcnumberOptional

Discounted Price

Example: 20000
errorMessagestringOptional

Error Message

Example: 해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.
validStatstringOptional

Error Status

timeDealYnstringOptional

Time Deal Application Status

tmdlHistStrDtmstring · date-timeOptional

Time Deal Start Date/Time

tmdlHistEndDtmstring · date-timeOptional

Time Deal End Date/Time

tmdlSalePrcnumberOptional

Time Deal Selling Price

get/v1/display/marketingDisplayMgmt/getGoodsListDetail
GET /api/bo/v1/display/marketingDisplayMgmt/getGoodsListDetail?mkdpNo=text&divobjNo=text&goodsArray=undefined HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "goodsNo": 10002131,
  "goodsNm": "상품명",
  "dispSeq": 1,
  "saleStatCd": 10,
  "saleStatCdNm": "판매중",
  "entrNo": 1000002,
  "entrNm": "플래티어 협력사",
  "norPrc": 25000,
  "salePrc": 20000,
  "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
  "validStat": "text",
  "timeDealYn": "text",
  "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
  "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
  "tmdlSalePrc": 1
}

Special Exhibition Register/Modify Popup Product Info Tab - Retrieve Special Exhibition Divider-Based Product Grid List

get

Function Description

  • API for retrieving the Product Info tab - product grid list by special exhibition divider.


Detailed Description

  • Retrieves the product list by divider by receiving the special exhibition number and divider number.

  • The product list by special exhibition divider is displayed in ascending order of display order and ascending order of product registration date.


Revision History

Release v1.02_231023 : Sprint 2 PO1 defect/improvement Release v1.06_250609 : Retrieves time deal related information when adding a time deal product

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
mkdpNostringRequired

Special Exhibition No.

Example: 14862
divobjNostringRequired

Classifier No.

Example: 1
Responses
200

Special Exhibition Divider-Based Product List Inquiry Successful

*/*

Promotion Product Information

langCdstringOptional

Language Code

Example: ko
mkdpNostringOptional

Special Exhibition No.

Example: 14862
divobjNostringOptional

Classifier No.

Example: 1
goodsNostringOptional

Product No.

Example: 10002131
goodsNmstringOptional

Product Name

Example: 상품명
dispSeqinteger · int32Optional

Display Order

Example: 1
saleStatCdstringOptional

Sales Status Code

Example: 10
saleStatCdNmstringOptional

Sales Status Code Name

Example: 판매중
entrNostringOptional

Vendor No.

Example: 1000002
entrNmstringOptional

Vendor Name

Example: 플래티어 협력사
norPrcnumberOptional

Regular Price

Example: 25000
salePrcnumberOptional

Discounted Price

Example: 20000
errorMessagestringOptional

Error Message

Example: 해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.
validStatstringOptional

Error Status

timeDealYnstringOptional

Time Deal Application Status

tmdlHistStrDtmstring · date-timeOptional

Time Deal Start Date/Time

tmdlHistEndDtmstring · date-timeOptional

Time Deal End Date/Time

tmdlSalePrcnumberOptional

Time Deal Selling Price

get/v1/display/marketingDisplayMgmt/getDivobjGoodsGridList
GET /api/bo/v1/display/marketingDisplayMgmt/getDivobjGoodsGridList?mkdpNo=text&divobjNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "ko",
  "mkdpNo": 14862,
  "divobjNo": 1,
  "goodsNo": 10002131,
  "goodsNm": "상품명",
  "dispSeq": 1,
  "saleStatCd": 10,
  "saleStatCdNm": "판매중",
  "entrNo": 1000002,
  "entrNm": "플래티어 협력사",
  "norPrc": 25000,
  "salePrc": 20000,
  "errorMessage": "해당 상품번호는 존재하지 않는 상품번호이거나 묶음 상품입니다.",
  "validStat": "text",
  "timeDealYn": "text",
  "tmdlHistStrDtm": "2026-01-01T00:00:00.000Z",
  "tmdlHistEndDtm": "2026-01-01T00:00:00.000Z",
  "tmdlSalePrc": 1
}

Last updated