> 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/back-office-api-reference/display-bo-api/display-template-management.md).
# Display Template Management
## Display Template Linked Store/Special Exhibition Existence Status
> \## Function Description\
> \* API for retrieving whether a store/special exhibition linked to a display template exists.\
> \---\
> \## Detailed Description\
> \* Retrieves whether a store/special exhibition linked to the display template exists, using the template number and template type code.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrTmplSearch":{"type":"object","description":"Template Basic Search","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplFileNm":{"type":"string","description":"Template File Name"},"tmplTypCd":{"type":"string","description":"Template Type Code (DP004)"},"useYn":{"type":"string","description":"Usage Status"},"offset":{"type":"integer","format":"int32"}}},"ResponseBoolean":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"boolean","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/display/displayTemplateMgmt/tmplMappCheck":{"post":{"tags":["Display Template Management"],"summary":"Display Template Linked Store/Special Exhibition Existence Status","description":"## Function Description\n* API for retrieving whether a store/special exhibition linked to a display template exists.\n---\n## Detailed Description\n* Retrieves whether a store/special exhibition linked to the display template exists, using the template number and template type code.\n","operationId":"getDisplayTemplateMappCheck","parameters":[{"name":"tmplNo","in":"query","description":"Template No.","required":true,"schema":{"type":"string"}},{"name":"tmplTypCd","in":"query","description":"Template Type Code (DP004)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrTmplSearch"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseBoolean"}}}}}}}}}
```
## POST /v2/display/displayTemplateMgmt/saveTemplate
>
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DisplayTemplateDto":{"type":"object","description":"Template Basic","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplTypCd":{"type":"string","description":"Template Type Code (DP004)"},"tmplFileNm":{"type":"string","description":"Template File Name"},"useYn":{"type":"string","description":"Usage Status"},"tmplMappCount":{"type":"integer","format":"int64","description":"Template Mapping Count"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/display/displayTemplateMgmt/saveTemplate":{"post":{"tags":["Display Template Management"],"operationId":"saveTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayTemplateDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}}}}}}}
```
## Retrieve Display Template List
> \## Function Description\
> \* API for retrieving the display template list.\
> \---\
> \## Detailed Description\
> \* Retrieves the template list corresponding to Template No., Template Name, Template Type Code, Usage Status, and Template File Name.\
> \---\
> \## Code Reference\
> \* \`\`\` Usage Status \`\`\` : Y,N
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseRealGridListResponseDisplayTemplateDto":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseDisplayTemplateDto","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseDisplayTemplateDto":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DisplayTemplateDto"}}}},"DisplayTemplateDto":{"type":"object","description":"Template Basic","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplTypCd":{"type":"string","description":"Template Type Code (DP004)"},"tmplFileNm":{"type":"string","description":"Template File Name"},"useYn":{"type":"string","description":"Usage Status"},"tmplMappCount":{"type":"integer","format":"int64","description":"Template Mapping Count"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/display/displayTemplateMgmt":{"get":{"tags":["Display Template Management"],"summary":"Retrieve Display Template List","description":"## Function Description\n* API for retrieving the display template list.\n---\n## Detailed Description\n* Retrieves the template list corresponding to Template No., Template Name, Template Type Code, Usage Status, and Template File Name.\n---\n## Code Reference\n* ``` Usage Status ``` : Y,N\n","operationId":"getDisplayTemplateList","parameters":[{"name":"tmplNo","in":"query","description":"Template No.","schema":{"type":"string"}},{"name":"tmplNm","in":"query","description":"Template Name","schema":{"type":"string"}},{"name":"tmplTypCd","in":"query","description":"Template Type Code (DP004)","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}},{"name":"tmplFileNm","in":"query","description":"Template File Name","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseDisplayTemplateDto"}}}}}}}}}
````
## Delete Display Template List
> \## Function Description\
> \* API for deleting the display template list.\
> \---\
> \## Detailed Description\
> \* The display template list can be deleted.\
> \* Deletion is not possible if the display template is linked to a store/special exhibition.\
> \* Input parameters (\_\_\*\_\_ : required)\
> \* delete: \_\_tmplNo \*\_\_
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DisplayTemplateDto":{"type":"object","description":"Template Basic","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplTypCd":{"type":"string","description":"Template Type Code (DP004)"},"tmplFileNm":{"type":"string","description":"Template File Name"},"useYn":{"type":"string","description":"Usage Status"},"tmplMappCount":{"type":"integer","format":"int64","description":"Template Mapping Count"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/display/displayTemplateMgmt":{"delete":{"tags":["Display Template Management"],"summary":"Delete Display Template List","description":"## Function Description\n* API for deleting the display template list.\n---\n## Detailed Description\n* The display template list can be deleted.\n* Deletion is not possible if the display template is linked to a store/special exhibition.\n* Input parameters (__*__ : required)\n * delete: __tmplNo *__\n","operationId":"deleteTemplateList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisplayTemplateDto"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}}}}}}}
```
## Retrieve Display Template Detail
> \## Function Description\
> \* API for retrieving display template detail information.\
> \---\
> \## Detailed Description\
> \* Retrieves the corresponding template detail information by template number.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseDisplayTemplateEntity":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/DisplayTemplateEntity","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"DisplayTemplateEntity":{"type":"object","description":"Template Basic","properties":{"tmplNo":{"type":"string"},"tmplNm":{"type":"string"},"tmplTypCd":{"type":"string"},"tmplFileNm":{"type":"string"},"tmplPathNm":{"type":"string"},"useYn":{"type":"string"},"sysRegId":{"type":"string"},"sysRegDtm":{"type":"string","format":"date-time"},"sysModId":{"type":"string"},"sysModDtm":{"type":"string","format":"date-time"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/display/displayTemplateMgmt/{tmplNo}":{"get":{"tags":["Display Template Management"],"summary":"Retrieve Display Template Detail","description":"## Function Description\n* API for retrieving display template detail information.\n---\n## Detailed Description\n* Retrieves the corresponding template detail information by template number.\n","operationId":"getDisplayTemplateDetail","parameters":[{"name":"tmplNo","in":"query","description":"Template No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseDisplayTemplateEntity"}}}}}}}}}
```
## Display Template Linked Store/Special Exhibition List
> \## Function Description\
> \* API for retrieving the display template linked store/special exhibition list.\
> \---\
> \## Detailed Description\
> \* Retrieves the store/special exhibition list linked to the display template by Template No., Template Type Code, and Page No.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseRealGridListResponseDisplayShopMappTemplateDto":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseDisplayShopMappTemplateDto","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseDisplayShopMappTemplateDto":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/DisplayShopMappTemplateDto"}}}},"DisplayShopMappTemplateDto":{"type":"object","description":"Store Template Mapping Information","properties":{"siteNm":{"type":"string","description":"Site Name"},"dpmlNm":{"type":"string","description":"Display Mall Name"},"shopTmplNo":{"type":"string","description":"Store Template No."},"dispCtgNo":{"type":"string","description":"Category No."},"mkdpNo":{"type":"string","description":"Special Exhibition No."},"shopNo":{"type":"string","description":"Store No."},"shopNm":{"type":"string","description":"Store Name"},"tmplNo":{"type":"string","description":"Template No."},"dispStrDtm":{"type":"string","format":"date-time","description":"Display Start Date/Time"},"dispEndDtm":{"type":"string","format":"date-time","description":"Display End Date/Time"},"dispYn":{"type":"string","description":"Display Status"},"tmplNm":{"type":"string","description":"Template Name"},"tmplFileNm":{"type":"string","description":"Template File Name"},"tmplTypCd":{"type":"string","description":"Template Type Code (DP004)"},"tmplTypCdNm":{"type":"string","description":"Template Type Code Name"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/display/displayTemplateMgmt/connect":{"get":{"tags":["Display Template Management"],"summary":"Display Template Linked Store/Special Exhibition List","description":"## Function Description\n* API for retrieving the display template linked store/special exhibition list.\n---\n## Detailed Description\n* Retrieves the store/special exhibition list linked to the display template by Template No., Template Type Code, and Page No.\n","operationId":"getDisplayTemplateMappInfoList","parameters":[{"name":"tmplNo","in":"query","description":"Template No.","required":true,"schema":{"type":"string"}},{"name":"tmplTypCd","in":"query","description":"Template Type Code (DP004)","required":true,"schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Page No.","required":true,"schema":{"type":"number"}},{"name":"rowsPerPage","in":"query","description":"Items per Page","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseDisplayShopMappTemplateDto"}}}}}}}}}
```