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

Store Template Management

Retrieve Store Linked Template List

get

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.

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

Store No.

Example: 1
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v2/display/displayTemplateMappMgmt
GET /api/bo/v2/display/displayTemplateMappMgmt?shopNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "totalCount": 1,
    "payloads": [
      {
        "siteNm": "text",
        "dpmlNm": "text",
        "shopTmplNo": 1,
        "dispCtgNo": "text",
        "mkdpNo": "text",
        "shopNo": 1,
        "shopNm": "text",
        "tmplNo": 10001,
        "dispStrDtm": "2026-01-01T00:00:00.000Z",
        "dispEndDtm": "2026-01-01T00:00:00.000Z",
        "dispYn": "Y",
        "tmplNm": "text",
        "tmplFileNm": "text",
        "tmplTypCd": "text",
        "tmplTypCdNm": "text"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Save Store Linked Template List

post

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

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

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v2/display/displayTemplateMappMgmt
POST /api/bo/v2/display/displayTemplateMappMgmt HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1222

{
  "all": [
    {
      "siteNm": "text",
      "dpmlNm": "text",
      "shopTmplNo": 1,
      "dispCtgNo": "text",
      "mkdpNo": "text",
      "shopNo": 1,
      "shopNm": "text",
      "tmplNo": 10001,
      "dispStrDtm": "2026-01-01T00:00:00.000Z",
      "dispEndDtm": "2026-01-01T00:00:00.000Z",
      "dispYn": "Y",
      "tmplNm": "text",
      "tmplFileNm": "text",
      "tmplTypCd": "text",
      "tmplTypCdNm": "text"
    }
  ],
  "create": [
    {
      "siteNm": "text",
      "dpmlNm": "text",
      "shopTmplNo": 1,
      "dispCtgNo": "text",
      "mkdpNo": "text",
      "shopNo": 1,
      "shopNm": "text",
      "tmplNo": 10001,
      "dispStrDtm": "2026-01-01T00:00:00.000Z",
      "dispEndDtm": "2026-01-01T00:00:00.000Z",
      "dispYn": "Y",
      "tmplNm": "text",
      "tmplFileNm": "text",
      "tmplTypCd": "text",
      "tmplTypCdNm": "text"
    }
  ],
  "update": [
    {
      "siteNm": "text",
      "dpmlNm": "text",
      "shopTmplNo": 1,
      "dispCtgNo": "text",
      "mkdpNo": "text",
      "shopNo": 1,
      "shopNm": "text",
      "tmplNo": 10001,
      "dispStrDtm": "2026-01-01T00:00:00.000Z",
      "dispEndDtm": "2026-01-01T00:00:00.000Z",
      "dispYn": "Y",
      "tmplNm": "text",
      "tmplFileNm": "text",
      "tmplTypCd": "text",
      "tmplTypCdNm": "text"
    }
  ],
  "delete": [
    {
      "siteNm": "text",
      "dpmlNm": "text",
      "shopTmplNo": 1,
      "dispCtgNo": "text",
      "mkdpNo": "text",
      "shopNo": 1,
      "shopNm": "text",
      "tmplNo": 10001,
      "dispStrDtm": "2026-01-01T00:00:00.000Z",
      "dispEndDtm": "2026-01-01T00:00:00.000Z",
      "dispYn": "Y",
      "tmplNm": "text",
      "tmplFileNm": "text",
      "tmplTypCd": "text",
      "tmplTypCdNm": "text"
    }
  ]
}
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Display Template Linked Store/Special Exhibition List

get

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tmplNostringRequired

Template No.

Example: 10001
Query parameters
tmplTypCdstringRequired

Template Type Code (DP004)

Example: 10
pageIdxnumberRequired

Page No.

Example: 1
rowsPerPagenumberRequired

Items per Page

Example: 100
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v2/display/displayTemplateMappMgmt/{tmplNo}/shop
GET /api/bo/v2/display/displayTemplateMappMgmt/{tmplNo}/shop?tmplTypCd=text&pageIdx=1&rowsPerPage=1 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "totalCount": 1,
    "payloads": [
      {
        "siteNm": "text",
        "dpmlNm": "text",
        "shopTmplNo": 1,
        "dispCtgNo": "text",
        "mkdpNo": "text",
        "shopNo": 1,
        "shopNm": "text",
        "tmplNo": 10001,
        "dispStrDtm": "2026-01-01T00:00:00.000Z",
        "dispEndDtm": "2026-01-01T00:00:00.000Z",
        "dispYn": "Y",
        "tmplNm": "text",
        "tmplFileNm": "text",
        "tmplTypCd": "text",
        "tmplTypCdNm": "text"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Store Linked Template

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
shopNostringRequired

Store No.

Example: 1
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v2/display/displayTemplateMappMgmt/{shopNo}
GET /api/bo/v2/display/displayTemplateMappMgmt/{shopNo} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "siteNm": "text",
    "dpmlNm": "text",
    "shopTmplNo": 1,
    "dispCtgNo": "text",
    "mkdpNo": "text",
    "shopNo": 1,
    "shopNm": "text",
    "tmplNo": 10001,
    "dispStrDtm": "2026-01-01T00:00:00.000Z",
    "dispEndDtm": "2026-01-01T00:00:00.000Z",
    "dispYn": "Y",
    "tmplNm": "text",
    "tmplFileNm": "text",
    "tmplTypCd": "text",
    "tmplTypCdNm": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Template Number List Linked to Store/Special Exhibition

get

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.

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

Template Number List

Example: ["10001"]
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstring[]Optional

payload

errorbooleanOptional

is error

get/v2/display/displayTemplateMappMgmt/tmplNo
GET /api/bo/v2/display/displayTemplateMappMgmt/tmplNo?tmplNoList=undefined HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": [
    "text"
  ],
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}
PreviousDisplay Template Management
NextDisplay Corner Management

Last updated