> 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/store-template-management.md). # Store Template Management ## Retrieve Store Linked Template List > \## Function Description\ > \* API for retrieving the list of templates linked to a store.\ > \---\ > \## Detailed Description\ > \* Retrieves the list of templates linked to a store by store 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":{"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/displayTemplateMappMgmt":{"get":{"tags":["Store Template Management"],"summary":"Retrieve Store Linked Template List","description":"## Function Description\n* API for retrieving the list of templates linked to a store.\n---\n## Detailed Description\n* Retrieves the list of templates linked to a store by store number.\n","operationId":"getShopMappTemplateList","parameters":[{"name":"shopNo","in":"query","description":"Store No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseDisplayShopMappTemplateDto"}}}}}}}}} ``` ## Save Store Linked Template List > \## Function Description\ > \* API for saving the store linked template list.\ > \---\ > \## Detailed Description\ > \* The store linked template list can be saved, modified, and deleted.\ > \* Deletion is not possible if a corner is linked to the store template.\ > \* Input parameters (\_\_\*\_\_ : required)\ > \* create : \_\_shopNo \*, tmplNo \*, dispStrDtm \*, dispEndDtm \*, dispYn \*, sysRegId \*, sysModId \*\_\_\ > \* update : \_\_shopTmplNo \*, shopNo \*, tmplNo \*, dispStrDtm \*, dispEndDtm \*, dispYn \*, sysRegId \*, sysModId \*\_\_\ > \* delete : \_\_shopTmplNo \*\_\_\ > \---\ > \## Code Reference\ > \* \`\`\` Display 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":{"RealGridCUDRequestDisplayShopMappTemplateDto":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/DisplayShopMappTemplateDto"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/DisplayShopMappTemplateDto"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/DisplayShopMappTemplateDto"}},"delete":{"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"}}},"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/displayTemplateMappMgmt":{"post":{"tags":["Store Template Management"],"summary":"Save Store Linked Template List","description":"## Function Description\n* API for saving the store linked template list.\n---\n## Detailed Description\n* The store linked template list can be saved, modified, and deleted.\n* Deletion is not possible if a corner is linked to the store template.\n* Input parameters (__*__ : required)\n * create : __shopNo *, tmplNo *, dispStrDtm *, dispEndDtm *, dispYn *, sysRegId *, sysModId *__\n * update : __shopTmplNo *, shopNo *, tmplNo *, dispStrDtm *, dispEndDtm *, dispYn *, sysRegId *, sysModId *__\n * delete : __shopTmplNo *__\n---\n## Code Reference\n* ``` Display Status ``` : Y,N\n","operationId":"saveShopMappTemplateList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestDisplayShopMappTemplateDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}}}}}}} ```` ## 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/displayTemplateMappMgmt/{tmplNo}/shop":{"get":{"tags":["Store 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":"getTemplateMappShopList","parameters":[{"name":"tmplNo","in":"path","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"}}}}}}}}} ``` ## Retrieve Store Linked Template > \## Function Description\ > \* API for retrieving the slot store linked template. Only 1 template is retrieved.\ > \---\ > \## Detailed Description\ > \* Retrieves the list of templates linked to a store by store number.\ > \---\ > \## Revision History\ > \* \`\`\`Release v1.05\_231204\`\`\` : Initial development of Store Linked Template Inquiry
````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":{"ResponseDisplayShopMappTemplateDto":{"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/DisplayShopMappTemplateDto","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"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/displayTemplateMappMgmt/{shopNo}":{"get":{"tags":["Store Template Management"],"summary":"Retrieve Store Linked Template","description":"## Function Description\n* API for retrieving the slot store linked template. Only 1 template is retrieved.\n---\n## Detailed Description\n* Retrieves the list of templates linked to a store by store number.\n---\n## Revision History\n* ```Release v1.05_231204``` : Initial development of Store Linked Template Inquiry\n","operationId":"getShopMappTemplate","parameters":[{"name":"shopNo","in":"path","description":"Store No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseDisplayShopMappTemplateDto"}}}}}}}}} ```` ## Retrieve Template Number List Linked to Store/Special Exhibition > \## Function Description\ > \* API for retrieving the template number list linked to a store/special exhibition.\ > \---\ > \## Detailed Description\ > \* Retrieves the template number list linked to a store/special exhibition by a list of template numbers.
```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":{"ResponseListString":{"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":"array","description":"payload","items":{"type":"string"}},"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/displayTemplateMappMgmt/tmplNo":{"get":{"tags":["Store Template Management"],"summary":"Retrieve Template Number List Linked to Store/Special Exhibition","description":"## Function Description\n* API for retrieving the template number list linked to a store/special exhibition.\n---\n## Detailed Description\n* Retrieves the template number list linked to a store/special exhibition by a list of template numbers.\n","operationId":"getMappedTmplNoList","parameters":[{"name":"tmplNoList","in":"query","description":"Template Number List","required":true,"schema":{"type":"array"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListString"}}}}}}}}} ```