> 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/common.md).
# Common
## Retrieve Common Code List
> \## Function Description\
> \* Retrieves multiple common codes.\
> \---\
> \## Detailed Description\
> \* Retrieved based on the langCd value in the cookie.\
> \* Only codes with usage status Y are retrieved.\
> \* Retrieved in sort order.
```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/common/getGrpCdList":{"post":{"tags":["Common"],"summary":"Retrieve Common Code List","description":"## Function Description\n* Retrieves multiple common codes.\n---\n## Detailed Description\n* Retrieved based on the langCd value in the cookie.\n* Only codes with usage status Y are retrieved.\n* Retrieved in sort order.\n","operationId":"getGrpCdList","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StCdRes"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"}}},"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"}}}}}}
```
## Retrieve Prohibited Word List
> \## Function Description\
> \* Retrieves the list of prohibited words.\
> \---\
> \## Detailed Description\
> \* If langCd is not sent, it is set from the cookie value.\
> \* If usage status (useYn) is sent, records are retrieved with that usage status; if not sent, all prohibited words are retrieved.
```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/system/getBadwordList":{"get":{"tags":["Common"],"summary":"Retrieve Prohibited Word List","description":"## Function Description\n* Retrieves the list of prohibited words.\n---\n## Detailed Description\n* If langCd is not sent, it is set from the cookie value.\n* If usage status (useYn) is sent, records are retrieved with that usage status; if not sent, all prohibited words are retrieved.\n","operationId":"getBadwordList","parameters":[{"name":"badWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"}}},"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"}}}}}}
```
## Retrieve Single Common Code
> \## Function Description\
> \* Retrieves a single common code.\
> \---\
> \## Detailed Description\
> \* Retrieved based on the langCd value in the cookie.\
> \* Only codes with usage status Y are retrieved.\
> \* Retrieved in sort order.
```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/common/getGrp":{"get":{"tags":["Common"],"summary":"Retrieve Single Common Code","description":"## Function Description\n* Retrieves a single common code.\n---\n## Detailed Description\n* Retrieved based on the langCd value in the cookie.\n* Only codes with usage status Y are retrieved.\n* Retrieved in sort order.\n","operationId":"getGrp","parameters":[{"name":"stCdReq","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StCdReq"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StCdRes"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"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"}}},"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"}}}}}}
```
## Retrieve Common Code by Reference Value 1
> \## Function Description\
> \* Retrieves common codes using the group code and ref1Val.\
> \---\
> \## Detailed Description\
> \* Retrieved based on the langCd value in the cookie.\
> \* Reference Value 1 (ref1Val) and Group Code (grpCd) are required.\
> \* Only codes with usage status Y are retrieved.\
> \* Retrieved in sort order.
```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/common/getForwardCdCdNmFromStStdCdByGrpCdRef1Val":{"get":{"tags":["Common"],"summary":"Retrieve Common Code by Reference Value 1","description":"## Function Description\n* Retrieves common codes using the group code and ref1Val.\n---\n## Detailed Description\n* Retrieved based on the langCd value in the cookie.\n* Reference Value 1 (ref1Val) and Group Code (grpCd) are required.\n* Only codes with usage status Y are retrieved.\n* Retrieved in sort order.\n","operationId":"getForwardCdCdNmFromStStdCdByGrpCdRef1Val","parameters":[{"name":"params","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StCdReq"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListStCdDtlRes"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"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"}}},"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"}}}}}}}
```
## Retrieve Screen Customer Notifications
> \## Function Description\
> \* Retrieves the list of customer notifications to be displayed on the FO screen.\
> \---\
> \## Detailed Description\
> \* If siteNo (Site No.) and langCd (Language Code) are not sent, the values set in the cookie are used.\
> \* Only notifications included between the posting start date/time and posting end date/time are retrieved.\
> \* Large Category Code (scrnLgrpCd) and Medium Category Code (scrnMgrpCd) are required.
```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/common/getContsList":{"get":{"tags":["Common"],"summary":"Retrieve Screen Customer Notifications","description":"## Function Description\n* Retrieves the list of customer notifications to be displayed on the FO screen.\n---\n## Detailed Description\n* If siteNo (Site No.) and langCd (Language Code) are not sent, the values set in the cookie are used.\n* Only notifications included between the posting start date/time and posting end date/time are retrieved.\n* Large Category Code (scrnLgrpCd) and Medium Category Code (scrnMgrpCd) are required.\n","operationId":"getContsList","parameters":[{"name":"screenNotiReq","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ScreenNotiReq"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScreenNotiRes"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"ScreenNotiRes":{"type":"object","description":"Customer Notification List Response","properties":{"ntcConts":{"type":"array","description":"Customer Notification List Content","items":{"type":"string"}}}},"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"}}}}}}
```