Ctrlk
X2BEE 바로가기
For the complete documentation index, see llms.txt. This page is also available as Markdown.

전시 레이아웃 구성안 관리

구성안 목록 조회

get

기능설명

  • 전시위치별 레이아웃 구성안 목록을 조회합니다.

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

구성안명(부분검색)

shopTypCdstringOptional

전시매장유형(HOME/CATEGORY/BRAND/SLOT)

locKeystringOptional

전시위치키

configStatCdstringOptional

구성안상태(DRAFT/RESERVED/LIVE/OFF)

pageIdxnumberOptional

페이지 번호

Example: 1
rowsPerPagenumberOptional

페이지당 개수

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/displayLayoutConfig
GET /api/bo/v2/display/displayLayoutConfig 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": [
      {
        "siteNo": "text",
        "configNo": "text",
        "configNm": "text",
        "shopTypCd": "text",
        "locKey": "text",
        "dpmlNo": "text",
        "configStatCd": "text",
        "dispStrDtm": "2026-01-01T00:00:00.000Z",
        "dispEndDtm": "2026-01-01T00:00:00.000Z",
        "schemaVer": 1,
        "registryVer": "text",
        "rendererVer": "text",
        "renderTarget": "text",
        "revisionNo": 1,
        "layoutJson": "text",
        "useYn": "text"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

구성안 신규 생성

post

기능설명

  • 전시위치(매장유형 + 위치키)에 대한 새 구성안을 DRAFT 상태로 생성합니다.

상세설명

  • 구성안번호는 서버에서 채번(LCxxxxxxxxxx)하며, 생성된 구성안을 반환합니다.

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

전시 레이아웃 구성안 저장 요청

siteNostringOptional

사이트번호

configNmstringOptional

구성안명

shopTypCdstringOptional

전시매장유형(HOME/CATEGORY/BRAND/SLOT)

locKeystringOptional

전시위치키(위치명/dispCtgNo/brandNo/slotKey)

dpmlNostringOptional

전시몰번호

dispStrDtmstring · date-timeOptional

전시시작일시

dispEndDtmstring · date-timeOptional

전시종료일시

layoutDocanyOptional

레이아웃 문서(LayoutDocument) JSON. 생략 시 빈 문서.

revisionNointeger · int64Optional

리비전번호(기존 저장 수정 시 낙관적락 기준)

renderTargetstringOptional

렌더대상(PAGE/FRAGMENT/BOTH). 생략 시 PAGE

Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

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

{
  "siteNo": "text",
  "configNm": "text",
  "shopTypCd": "text",
  "locKey": "text",
  "dpmlNo": "text",
  "dispStrDtm": "2026-01-01T00:00:00.000Z",
  "dispEndDtm": "2026-01-01T00:00:00.000Z",
  "layoutDoc": null,
  "revisionNo": 1,
  "renderTarget": "text"
}
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "siteNo": "text",
    "configNo": "text",
    "configNm": "text",
    "shopTypCd": "text",
    "locKey": "text",
    "dpmlNo": "text",
    "configStatCd": "text",
    "dispStrDtm": "2026-01-01T00:00:00.000Z",
    "dispEndDtm": "2026-01-01T00:00:00.000Z",
    "schemaVer": 1,
    "registryVer": "text",
    "rendererVer": "text",
    "renderTarget": "text",
    "revisionNo": 1,
    "layoutJson": "text",
    "useYn": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

구성안 목록 삭제

delete

기능설명

  • 선택한 구성안들을 논리 삭제(USE_YN='N')합니다.

상세설명

  • DRAFT(임시저장)·OFF(전시 안 함) 상태만 삭제 가능하며, RESERVED(예약)·LIVE(전시중)는 거부합니다.

  • 한 건이라도 삭제할 수 없으면 전체를 롤백합니다.

  • 필수 값 목록

    • 구성안번호 목록

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodystring[]
string[]Optional
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadanyOptional

payload

errorbooleanOptional

is error

delete/v2/display/displayLayoutConfig
DELETE /api/bo/v2/display/displayLayoutConfig HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
200

OK

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

구성안 상세 조회

get

기능설명

  • 구성안의 기본정보 + LayoutDocument 를 조회합니다.

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

구성안번호

Example: LC0000000001
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v2/display/displayLayoutConfig/{configNo}
GET /api/bo/v2/display/displayLayoutConfig/{configNo} 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": {
    "siteNo": "text",
    "configNo": "text",
    "configNm": "text",
    "shopTypCd": "text",
    "locKey": "text",
    "dpmlNo": "text",
    "configStatCd": "text",
    "dispStrDtm": "2026-01-01T00:00:00.000Z",
    "dispEndDtm": "2026-01-01T00:00:00.000Z",
    "schemaVer": 1,
    "registryVer": "text",
    "rendererVer": "text",
    "renderTarget": "text",
    "revisionNo": 1,
    "layoutJson": "text",
    "useYn": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

구성안 저장

post

기능설명

  • 구성안의 기본정보와 LayoutDocument 를 저장합니다.

상세설명

  • 리비전 낙관적락으로 갱신하며, 동시 수정으로 리비전이 어긋나면 오류를 반환합니다.

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

구성안번호

Example: LC0000000001
Body

전시 레이아웃 구성안 저장 요청

siteNostringOptional

사이트번호

configNmstringOptional

구성안명

shopTypCdstringOptional

전시매장유형(HOME/CATEGORY/BRAND/SLOT)

locKeystringOptional

전시위치키(위치명/dispCtgNo/brandNo/slotKey)

dpmlNostringOptional

전시몰번호

dispStrDtmstring · date-timeOptional

전시시작일시

dispEndDtmstring · date-timeOptional

전시종료일시

layoutDocanyOptional

레이아웃 문서(LayoutDocument) JSON. 생략 시 빈 문서.

revisionNointeger · int64Optional

리비전번호(기존 저장 수정 시 낙관적락 기준)

renderTargetstringOptional

렌더대상(PAGE/FRAGMENT/BOTH). 생략 시 PAGE

Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v2/display/displayLayoutConfig/{configNo}
POST /api/bo/v2/display/displayLayoutConfig/{configNo} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "siteNo": "text",
  "configNm": "text",
  "shopTypCd": "text",
  "locKey": "text",
  "dpmlNo": "text",
  "dispStrDtm": "2026-01-01T00:00:00.000Z",
  "dispEndDtm": "2026-01-01T00:00:00.000Z",
  "layoutDoc": null,
  "revisionNo": 1,
  "renderTarget": "text"
}
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "siteNo": "text",
    "configNo": "text",
    "configNm": "text",
    "shopTypCd": "text",
    "locKey": "text",
    "dpmlNo": "text",
    "configStatCd": "text",
    "dispStrDtm": "2026-01-01T00:00:00.000Z",
    "dispEndDtm": "2026-01-01T00:00:00.000Z",
    "schemaVer": 1,
    "registryVer": "text",
    "rendererVer": "text",
    "renderTarget": "text",
    "revisionNo": 1,
    "layoutJson": "text",
    "useYn": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

