구좌 관리

구좌 목록 조회

get

기능설명

• 전체 구좌 목록을 조회한다.

---

상세설명

• [BO] 전시 > 전시연결관리 > 구좌관리 > 구좌목록 그리드 영역

• 조회 조건에 따라 구좌 목록을 조회한다.

---

수정번호

• Release v1.05_231204 : 구좌 관리 최초 개발

• Release : 구좌사이트몰맵핑 테이블로 구좌:몰 1:N 개념 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNostringOptional

사이트번호

Example: 1

dpmlNostringOptional

전시몰번호

Example: 10001

shopNostringOptional

매장번호

Example: 1

useYnstringOptional

사용여부

Example: Y

adutInfostringOptional

구좌 구분 정보

Example: name

adutInfoValstringOptional

구좌 구분 값

Example: 구좌명

dispConrInfostringOptional

전시코너 구분정보

Example: name

dispConrInfoValstringOptional

전시코너 값

Example: 전시코너명

rowsPerPagenumberRequired

페이지 당 row

Example: 100

pageIdxnumberRequired

현재 페이지

Example: 1

Responses

200

구좌 목록 조회 성공

*/*

구좌 관리

siteNostringOptional

사이트 번호

adutIdstringOptional

구좌ID

adutNmstringOptional

구좌명

siteNmstringOptional

사이트명

dpmlNostringOptional

몰 번호

dpmlNoListstring[]Optional

몰 번호 목록

dpmlNmstringOptional

전시몰명

tmplConrNostringOptional

템플릿코너번호

conrNostringOptional

코너번호

conrNmstringOptional

코너명

shopNostringOptional

매장번호

dispShopNmstringOptional

전시매장명

dispMediaCdstringOptional

전시매체코드(DP018)

dispMediaNmstringOptional

전시매체코드명(DP018)

mappTtlstringOptional

매핑타이틀

useYnstringOptional

사용여부

templCornerDispYnstringOptional

템플릿코너전시여부

shopDispYnstringOptional

매장전시여부

updateFlagstringOptional

수정 상태 여부

totalCountinteger · int32Optional

총 갯수

900

구좌 목록 조회 실패

*/*

get

/v2/display/account

HTTPcURLJavaScriptPython

GET /api/bo/v2/display/account?rowsPerPage=1&pageIdx=1 HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": "text",
  "adutId": "text",
  "adutNm": "text",
  "siteNm": "text",
  "dpmlNo": "text",
  "dpmlNoList": [
    "text"
  ],
  "dpmlNm": "text",
  "tmplConrNo": "text",
  "conrNo": "text",
  "conrNm": "text",
  "shopNo": "text",
  "dispShopNm": "text",
  "dispMediaCd": "text",
  "dispMediaNm": "text",
  "mappTtl": "text",
  "useYn": "text",
  "templCornerDispYn": "text",
  "shopDispYn": "text",
  "updateFlag": "text",
  "totalCount": 1
}

구좌 정보 등록 및 수정

post

기능설명

• 구좌 정보를 등록 및 수정한다.

---

상세설명

• [BO] 전시 > 전시연결관리 > 구좌관리 > 구좌 등록/수정 팝업

• 입력 파라미터( *: 필수)

  • create: adutId *, adutNm *, siteNo *, dpmlNoList *, shopNo *, tmplConrNo *, useYn *

  • update: adutId *, useYn *, dpmlNoList *

---

수정번호

• Release v1.05_231204 : 구좌 관리 최초 개발

• Release : 템플릿 코너번호 중복체크, 구좌사이트몰맵핑 테이블 저장

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

구좌 관리 등록/수정 성공

*/*

stringOptional

900

구좌 관리 등록/수정 실패

*/*

post

/v2/display/account

HTTPcURLJavaScriptPython

POST /api/bo/v2/display/account HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

구좌 매장 관리 Tree 호출

get

기능설명

• 구좌 매장 관리에서 구좌 매장 목록을 Tree 형식으로 호출하는 API 입니다.

---

상세설명

• 접근경로 : [BO] 전시 -> 전시 연결 관리 -> 구좌 매장 관리

• 별도의 구좌 매장 관리 화면에서 구좌 매장 목록을 Tree 형식으로 조회합니다.

---

수정번호

• Release v1.05_231204 : 구좌 매장 관리 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

dispYnstringOptional

전시여부

Example: Y

Responses

200

구좌 매장 관리 TREE 호출 성공

*/*

stringOptional

400

구좌 매장 관리 TREE 호출 실패

*/*

get

/v2/display/account/shop

HTTPcURLJavaScriptPython

GET /api/bo/v2/display/account/shop HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

구좌 매장 관리 - 구좌 매장 등록/수정

post

기능설명

• 구좌 매장 관리에서 구좌 매장의 정보를 등록 및 수정하는 API 입니다.

---

상세설명

• 접근경로 : [BO] 전시 -> 전시 연결 관리 -> 구좌 매장 관리 -> 구좌 매장 추가

• 등록

  • 구좌 매장 추가를 눌러 매장 정보를 기재하고 구좌 매장을 추가 한다.

    • 필수정보 : 매장 명, 매장 설명, 전시여부

