> 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/member-api/undefined.md).

# 알림함

## 알림함 조회

> \## 기능설명\
> \* 회원의 알림함 리스트를 조회합니다.\
> \---\
> \## 상세설명\
> \* 로그인은 필수입니다.\
> \* 최신 등록 순으로 조회합니다.\
> \* 파라미터로 회원알림유형코드(mbrNotiTypCd)이 넘어왔을 경우 해당 알림유형코드의 알림함 정보만 조회합니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v2.00\_240401\`\`\`: 알림함 읽음 처리 추가, RequestParam pageIdx 추가<br>

````json
{"openapi":"3.1.0","info":{"title":"X2BEE Member API","version":"v1"},"servers":[{"url":"https://api-member.x2bee.com/api/member/","description":"prd"}],"paths":{"/v1/notibox/notiInfo":{"get":{"tags":["알림함"],"summary":"알림함 조회","description":"## 기능설명\n* 회원의 알림함 리스트를 조회합니다.\n---\n## 상세설명\n* 로그인은 필수입니다.\n* 최신 등록 순으로 조회합니다.\n* 파라미터로 회원알림유형코드(mbrNotiTypCd)이 넘어왔을 경우 해당 알림유형코드의 알림함 정보만 조회합니다.\n---\n## 수정번호\n* ```Release v2.00_240401```: 알림함 읽음 처리 추가, RequestParam pageIdx 추가\n","operationId":"getNotiBoxList","parameters":[{"name":"mbrNotiTypCd","in":"query","description":"회원알림유형코드(ME051)","required":false,"schema":{"type":"string","description":"ME051(회원알림유형코드)\n* 01 : 주문\n* 02 : 문의\n* 03 : 마이페이지\n* 04 : 재입고 안내\n* 05 : 사은품\n* 06 : 고객센터\n* 12 : 쿠폰\n* 13 : 회원\n* 14 : 추천인ID 등록 안내\n","enum":["ORDER","INQUIRY","MY_PAGE","RESTOCK","GIFTS","CUSTOMER_CENTER","ETC","COUPON","MEMBER","RECOMMENDER"]}},{"name":"pageIdx","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NotiBoxResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"NotiBoxResponse":{"type":"object","description":"알림함 조회 Response","properties":{"totCnt":{"type":"integer","format":"int64","description":"알림함 조회 총 건수"},"notiList":{"type":"array","description":"알림함 목록","items":{"$ref":"#/components/schemas/NoticeInfo"}}}},"NoticeInfo":{"type":"object","description":"알림 정보","properties":{"mbrNotiDt":{"type":"string","description":"회원 알림 일자"},"notiDtlList":{"type":"array","description":"알림함 상세 목록","items":{"$ref":"#/components/schemas/NotiBoxDtlResponse"}}}},"NotiBoxDtlResponse":{"type":"object","description":"알림함 상세","properties":{"mbrNotiSeq":{"type":"string","description":"회원 알림 순번"},"mbrNotiTypCd":{"type":"string","description":"회원 알림 유형 코드(ME051)","enum":["ORDER","INQUIRY","MY_PAGE","RESTOCK","GIFTS","CUSTOMER_CENTER","ETC","COUPON","MEMBER","RECOMMENDER"]},"mbrNotiTypNm":{"type":"string","description":"회원 알림 유형명"},"mbrNotiDtm":{"type":"string","format":"date-time","description":"회원 알림 일시"},"mbrNotiTitle":{"type":"string","description":"회원 알림 제목"},"mbrNotiConts":{"type":"string","description":"회원 알림 내용"},"qryYn":{"type":"string","description":"알림 조회 여부"},"notiBtnList":{"type":"array","description":"버튼 목록","items":{"$ref":"#/components/schemas/NotiBoxBtnResponse"}}}},"NotiBoxBtnResponse":{"type":"object","description":"버튼 정보","properties":{"mbrNotiBtnSeq":{"type":"string","description":"버튼 순번"},"btnNm":{"type":"string","description":"버튼 이름"},"btnUrl":{"type":"string","description":"버튼 Url"}}},"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"}}}}}}
````

## 알림함 등록

> \## 기능설명\
> \* 알림함을 등록합니다.\
> \---\
> \## 상세설명\
> \* 각 모듈에서 처리 로직 후 알림함 등록 API(\*\*/api/common/v1/common/sendMessage\*\*, \*\*/api/common/1/common/sendMessageList\*\*)를 통해 해당 API를 호출합니다.\
> \* 알림함 정보에 버튼이 존재할 경우 알림함 버튼리스트를 함께 등록합니다.\
> \* 각 알림함에 대한 정보를 참조값에 저장할 수 있습니다.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Member API","version":"v1"},"servers":[{"url":"https://api-member.x2bee.com/api/member/","description":"prd"}],"paths":{"/v1/notibox/notiInfo":{"post":{"tags":["알림함"],"summary":"알림함 등록","description":"## 기능설명\n* 알림함을 등록합니다.\n---\n## 상세설명\n* 각 모듈에서 처리 로직 후 알림함 등록 API(**/api/common/v1/common/sendMessage**, **/api/common/1/common/sendMessageList**)를 통해 해당 API를 호출합니다.\n* 알림함 정보에 버튼이 존재할 경우 알림함 버튼리스트를 함께 등록합니다.\n* 각 알림함에 대한 정보를 참조값에 저장할 수 있습니다.\n","operationId":"registerNotiBox","parameters":[{"name":"notiBoxRegisterRequest","in":"query","description":"알림함 등록 정보","required":true,"schema":{"type":"string","description":"NotiBoxRegisterRequest"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotiBoxRegisterRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"NotiBoxRegisterRequest":{"type":"object","description":"알림함 등록 Request","properties":{"mbrNo":{"type":"string","description":"회원번호"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드","enum":["ORDER","INQUIRY","MY_PAGE","RESTOCK","GIFTS","CUSTOMER_CENTER","ETC","COUPON","MEMBER","RECOMMENDER"]},"mbrNotiTitle":{"type":"string","description":"알림함 제목"},"mbrNotiConts":{"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"},"btnList":{"type":"array","description":"버튼리스트","items":{"$ref":"#/components/schemas/EtMbrNotiBtnInfo"}}},"required":["mbrNo","mbrNotiConts","mbrNotiTitle","mbrNotiTypCd"]},"EtMbrNotiBtnInfo":{"type":"object","description":"회원알림 버튼정보","properties":{"mbrNotiSeq":{"type":"string","description":"회원알림순번"},"mbrNotiBtnSeq":{"type":"string","description":"회원알림버튼순번"},"btnNm":{"type":"string","description":"버튼명"},"btnUrl":{"type":"string","description":"버튼Url"}}},"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"}}}}}}
```

