Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notification Box

Retrieve Notification Box

get

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

Query parameters
mbrNotiTypCdstring · enumOptional

ME051 (Member Notification Type Code)

  • 01: Order
  • 02: Inquiry
  • 03: My Page
  • 04: Restock Notification
  • 05: Gift Item
  • 06: Customer Center
  • 12: Coupon
  • 13: Member
  • 14: Referrer ID Registration Notification
Example: 01Possible values:
pageIdxinteger · int32Optional
Header parameters
AuthorizationanyOptional

Access Token

Responses
200

Success

*/*
anyOptional
get/v1/notibox/notiInfo
GET /api/member/v1/notibox/notiInfo HTTP/1.1
Host: api-member.x2bee.com/
Accept: */*

No content

Register Notification Box

post

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.

Query parameters
notiBoxRegisterRequeststringRequired

NotiBoxRegisterRequest

Header parameters
AuthorizationanyOptional

Access Token

Body
anyOptional
Responses
200

Success

No content
post/v1/notibox/notiInfo
POST /api/member/v1/notibox/notiInfo?notiBoxRegisterRequest=text HTTP/1.1
Host: api-member.x2bee.com/
Content-Type: application/json
Accept: */*

No content

Process Notification Box Read

put

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.

Query parameters
notiBoxModifyRequeststringRequired

NotiBoxModifyRequest

userDetailstringRequired

UserDetail

Header parameters
AuthorizationanyOptional

Access Token

Body
anyOptional
Responses
200

Success

No content
put/v1/notibox/notiInfo
PUT /api/member/v1/notibox/notiInfo?notiBoxModifyRequest=text&userDetail=text HTTP/1.1
Host: api-member.x2bee.com/
Content-Type: application/json
Accept: */*

No content
PreviousMember API
NextMember Management

Last updated