# Models

## The Response object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"Response":{"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":{"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"}}}}}}
```

## The ValidationError object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}}}
```

## The StCdDtlRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"StCdDtlRes":{"type":"object","properties":{"key":{"type":"string","description":"key"},"cd":{"type":"string","description":"코드"},"cdNm":{"type":"string","description":"코드명"},"cdDesc":{"type":"string","description":"코드설명"},"sortSeq":{"type":"string","description":"정렬순서"},"ref1Val":{"type":"string","description":"참조1값"},"ref2Val":{"type":"string","description":"참조2값"},"ref3Val":{"type":"string","description":"참조3값"},"ref4Val":{"type":"string","description":"참조4값"},"ref5Val":{"type":"string","description":"참조5값"},"ref6Val":{"type":"string","description":"참조6값"},"ref7Val":{"type":"string","description":"참조7값"}}}}}}
```

## The StCdRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"StCdRes":{"type":"object","description":"공통코드 조회 Response","properties":{"grpCd":{"type":"string","description":"그룹코드"},"grpCdNm":{"type":"string","description":"그룹코드명"},"codeInfo":{"type":"array","description":"상세코드리스트","items":{"$ref":"#/components/schemas/StCdDtlRes"}}}},"StCdDtlRes":{"type":"object","properties":{"key":{"type":"string","description":"key"},"cd":{"type":"string","description":"코드"},"cdNm":{"type":"string","description":"코드명"},"cdDesc":{"type":"string","description":"코드설명"},"sortSeq":{"type":"string","description":"정렬순서"},"ref1Val":{"type":"string","description":"참조1값"},"ref2Val":{"type":"string","description":"참조2값"},"ref3Val":{"type":"string","description":"참조3값"},"ref4Val":{"type":"string","description":"참조4값"},"ref5Val":{"type":"string","description":"참조5값"},"ref6Val":{"type":"string","description":"참조6값"},"ref7Val":{"type":"string","description":"참조7값"}}}}}}
```

## The AppVerReq object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"AppVerReq":{"type":"object","description":"버전 체크 API Request","properties":{"siteDom":{"type":"string","description":"사이트 도메인"},"appVersion":{"type":"string","description":"현재 실행되고 있는 앱의 버전"},"osType":{"type":"string","description":"OS 타입 I:iOS A:AOS"},"osVersion":{"type":"string","description":"단말기에 설치된 OS의 버전 정보"},"deviceName":{"type":"string","description":"단말기 디바이스 이름"}},"required":["appVersion","osType","siteDom"]}}}}
```

## The AppVerRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"AppVerRes":{"type":"object","description":"버전 체크 API Response","properties":{"versionInfo":{"$ref":"#/components/schemas/VersionInfo","description":"버전 정보"},"splashInfo":{"$ref":"#/components/schemas/SplashInfo","description":"스플래시 정보"}}},"VersionInfo":{"type":"object","description":"앱버전 정보 Entity","properties":{"updateType":{"type":"string","description":"업데이트타입코드(CM032) N:일반업데이트 F:강제업데이트"},"storeUrl":{"type":"string","description":"스토어 마켓 URL"}}},"SplashInfo":{"type":"object","description":"앱 스플래시 Entity","properties":{"imgUrl":{"type":"string","description":"스플래시 이미지 URL"}}}}}}
```

## The ResponseAppVerRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"ResponseAppVerRes":{"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/AppVerRes","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"AppVerRes":{"type":"object","description":"버전 체크 API Response","properties":{"versionInfo":{"$ref":"#/components/schemas/VersionInfo","description":"버전 정보"},"splashInfo":{"$ref":"#/components/schemas/SplashInfo","description":"스플래시 정보"}}},"VersionInfo":{"type":"object","description":"앱버전 정보 Entity","properties":{"updateType":{"type":"string","description":"업데이트타입코드(CM032) N:일반업데이트 F:강제업데이트"},"storeUrl":{"type":"string","description":"스토어 마켓 URL"}}},"SplashInfo":{"type":"object","description":"앱 스플래시 Entity","properties":{"imgUrl":{"type":"string","description":"스플래시 이미지 URL"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}}}
```

## The SplashInfo object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"SplashInfo":{"type":"object","description":"앱 스플래시 Entity","properties":{"imgUrl":{"type":"string","description":"스플래시 이미지 URL"}}}}}}
```

## The VersionInfo object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"VersionInfo":{"type":"object","description":"앱버전 정보 Entity","properties":{"updateType":{"type":"string","description":"업데이트타입코드(CM032) N:일반업데이트 F:강제업데이트"},"storeUrl":{"type":"string","description":"스토어 마켓 URL"}}}}}}
```

## The PgApprovalAdjustReceiveRequest object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"PgApprovalAdjustReceiveRequest":{"type":"object","description":"PG 승인/정산정보수신 요청 DTO","properties":{"startDate":{"type":"string","format":"date","description":"조회시작일자"},"endDate":{"type":"string","format":"date","description":"조회종료일자"},"pgGbCd":{"type":"string","description":"PG구분코드(OM030)"}}}}}}
```

## The BadWordMgmtRequest object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"BadWordMgmtRequest":{"type":"object","description":"금칙어 조회 Request","properties":{"siteNo":{"type":"string","description":"사이트번호"},"langCd":{"type":"string","description":"언어코드"},"useYn":{"type":"string","description":"사용여부"}}}}}}
```

## The StCdReq object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"StCdReq":{"type":"object","description":"공통코드 조회 Request","properties":{"grpCd":{"type":"string","description":"그룹코드"},"midCd":{"type":"string","description":"코드"},"ref1Val":{"type":"string","description":"참조1값"},"ref2Val":{"type":"string","description":"참조2값"},"ref3Val":{"type":"string","description":"참조3값"}},"required":["grpCd"]}}}}
```

## The ResponseMapStringListStCdDtlRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"ResponseMapStringListStCdDtlRes":{"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":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/StCdDtlRes"}},"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"StCdDtlRes":{"type":"object","properties":{"key":{"type":"string","description":"key"},"cd":{"type":"string","description":"코드"},"cdNm":{"type":"string","description":"코드명"},"cdDesc":{"type":"string","description":"코드설명"},"sortSeq":{"type":"string","description":"정렬순서"},"ref1Val":{"type":"string","description":"참조1값"},"ref2Val":{"type":"string","description":"참조2값"},"ref3Val":{"type":"string","description":"참조3값"},"ref4Val":{"type":"string","description":"참조4값"},"ref5Val":{"type":"string","description":"참조5값"},"ref6Val":{"type":"string","description":"참조6값"},"ref7Val":{"type":"string","description":"참조7값"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}}}
```

## The ScreenNotiReq object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"ScreenNotiReq":{"type":"object","description":"고객알림리스트 조회 Request","properties":{"siteNo":{"type":"string","description":"사이트번호"},"dispMediaCd":{"type":"string","description":"전시매체코드(DP018)"},"scrnLgrpCd":{"type":"string","description":"화면대분류코드(CM026)"},"scrnMgrpCd":{"type":"string","description":"화면중분류코드(CM027)"},"langCd":{"type":"string","description":"언어코드"}},"required":["scrnLgrpCd","scrnMgrpCd"]}}}}
```

## The ScreenNotiRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"ScreenNotiRes":{"type":"object","description":"고객알림리스트 Response","properties":{"ntcConts":{"type":"array","description":"고객알림리스트 내용","items":{"type":"string"}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://tech.x2bee.com/api/store-front-api/common-api/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.