• 수정

  • 수정이 필요한 매장을 선택 후 매장 정보를 수정한다.

    • 필수정보 : 매장 명, 전시 여부

---

수정번호

• Release v1.05_231204 : 구좌 매장 관리 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

전시매장기본

shopNostringOptional

매장번호

Example: 1

shopTypCdstringOptional

매장유형코드(DP003)

Example: 10

dpmlNostringOptional

전시몰번호

Example: 10001

dispShopNmstringOptional

전시매장명

Example: 홈

dispSeqinteger · int32Optional

전시순서

Example: 1

dispYnstringOptional

전시여부

Example: Y

dispMediaCdstringOptional

전시매체코드(DP018)

Example: 99

dispCtgNostringOptional

전시카테고리번호

prtTypCdstringOptional

출력유형코드(DP002)

Example: 01

linkUrlAddrstringRead-onlyOptional

연결URL주소

linkDispNostringRead-onlyOptional

연결전시번호

movFrmeCdstringRead-onlyOptional

이동프레임코드(DP007)

brandNostringOptional

브랜드번호

shopDescContstringOptional

매장설명내용

Example: 통합몰메인

dispCtgNmstringOptional

전시카테고리이름

brandNmstringRead-onlyOptional

브랜드명

Responses

200

구좌 매장 저장 성공

*/*

stringOptional

400

구좌 매장 저장 실패

*/*

post

/v2/display/account/shop

HTTPcURLJavaScriptPython

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

{
  "shopNo": 1,
  "shopTypCd": 10,
  "dpmlNo": 10001,
  "dispShopNm": "홈",
  "dispSeq": 1,
  "dispYn": "Y",
  "dispMediaCd": 99,
  "dispCtgNo": "text",
  "prtTypCd": "01",
  "brandNo": "text",
  "shopDescCont": "통합몰메인",
  "dispCtgNm": "text"
}

text

구좌 상세 정보 조회

get

기능설명

• 구좌 상세 정보를 조회한다.

---

상세설명

• [BO] 전시 > 전시연결관리 > 구좌관리 > 구좌 등록/수정 팝업

• 조회 조건에 따라 구좌 상세를 조회한다.

---

수정번호

• Release : 구좌 등록/수정 팝업 최초 개발

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

adutIdstringRequired

구좌ID

Example: gnb

Query parameters

siteNostringOptional

사이트번호

Example: 1

Responses

200

구좌 상세 조회 성공

*/*

구좌 관리

siteNostringOptional

사이트 번호

adutIdstringOptional

구좌ID

adutNmstringOptional

구좌명

siteNmstringOptional

사이트명

dpmlNostringOptional

몰 번호

dpmlNoListstring[]Optional

몰 번호 목록

dpmlNmstringOptional

전시몰명

tmplConrNostringOptional

템플릿코너번호

conrNostringOptional

코너번호

conrNmstringOptional

코너명

shopNostringOptional

매장번호

dispShopNmstringOptional

전시매장명

dispMediaCdstringOptional

전시매체코드(DP018)

dispMediaNmstringOptional

전시매체코드명(DP018)

mappTtlstringOptional

매핑타이틀

useYnstringOptional

사용여부

templCornerDispYnstringOptional

템플릿코너전시여부

shopDispYnstringOptional

매장전시여부

updateFlagstringOptional

수정 상태 여부

totalCountinteger · int32Optional

총 갯수

900

구좌 상세 조회 실패

*/*

get

/v2/display/account/{adutId}

HTTPcURLJavaScriptPython

GET /api/bo/v2/display/account/{adutId} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": "text",
  "adutId": "text",
  "adutNm": "text",
  "siteNm": "text",
  "dpmlNo": "text",
  "dpmlNoList": [
    "text"
  ],
  "dpmlNm": "text",
  "tmplConrNo": "text",
  "conrNo": "text",
  "conrNm": "text",
  "shopNo": "text",
  "dispShopNm": "text",
  "dispMediaCd": "text",
  "dispMediaNm": "text",
  "mappTtl": "text",
  "useYn": "text",
  "templCornerDispYn": "text",
  "shopDispYn": "text",
  "updateFlag": "text",
  "totalCount": 1
}

구좌에 연결된 템플릿코너번호 목록 조회

get

기능설명

• 구좌에 연결된 템플릿코너번호 목록을 조회하는 API입니다.

---

상세설명

• [BO] 전시 > 전시연결관리 > 서비스별 구좌 관리

• 구좌에 연결된 템플릿코너번호 목록을 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tmplConrNoListarrayRequired

템플릿코너번호 목록

Example: ["2388","2764"]

Responses

200

구좌에 연결된 템플릿코너번호 목록 조회 조회 성공

*/*

stringOptional

900

구좌에 연결된 템플릿코너번호 목록 조회 조회 실패

*/*

get

/v2/display/account/tmplConrNo

HTTPcURLJavaScriptPython

GET /api/bo/v2/display/account/tmplConrNo?tmplConrNoList=undefined HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text