구성안 게시(상태 전이)

post

기능설명

  • 구성안을 게시 방식에 따라 상태 전이합니다.

상세설명

  • now(즉시 게시): LIVE 로 전이하고 같은 전시위치의 기존 LIVE 구성안을 OFF 로 자동 종료합니다.

  • reserve(예약 게시): RESERVED 로 전이합니다(전시시작일시 필수). 시작 시점 활성화는 후속 배치가 처리합니다.

  • off(전시 안 함): OFF 로 전이합니다.

  • 리비전 낙관적락으로 갱신하며, 동시 수정으로 리비전이 어긋나면 오류를 반환합니다.

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

구성안번호

Example: LC0000000001
Query parameters
modestringRequired

게시 방식(now/reserve/off)

Example: now
revisionNonumberOptional

현재 리비전(낙관적락 기준)

Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v2/display/displayLayoutConfig/{configNo}/publish
POST /api/bo/v2/display/displayLayoutConfig/{configNo}/publish?mode=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": {
    "siteNo": "text",
    "configNo": "text",
    "configNm": "text",
    "shopTypCd": "text",
    "locKey": "text",
    "dpmlNo": "text",
    "configStatCd": "text",
    "dispStrDtm": "2026-01-01T00:00:00.000Z",
    "dispEndDtm": "2026-01-01T00:00:00.000Z",
    "schemaVer": 1,
    "registryVer": "text",
    "rendererVer": "text",
    "renderTarget": "text",
    "revisionNo": 1,
    "layoutJson": "text",
    "useYn": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

콘텐츠 이미지 업로드

post

기능설명

  • 전시 구성안 콘텐츠(배너/이미지) 이미지를 S3(display) 경로에 업로드하고 접근 URL 을 반환합니다.

상세설명

  • 여러 파일을 한 번에 업로드할 수 있으며, 빌더는 필드(PC/MO)당 1장씩 호출합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filesstring · binary[]Optional
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

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

{
  "files": [
    "binary"
  ]
}
200

OK

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

전시 구성안 미리보기 세션 생성

post

편집 중인 레이아웃 문서로 미리보기 세션을 만든다(api-display 전달).

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

OK

*/*
Other propertiesanyOptional
post/v2/display/displayLayoutConfig/preview/
POST /api/bo/v2/display/displayLayoutConfig/preview/ HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

전시 구성안 미리보기 세션 생성

post

편집 중인 레이아웃 문서로 미리보기 세션을 만든다(api-display 전달).

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

OK

*/*
Other propertiesanyOptional
post/v2/display/displayLayoutConfig/preview
POST /api/bo/v2/display/displayLayoutConfig/preview HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
이전전시 레이아웃 관리
다음전시 코너 관리

마지막 업데이트