> 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/hybrid-app.md).

# Hybrid App

## Version Check

> \## Function Description\
> \* Retrieves the version that needs to be updated.\
> \---\
> \## Detailed Description\
> \* Retrieved based on appVersion, osType, and the siteNo value in the cookie.\
> \* Only codes with usage status Y are retrieved.\
> \* Only a single record is retrieved, based on the most recent update date and time.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Common API","version":"v1"},"servers":[{"url":"https://api-common.x2bee.com/api/common/","description":"prd"}],"paths":{"/v1/app/version":{"post":{"tags":["Hybrid App"],"summary":"Version Check","description":"## Function Description\n* Retrieves the version that needs to be updated.\n---\n## Detailed Description\n* Retrieved based on appVersion, osType, and the siteNo value in the cookie.\n* Only codes with usage status Y are retrieved.\n* Only a single record is retrieved, based on the most recent update date and time.\n","operationId":"getVersionInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVerReq"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseAppVerRes"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"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"}}},"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"}}}}}}}
```