## 알림함 읽음처리

> \## 기능설명\
> \* 알림함 읽음처리를 수정합니다.\
> \---\
> \## 상세설명\
> \* 알림함을 읽었을 때 조회여부를 Y로 수정합니다.\
> \* 로그인은 필수입니다.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Member API","version":"v1"},"servers":[{"url":"https://api-member.x2bee.com/api/member/","description":"prd"}],"paths":{"/v1/notibox/notiInfo":{"put":{"tags":["알림함"],"summary":"알림함 읽음처리","description":"## 기능설명\n* 알림함 읽음처리를 수정합니다.\n---\n## 상세설명\n* 알림함을 읽었을 때 조회여부를 Y로 수정합니다.\n* 로그인은 필수입니다.\n","operationId":"modifyNotiBox","parameters":[{"name":"notiBoxModifyRequest","in":"query","description":"알림함 정보","required":true,"schema":{"type":"string","description":"NotiBoxModifyRequest"}},{"name":"userDetail","in":"query","description":"회원 정보","required":true,"schema":{"type":"string","description":"UserDetail"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotiBoxModifyRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"NotiBoxModifyRequest":{"type":"object","description":"알림함 수정 Request","properties":{"mbrNotiSeq":{"type":"string","description":"회원 알림 순번"},"qryYn":{"type":"string","description":"알림 조회여부","enum":["Y","N"]}}},"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"}}}}}}
```