Display Store
Path parameters
shopNostringRequiredExample:
Store No.
1Query parameters
dispMediaCdstringOptionalExample:
Display Media Code (DP018)
20Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Store information retrieved successfully
application/json
Store Model DTO
3000
Failed to retrieve store information
application/json
3100
Store Template Information Retrieval Failed
application/json
get/v1/shop/{shopNo}
GET /api/display/v1/shop/{shopNo} HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
{
"brandInfo": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
},
"shopInfo": {
"shopNo": "text",
"shopTypCd": "text",
"dpmlNo": "text",
"dispShopNm": "text",
"dispSeq": "text",
"dispYn": "text",
"prtTypCd": "text",
"linkUrlAddr": "text",
"linkDispNo": "text",
"movFrmeCd": "text",
"brandNo": "text",
"dispCtgNo": "text",
"shopDescCont": "text"
},
"categoryInfo": {
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": [
{
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": [
{
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": "[Circular Reference]"
}
]
}
]
},
"template": {
"tmplNo": "text",
"shopTmplNo": "text",
"tmplNm": "text",
"tmplTypCd": "text",
"tmplPathNm": "text",
"tmplFileNm": "text",
"useYn": "text"
},
"conrList": [
{
"tmplConrNo": "text",
"conrNo": "text",
"conrNm": "text",
"useYn": "text",
"conrTypCd": "text",
"vueCmptId": "text",
"mappTtl": "text",
"conrDesc": "text",
"setCnt": 1,
"setList": [
{
"dispSetSeq": "text",
"dispShopNo": "text",
"tmplConrNo": "text",
"setNm": "text",
"dispStrDtm": "2026-01-01T00:00:00.000Z",
"dispEndDtm": "2026-01-01T00:00:00.000Z",
"dispSeq": 1,
"dispYn": "text",
"setDesc": "text",
"conrNo": "text",
"swipeTyp": "text",
"swiperTypId": "text",
"contentInfoList": [
{
"dispSetSeq": "text",
"conrTgtCd": "text",
"conrTgtCnt": 1,
"productList": [
{
"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"
}
],
"brandList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"productReviewList": [
{
"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",
"revScrVal": 1,
"revNo": "text",
"revCont": "text",
"revGbCd": "text",
"revTypCd": "text",
"loginId": "text",
"revWrtDtm": "2026-01-01T00:00:00.000Z",
"revContList": [
{
"contSn": "text",
"contFilePathNm": "text",
"contFileNm": "text",
"revGbCd": "text"
}
]
}
],
"planShopList": [
{
"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": "이미지 대체텍스트"
}
]
}
],
"htmlList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"imageList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"textList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"videoList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
]
}
]
}
]
}
]
}Function Description
This API retrieves category store information.
Detailed Description
Retrieves detailed category store information using the category number and display media code.
If there is no store template available for display in the category store, the default category template information is returned.
Code Summary
Display Status: Y,N
Revision History
Release v1.05_231204: Refactored corner content retrieval query
Path parameters
dispCtgNostringRequiredExample:
Category No.
10000001Query parameters
dispMediaCdstringOptionalExample:
Display Media Code (DP018)
20Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Category store information retrieved successfully
application/json
Store Model DTO
3000
Failed to retrieve category store information
application/json
3100
Store Template Information Retrieval Failed
application/json
get/v1/shop/category/{dispCtgNo}
GET /api/display/v1/shop/category/{dispCtgNo} HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
{
"brandInfo": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
},
"shopInfo": {
"shopNo": "text",
"shopTypCd": "text",
"dpmlNo": "text",
"dispShopNm": "text",
"dispSeq": "text",
"dispYn": "text",
"prtTypCd": "text",
"linkUrlAddr": "text",
"linkDispNo": "text",
"movFrmeCd": "text",
"brandNo": "text",
"dispCtgNo": "text",
"shopDescCont": "text"
},
"categoryInfo": {
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": [
{
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": [
{
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": "[Circular Reference]"
}
]
}
]
},
"template": {
"tmplNo": "text",
"shopTmplNo": "text",
"tmplNm": "text",
"tmplTypCd": "text",
"tmplPathNm": "text",
"tmplFileNm": "text",
"useYn": "text"
},
"conrList": [
{
"tmplConrNo": "text",
"conrNo": "text",
"conrNm": "text",
"useYn": "text",
"conrTypCd": "text",
"vueCmptId": "text",
"mappTtl": "text",
"conrDesc": "text",
"setCnt": 1,
"setList": [
{
"dispSetSeq": "text",
"dispShopNo": "text",
"tmplConrNo": "text",
"setNm": "text",
"dispStrDtm": "2026-01-01T00:00:00.000Z",
"dispEndDtm": "2026-01-01T00:00:00.000Z",
"dispSeq": 1,
"dispYn": "text",
"setDesc": "text",
"conrNo": "text",
"swipeTyp": "text",
"swiperTypId": "text",
"contentInfoList": [
{
"dispSetSeq": "text",
"conrTgtCd": "text",
"conrTgtCnt": 1,
"productList": [
{
"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"
}
],
"brandList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"productReviewList": [
{
"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",
"revScrVal": 1,
"revNo": "text",
"revCont": "text",
"revGbCd": "text",
"revTypCd": "text",
"loginId": "text",
"revWrtDtm": "2026-01-01T00:00:00.000Z",
"revContList": [
{
"contSn": "text",
"contFilePathNm": "text",
"contFileNm": "text",
"revGbCd": "text"
}
]
}
],
"planShopList": [
{
"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": "이미지 대체텍스트"
}
]
}
],
"htmlList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"imageList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"textList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"videoList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
]
}
]
}
]
}
]
}Header parameters
AuthorizationanyOptional
Access Token
Responses
200
OK
application/json
Store Information DTO
shopNostringOptional
Store No.
shopTypCdstringOptional
Store Type Code (DP003)
dpmlNostringOptional
Display Mall No.
dispShopNmstringOptional
Display Store Name
dispSeqstringOptional
Display Order
dispYnstringOptional
Display Status
prtTypCdstringOptional
Output Type Code (DP002)
linkUrlAddrstringOptional
Link URL
linkDispNostringOptional
Linked Display No.
movFrmeCdstringOptional
Move Frame Code
brandNostringOptional
Brand No.
dispCtgNostringOptional
Category No.
shopDescContstringOptional
Store Description
get/v1/shop/brand
GET /api/display/v1/shop/brand HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
200
OK
[
{
"shopNo": "text",
"shopTypCd": "text",
"dpmlNo": "text",
"dispShopNm": "text",
"dispSeq": "text",
"dispYn": "text",
"prtTypCd": "text",
"linkUrlAddr": "text",
"linkDispNo": "text",
"movFrmeCd": "text",
"brandNo": "text",
"dispCtgNo": "text",
"shopDescCont": "text"
}
]Path parameters
brandNostringRequiredExample:
Brand No.
100001Query parameters
dispMediaCdstringOptionalExample:
Display Media Code (DP018)
20Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Brand store information retrieved successfully
application/json
Store Model DTO
3000
Failed to retrieve brand store information
application/json
3100
Store Template Information Retrieval Failed
application/json
get/v1/shop/brand/{brandNo}
GET /api/display/v1/shop/brand/{brandNo} HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
{
"brandInfo": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
},
"shopInfo": {
"shopNo": "text",
"shopTypCd": "text",
"dpmlNo": "text",
"dispShopNm": "text",
"dispSeq": "text",
"dispYn": "text",
"prtTypCd": "text",
"linkUrlAddr": "text",
"linkDispNo": "text",
"movFrmeCd": "text",
"brandNo": "text",
"dispCtgNo": "text",
"shopDescCont": "text"
},
"categoryInfo": {
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": [
{
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": [
{
"dispCtgNo": "text",
"dispCtgNm": "text",
"dispSeq": 1,
"uprDispCtgNo": "text",
"lrgCtgNo": "text",
"midCtgNo": "text",
"smlCtgNo": "text",
"thnCtgNo": "text",
"leafYn": "text",
"depth": "text",
"subCategoryList": "[Circular Reference]"
}
]
}
]
},
"template": {
"tmplNo": "text",
"shopTmplNo": "text",
"tmplNm": "text",
"tmplTypCd": "text",
"tmplPathNm": "text",
"tmplFileNm": "text",
"useYn": "text"
},
"conrList": [
{
"tmplConrNo": "text",
"conrNo": "text",
"conrNm": "text",
"useYn": "text",
"conrTypCd": "text",
"vueCmptId": "text",
"mappTtl": "text",
"conrDesc": "text",
"setCnt": 1,
"setList": [
{
"dispSetSeq": "text",
"dispShopNo": "text",
"tmplConrNo": "text",
"setNm": "text",
"dispStrDtm": "2026-01-01T00:00:00.000Z",
"dispEndDtm": "2026-01-01T00:00:00.000Z",
"dispSeq": 1,
"dispYn": "text",
"setDesc": "text",
"conrNo": "text",
"swipeTyp": "text",
"swiperTypId": "text",
"contentInfoList": [
{
"dispSetSeq": "text",
"conrTgtCd": "text",
"conrTgtCnt": 1,
"productList": [
{
"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"
}
],
"brandList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"productReviewList": [
{
"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",
"revScrVal": 1,
"revNo": "text",
"revCont": "text",
"revGbCd": "text",
"revTypCd": "text",
"loginId": "text",
"revWrtDtm": "2026-01-01T00:00:00.000Z",
"revContList": [
{
"contSn": "text",
"contFilePathNm": "text",
"contFileNm": "text",
"revGbCd": "text"
}
]
}
],
"planShopList": [
{
"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": "이미지 대체텍스트"
}
]
}
],
"htmlList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"imageList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"textList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"videoList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
]
}
]
}
]
}
]
}Path parameters
adutIdstringRequiredExample:
Slot ID
10000001Query parameters
dispMediaCdstringOptionalExample:
Display Media Code (DP018)
20Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Slot information retrieved successfully
application/json
Corner DTO
tmplConrNostringOptional
Template Corner No.
conrNostringOptional
Corner No.
conrNmstringOptional
Corner Name
useYnstringOptional
Usage Status
conrTypCdstringOptional
Corner Type Code (DP010)
vueCmptIdstringOptional
Component ID
mappTtlstringOptional
Mapping Title
conrDescstringOptional
Corner Description
setCntinteger · int32Optional
Set Count
3000
Failed to retrieve slot information
application/json
3100
Store Template Information Retrieval Failed
application/json
get/v1/shop/account/{adutId}
GET /api/display/v1/shop/account/{adutId} HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
{
"tmplConrNo": "text",
"conrNo": "text",
"conrNm": "text",
"useYn": "text",
"conrTypCd": "text",
"vueCmptId": "text",
"mappTtl": "text",
"conrDesc": "text",
"setCnt": 1,
"setList": [
{
"dispSetSeq": "text",
"dispShopNo": "text",
"tmplConrNo": "text",
"setNm": "text",
"dispStrDtm": "2026-01-01T00:00:00.000Z",
"dispEndDtm": "2026-01-01T00:00:00.000Z",
"dispSeq": 1,
"dispYn": "text",
"setDesc": "text",
"conrNo": "text",
"swipeTyp": "text",
"swiperTypId": "text",
"contentInfoList": [
{
"dispSetSeq": "text",
"conrTgtCd": "text",
"conrTgtCnt": 1,
"productList": [
{
"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"
}
],
"brandList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"productReviewList": [
{
"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",
"revScrVal": 1,
"revNo": "text",
"revCont": "text",
"revGbCd": "text",
"revTypCd": "text",
"loginId": "text",
"revWrtDtm": "2026-01-01T00:00:00.000Z",
"revContList": [
{
"contSn": "text",
"contFilePathNm": "text",
"contFileNm": "text",
"revGbCd": "text"
}
]
}
],
"planShopList": [
{
"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": "이미지 대체텍스트"
}
]
}
],
"htmlList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"imageList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"textList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
],
"videoList": [
{
"conrContNo": "text",
"linkUrlAddr": "text",
"movFrmeCd": "text",
"contTitleNm": "text",
"contPathNm": "text",
"contFileNm": "text",
"pcContPathNm": "text",
"pcContFileNm": "text",
"altCont": "text",
"htmlFileCont": "text",
"ttlClorText": "text",
"wrdClorText": "text",
"brand": {
"brandNo": "text",
"useYn": "text",
"brandImgPathNm": "text",
"brandImgFileNm": "text",
"brandNm": "text",
"brandDescCmt": "text",
"schKwdNm": "text"
}
}
]
}
]
}
]
}Function Description
This API retrieves the list of ranked products.
Category popular products (ranking data) are generated via batch processing.
Ranking is calculated based on order data from the most recent 14 days.
Ranking data validation extracts only products that are on sale or out of stock.
Products are retrieved according to the aggregation conditions.
Detailed Description
Retrieves the product list aggregated by ranking.
Revision History
Release v2.00_240401: Newly created
Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Ranked product list retrieved successfully
*/*
titlestringOptional
Title
subTitlestringOptional
Subtitle
dataanyOptional
Product List
get/v1/dummy/rank/goods
GET /api/display/v1/dummy/rank/goods HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
200
Ranked product list retrieved successfully
{
"title": "text",
"subTitle": "text",
"data": null
}Function Description
This API retrieves the categories of ranked products.
Category popular products (ranking data) are generated via batch processing.
Ranking is calculated based on order data from the most recent 14 days.
Ranking data validation extracts only products that are on sale or out of stock.
Retrieves the categories of products that exist according to the aggregation conditions.
Detailed Description
Retrieves the categories of products present in the ranking-aggregated data.
Revision History
Release v2.00_240401: Newly created
Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Product ranking category retrieved successfully
*/*
titlestringOptional
Title
subTitlestringOptional
Subtitle
dataanyOptional
Product List
get/v1/dummy/rank/category
GET /api/display/v1/dummy/rank/category HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
200
Product ranking category retrieved successfully
{
"title": "text",
"subTitle": "text",
"data": null
}Function Description
This API retrieves category popular products.
Category popular products (ranking data) are generated via batch processing.
Ranking is calculated based on order data from the most recent 14 days.
Ranking data validation extracts only products that are on sale or out of stock.
Managed purely through business logic as dummy data, not via BO management.
Detailed Description
Retrieves category products sorted by sales ranking.
Header parameters
AuthorizationanyOptional
Access Token
Responses
200
Category best products retrieved successfully
*/*
titlestringOptional
Title
subTitlestringOptional
Subtitle
dataanyOptional
Product List
get/v1/dummy/categoryBestGoods
GET /api/display/v1/dummy/categoryBestGoods HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*
200
Category best products retrieved successfully
{
"title": "text",
"subTitle": "text",
"data": null
}Last updated