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

# Notification Box

## Retrieve Notification Box

> \## Function Description\
> \* Retrieves the member's notification box list.\
> \---\
> \## Detailed Description\
> \* Login is required.\
> \* Retrieves items in order of most recently registered.\
> \* If the parameter Member Notification Type Code (mbrNotiTypCd) is passed, retrieves only the notification box information for that notification type code.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240401\`\`\`: Added notification box read processing, added 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":["Notification Box"],"summary":"Retrieve Notification Box","description":"## Function Description\n* Retrieves the member's notification box list.\n---\n## Detailed Description\n* Login is required.\n* Retrieves items in order of most recently registered.\n* If the parameter Member Notification Type Code (mbrNotiTypCd) is passed, retrieves only the notification box information for that notification type code.\n---\n## Revision History\n* ```Release v2.00_240401```: Added notification box read processing, added RequestParam pageIdx\n","operationId":"getNotiBoxList","parameters":[{"name":"mbrNotiTypCd","in":"query","description":"Member Notification Type Code (ME051)","required":false,"schema":{"type":"string","description":"ME051 (Member Notification Type Code)\n* 01: Order\n* 02: Inquiry\n* 03: My Page\n* 04: Restock Notification\n* 05: Gift Item\n* 06: Customer Center\n* 12: Coupon\n* 13: Member\n* 14: Referrer ID Registration Notification\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":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NotiBoxResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Register Notification Box

> \## Function Description\
> \* Registers a notification box entry.\
> \---\
> \## Detailed Description\
> \* After processing logic in each module, this API is called via the notification box registration API (\*\*/api/common/v1/common/sendMessage\*\*, \*\*/api/common/1/common/sendMessageList\*\*).\
> \* If a button exists in the notification box information, the notification box button list is registered together.\
> \* Information for each notification box can be stored in the reference value.<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":["Notification Box"],"summary":"Register Notification Box","description":"## Function Description\n* Registers a notification box entry.\n---\n## Detailed Description\n* After processing logic in each module, this API is called via the notification box registration API (**/api/common/v1/common/sendMessage**, **/api/common/1/common/sendMessageList**).\n* If a button exists in the notification box information, the notification box button list is registered together.\n* Information for each notification box can be stored in the reference value.\n","operationId":"registerNotiBox","parameters":[{"name":"notiBoxRegisterRequest","in":"query","description":"Notification Box Registration Information","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":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Process Notification Box Read

> \## Function Description\
> \* Modifies the notification box read processing.\
> \---\
> \## Detailed Description\
> \* Changes the read status to Y when the notification box is read.\
> \* Login is required.<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":["Notification Box"],"summary":"Process Notification Box Read","description":"## Function Description\n* Modifies the notification box read processing.\n---\n## Detailed Description\n* Changes the read status to Y when the notification box is read.\n* Login is required.\n","operationId":"modifyNotiBox","parameters":[{"name":"notiBoxModifyRequest","in":"query","description":"Notification Box Information","required":true,"schema":{"type":"string","description":"NotiBoxModifyRequest"}},{"name":"userDetail","in":"query","description":"Member Information","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":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```