> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/store-front-api-reference/display-api/site-display-mall.md).
# Site Display Mall
## Retrieve Site
> \## Function Description\
> \* This API retrieves a single site information record.\
> \---\
> \## Detailed Description\
> \* Retrieves the site information using the site number from the cookie value. (default: 1)
```json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/site":{"get":{"tags":["Site Display Mall"],"summary":"Retrieve Site","description":"## Function Description\n* This API retrieves a single site information record.\n---\n## Detailed Description\n* Retrieves the site information using the site number from the cookie value. (default: 1)\n","operationId":"getSiteInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Retrieve Site Information Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SiteInfo"}}}},"400":{"description":"Retrieve Site Information Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"SiteInfo":{"type":"object","description":"Site Information DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site Name"},"trdStrtDt":{"type":"string","description":"Transaction Start Date"},"trdEndDt":{"type":"string","description":"Transaction End Date"},"siteDom":{"type":"string","description":"Site Domain"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
```
## Retrieve Site Popup List
> \## Function Description\
> \* This API retrieves the list of popup information for the site.\
> \---\
> \## Detailed Description\
> \* If the channel detail number is not entered, the default value 1000001 is set.\
> \* Only popups within the popup period are displayed, shown in order of priority.\
> \* If priorities are equal, they are displayed in order of system registration, then system modification.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/site/popupList":{"get":{"tags":["Site Display Mall"],"summary":"Retrieve Site Popup List","description":"## Function Description\n* This API retrieves the list of popup information for the site.\n---\n## Detailed Description\n* If the channel detail number is not entered, the default value 1000001 is set.\n* Only popups within the popup period are displayed, shown in order of priority.\n * If priorities are equal, they are displayed in order of system registration, then system modification.\n","operationId":"getSitePopupList","parameters":[{"name":"dispMediaCd","in":"query","description":"Display Media Code (DP015)","required":true,"schema":{"type":"string","description":"string"}},{"name":"popupTgtScrnCd","in":"query","description":"Popup Target Screen Code (DP016)","required":true,"schema":{"type":"string","description":"string"}},{"name":"dispMediaDtlCd","in":"query","description":"Display Media Code","schema":{"type":"string","description":"string"}},{"name":"chlDtlNo","in":"query","description":"Channel Detail No.","required":true,"schema":{"type":"string","description":"string"}},{"name":"prtTypCd","in":"query","description":"Popup Output Type Code (DP017)","schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Popup list information retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SitePopupInfo"}}}},"400":{"description":"Failed to retrieve popup list information","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"SitePopupInfo":{"type":"object","description":"Site Popup Information DTO","properties":{"popupNo":{"type":"string","description":"Popup No."},"popupNm":{"type":"string","description":"Popup Name"},"popupTypCd":{"type":"string","description":"Popup Type Code (DP014 01: Information Popup, 02: App Link Popup, 03: Coupon Download Popup)"},"prtTypCd":{"type":"string","description":"Popup Output Type Code (DP017 01: Full Screen, 02: Partial Screen)"},"popupContGbCd":{"type":"string","description":"Popup Content Type Code (DP029 01: Image Type, 02: HTML)"},"popupLink":{"type":"string","description":"Popup Link"},"popupImgPathNm":{"type":"string","description":"Popup Image Path (Required when display media is MOBILE)"},"popupCont":{"type":"string","description":"Popup Content (Required when popup content type code is HTML)"},"popupSzWdt":{"type":"string","description":"Popup Size Width (Required when display media is PC)"},"popupSzHigh":{"type":"string","description":"Popup Size Height (Required when display media is PC)"},"popupLocLeft":{"type":"string","description":"Popup Position LEFT (Required when display media is PC)"},"popupLocTop":{"type":"string","description":"Popup Position (Required when display media is PC)"},"chlDtlNo":{"type":"string","description":"Channel Detail No."},"chlLinkInfo":{"type":"string","description":"Channel Link Information (Used as the app tracking code when popup type code is 02, or as the coupon number when 03)"},"prioRnk":{"type":"string","description":"Priority"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
```
## Retrieve Site Terms List
> \## Function Description\
> \* This API retrieves the terms information for the site and the list of past terms application dates.\
> \---\
> \## Detailed Description\
> \* Retrieves the terms information and the list of past terms application dates as of the current date.\
> \* If two or more terms apply as of the current date, only the one with the most recent application start date is retrieved.\
> \* The list of past terms application dates is displayed in most-recent-first order.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/site/policyList":{"get":{"tags":["Site Display Mall"],"summary":"Retrieve Site Terms List","description":"## Function Description\n* This API retrieves the terms information for the site and the list of past terms application dates.\n---\n## Detailed Description\n* Retrieves the terms information and the list of past terms application dates as of the current date.\n * If two or more terms apply as of the current date, only the one with the most recent application start date is retrieved.\n * The list of past terms application dates is displayed in most-recent-first order.\n","operationId":"getPolicyInfo","parameters":[{"name":"siteNo","in":"query","description":"Site No. (x2bee.com : 1)","required":true,"schema":{"type":"string","description":"string"}},{"name":"agmtPolcCd","in":"query","description":"Terms Policy Code (CH005)","required":true,"schema":{"type":"string","description":"string"}},{"name":"aplyStrDt","in":"query","description":"Application Start Date","required":true,"schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Terms information retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TermsPolicy"}}}},"400":{"description":"Failed to retrieve terms information","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"TermsPolicy":{"type":"object","description":"Terms Information DTO","properties":{"cmAgmtSeq":{"type":"string","description":"Common Terms Sequence No."},"siteNo":{"type":"string","description":"Site No."},"cmAgmtPolcGbCd":{"type":"string","description":"Common Terms Type Code (CH010)"},"agmtPolcCd":{"type":"string","description":"Terms Policy Code (CH005)"},"agmtPolcNm":{"type":"string","description":"Terms & Policy Name"},"aplyStrDt":{"type":"string","description":"Application Start Date"},"aplyEndDt":{"type":"string","description":"Application End Date"},"title":{"type":"string","description":"Title"},"wrdCont":{"type":"string","description":"Text Content"},"langCd":{"type":"string","description":"Language Code (CM009)"},"applyDateList":{"type":"array","description":"Application Date List","items":{"$ref":"#/components/schemas/TermsPolicyDate"}}}},"TermsPolicyDate":{"type":"object","properties":{"cmAgmtSeq":{"type":"string","description":"Common Terms Sequence No."},"agmtPolcCd":{"type":"string","description":"Terms Policy Code"},"aplyStrDt":{"type":"string","description":"Application Effective Date"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
```
## Retrieve Display Mall List
> \## Function Description\
> \* This API retrieves the list of malls belonging to the site.\
> \---\
> \## Detailed Description\
> \* Retrieves the mall information list using the site number from the cookie value. (default: 1)\
> \* Mall information is displayed in display order.\
> \---\
> \### Code Summary\
> \* \`\`\` Display Status \`\`\` : Y,N
````json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/mall":{"get":{"tags":["Site Display Mall"],"summary":"Retrieve Display Mall List","description":"## Function Description\n* This API retrieves the list of malls belonging to the site.\n---\n## Detailed Description\n* Retrieves the mall information list using the site number from the cookie value. (default: 1)\n* Mall information is displayed in display order.\n---\n### Code Summary\n* ``` Display Status ``` : Y,N\n","operationId":"getMallInfo","parameters":[{"name":"siteNo","in":"query","description":"Site No. (x2bee.com : 1)","required":true},{"name":"dispYn","in":"query","description":"Display Status (Displayed: Y, Not Displayed: N)","required":true},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Mall Information Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MallBase"}}}},"400":{"description":"Mall Information Retrieval Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"MallBase":{"type":"object","description":"Mall Information DTO","properties":{"dpmlNo":{"type":"string","description":"Mall No."},"dpmlNm":{"type":"string","description":"Mall Name"},"linkUrlAddr":{"type":"string","description":"Link URL"},"movFrmeCd":{"type":"string","description":"Navigation Frame Code (DP007)"},"dispSeq":{"type":"string","description":"Display Order"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
````
## Retrieve Single Display Mall
> \## Function Description\
> \* This API retrieves a single mall information record.\
> \---\
> \## Detailed Description\
> \* Retrieves the mall information using the mall number.\
> \---\
> \### Code Summary\
> \* \`\`\` Mall No. \`\`\` : e.g., 10001
````json
{"openapi":"3.1.0","info":{"title":"X2BEE Display API","version":"v1"},"servers":[{"url":"https://api-display.x2bee.com/api/display/","description":"prd"}],"paths":{"/v1/mall/defaultShop":{"get":{"tags":["Site Display Mall"],"summary":"Retrieve Single Display Mall","description":"## Function Description\n* This API retrieves a single mall information record.\n---\n## Detailed Description\n* Retrieves the mall information using the mall number.\n---\n### Code Summary\n* ``` Mall No. ``` : e.g., 10001\n","operationId":"getDefaultShopInfo","parameters":[{"name":"mallNo","in":"query","description":"Mall No.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Mall Information Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MallBase"}}}},"400":{"description":"Mall Information Retrieval Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"MallBase":{"type":"object","description":"Mall Information DTO","properties":{"dpmlNo":{"type":"string","description":"Mall No."},"dpmlNm":{"type":"string","description":"Mall Name"},"linkUrlAddr":{"type":"string","description":"Link URL"},"movFrmeCd":{"type":"string","description":"Navigation Frame Code (DP007)"},"dispSeq":{"type":"string","description":"Display Order"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}}}
````