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

# 공통

## 공통코드 목록 조회

> \## 기능설명\
> \* 공통코드를 다건으로 조회합니다.\
> \---\
> \## 상세설명\
> \* 쿠키 값의 langCd 기준으로 조회합니다.\
> \* 사용여부가 Y인 코드들만 조회합니다.\
> \* 정렬순서 순으로 조회합니다.<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/common/getGrpCdList":{"post":{"tags":["공통"],"summary":"공통코드 목록 조회","description":"## 기능설명\n* 공통코드를 다건으로 조회합니다.\n---\n## 상세설명\n* 쿠키 값의 langCd 기준으로 조회합니다.\n* 사용여부가 Y인 코드들만 조회합니다.\n* 정렬순서 순으로 조회합니다.\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":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StCdRes"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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값"}}},"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"}}}}}}
```

## 금칙어 목록 조회

> \## 기능설명\
> \* 금칙어 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* langCd를 보내지 않으면 쿠키 값으로 세팅합니다.\
> \* 사용여부(useYn)를 보낼 시 해당 사용여부로 조회하고, 보내지 않을 시 전체 금칙어를 조회합니다.<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/system/getBadwordList":{"get":{"tags":["공통"],"summary":"금칙어 목록 조회","description":"## 기능설명\n* 금칙어 목록을 조회합니다.\n---\n## 상세설명\n* langCd를 보내지 않으면 쿠키 값으로 세팅합니다.\n* 사용여부(useYn)를 보낼 시 해당 사용여부로 조회하고, 보내지 않을 시 전체 금칙어를 조회합니다.\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":"성공","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"BadWordMgmtRequest":{"type":"object","description":"금칙어 조회 Request","properties":{"siteNo":{"type":"string","description":"사이트번호"},"langCd":{"type":"string","description":"언어코드"},"useYn":{"type":"string","description":"사용여부"}}},"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"}}}}}}
```

## 공통코드 단건 조회

> \## 기능설명\
> \* 공통코드를 단건으로 조회합니다.\
> \---\
> \## 상세설명\
> \* 쿠키 값의 langCd 기준으로 조회합니다.\
> \* 사용여부가 Y인 코드들만 조회합니다.\
> \* 정렬순서 순으로 조회합니다.<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/common/getGrp":{"get":{"tags":["공통"],"summary":"공통코드 단건 조회","description":"## 기능설명\n* 공통코드를 단건으로 조회합니다.\n---\n## 상세설명\n* 쿠키 값의 langCd 기준으로 조회합니다.\n* 사용여부가 Y인 코드들만 조회합니다.\n* 정렬순서 순으로 조회합니다.\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":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StCdRes"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"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값"}}},"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"}}}}}}
```

## 공통코드 참조값1 조회

> \## 기능설명\
> \* 그룹코드와 ref1Val을 이용해 공통코드를 조회한다.\
> \---\
> \## 상세설명\
> \* 쿠키 값의 langCd 기준으로 조회합니다.\
> \* 참조1값(ref1Val)과 그룹코드(grpCd)는 필수입니다.\
> \* 사용여부가 Y인 코드들만 조회합니다.\
> \* 정렬순서 순으로 조회합니다.<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/common/getForwardCdCdNmFromStStdCdByGrpCdRef1Val":{"get":{"tags":["공통"],"summary":"공통코드 참조값1 조회","description":"## 기능설명\n* 그룹코드와 ref1Val을 이용해 공통코드를 조회한다.\n---\n## 상세설명\n* 쿠키 값의 langCd 기준으로 조회합니다.\n* 참조1값(ref1Val)과 그룹코드(grpCd)는 필수입니다.\n* 사용여부가 Y인 코드들만 조회합니다.\n* 정렬순서 순으로 조회합니다.\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":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseMapStringListStCdDtlRes"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"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"}}},"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"}}}}}}}
```

## 화면 고객알림 조회

> \## 기능설명\
> \* FO 화면에 표시될 고객알림 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* siteNo(사이트번호)와 langCd(언어코드)를 보내지 않을 시 쿠키에 세팅된 값으로 조회합니다.\
> \* 게시시작일시, 게시종료일시 사이에 포함된 알림리스트만 조회합니다.\
> \* 대분류코드(scrnLgrpCd), 중분류코드(scrnMgrpCd)는 필수입니다.<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/common/getContsList":{"get":{"tags":["공통"],"summary":"화면 고객알림 조회","description":"## 기능설명\n* FO 화면에 표시될 고객알림 목록을 조회합니다.\n---\n## 상세설명\n* siteNo(사이트번호)와 langCd(언어코드)를 보내지 않을 시 쿠키에 세팅된 값으로 조회합니다.\n* 게시시작일시, 게시종료일시 사이에 포함된 알림리스트만 조회합니다.\n* 대분류코드(scrnLgrpCd), 중분류코드(scrnMgrpCd)는 필수입니다.\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":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScreenNotiRes"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"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"]},"ScreenNotiRes":{"type":"object","description":"고객알림리스트 Response","properties":{"ntcConts":{"type":"array","description":"고객알림리스트 내용","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"}}}}}}
```