> 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/store-front-api-reference/common-api/models.md).

# 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":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"sortSeq":{"type":"string","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"},"ref6Val":{"type":"string","description":"Reference Value 6"},"ref7Val":{"type":"string","description":"Reference Value 7"}}}}}}
```

## The StCdRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"StCdRes":{"type":"object","description":"Common Code Inquiry Response","properties":{"grpCd":{"type":"string","description":"Group Code"},"grpCdNm":{"type":"string","description":"Group Code Name"},"codeInfo":{"type":"array","description":"Detail Code List","items":{"$ref":"#/components/schemas/StCdDtlRes"}}}},"StCdDtlRes":{"type":"object","properties":{"key":{"type":"string","description":"key"},"cd":{"type":"string","description":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"sortSeq":{"type":"string","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"},"ref6Val":{"type":"string","description":"Reference Value 6"},"ref7Val":{"type":"string","description":"Reference Value 7"}}}}}}
```

## The AppVerReq object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"AppVerReq":{"type":"object","description":"Version Check API Request","properties":{"siteDom":{"type":"string","description":"Site Domain"},"appVersion":{"type":"string","description":"Version of the currently running app"},"osType":{"type":"string","description":"OS Type I: iOS, A: AOS"},"osVersion":{"type":"string","description":"Version information of the OS installed on the device"},"deviceName":{"type":"string","description":"Device Name"}},"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":"Version Check API Response","properties":{"versionInfo":{"$ref":"#/components/schemas/VersionInfo","description":"Version Information"},"splashInfo":{"$ref":"#/components/schemas/SplashInfo","description":"Splash Information"}}},"VersionInfo":{"type":"object","description":"App Version Information Entity","properties":{"updateType":{"type":"string","description":"Update Type Code (CM032) N: Normal Update, F: Forced Update"},"storeUrl":{"type":"string","description":"Store Market URL"}}},"SplashInfo":{"type":"object","description":"App Splash Entity","properties":{"imgUrl":{"type":"string","description":"Splash Image 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":"Version Check API Response","properties":{"versionInfo":{"$ref":"#/components/schemas/VersionInfo","description":"Version Information"},"splashInfo":{"$ref":"#/components/schemas/SplashInfo","description":"Splash Information"}}},"VersionInfo":{"type":"object","description":"App Version Information Entity","properties":{"updateType":{"type":"string","description":"Update Type Code (CM032) N: Normal Update, F: Forced Update"},"storeUrl":{"type":"string","description":"Store Market URL"}}},"SplashInfo":{"type":"object","description":"App Splash Entity","properties":{"imgUrl":{"type":"string","description":"Splash Image 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":"App Splash Entity","properties":{"imgUrl":{"type":"string","description":"Splash Image URL"}}}}}}
```

## The VersionInfo object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"VersionInfo":{"type":"object","description":"App Version Information Entity","properties":{"updateType":{"type":"string","description":"Update Type Code (CM032) N: Normal Update, F: Forced Update"},"storeUrl":{"type":"string","description":"Store Market URL"}}}}}}
```

## The PgApprovalAdjustReceiveRequest object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"PgApprovalAdjustReceiveRequest":{"type":"object","description":"PG Approval/Settlement Information Reception Request DTO","properties":{"startDate":{"type":"string","format":"date","description":"Search Start Date"},"endDate":{"type":"string","format":"date","description":"Search End Date"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"}}}}}}
```

## The BadWordMgmtRequest object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"BadWordMgmtRequest":{"type":"object","description":"Prohibited Word Inquiry Request","properties":{"siteNo":{"type":"string","description":"Site No."},"langCd":{"type":"string","description":"Language Code"},"useYn":{"type":"string","description":"Usage Status"}}}}}}
```

## The StCdReq object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"StCdReq":{"type":"object","description":"Common Code Inquiry Request","properties":{"grpCd":{"type":"string","description":"Group Code"},"midCd":{"type":"string","description":"Code"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 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":"Code"},"cdNm":{"type":"string","description":"Code Name"},"cdDesc":{"type":"string","description":"Code Description"},"sortSeq":{"type":"string","description":"Sort Order"},"ref1Val":{"type":"string","description":"Reference Value 1"},"ref2Val":{"type":"string","description":"Reference Value 2"},"ref3Val":{"type":"string","description":"Reference Value 3"},"ref4Val":{"type":"string","description":"Reference Value 4"},"ref5Val":{"type":"string","description":"Reference Value 5"},"ref6Val":{"type":"string","description":"Reference Value 6"},"ref7Val":{"type":"string","description":"Reference Value 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":"Customer Notification List Inquiry Request","properties":{"siteNo":{"type":"string","description":"Site No."},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Screen Large Category Code (CM026)"},"scrnMgrpCd":{"type":"string","description":"Screen Medium Category Code (CM027)"},"langCd":{"type":"string","description":"Language Code"}},"required":["scrnLgrpCd","scrnMgrpCd"]}}}}
```

## The ScreenNotiRes object

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"components":{"schemas":{"ScreenNotiRes":{"type":"object","description":"Customer Notification List Response","properties":{"ntcConts":{"type":"array","description":"Customer Notification List Content","items":{"type":"string"}}}}}}}
```