> 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/event-api/event-common.md).

# Event Common

## Process Member Default Delivery Address Merge

>  \## Function Description\
>  \* This API merges the member's default delivery address.\
>  \---\
>  \## Detailed Description\
>  \* Synchronizes the member's delivery address information in the order DB with the member's delivery address information in the event DB.\
>  \* Requires all parameters for the member delivery address information columns.\
> &#x20;\* Called from API-BO, API-MEMBER, and event BATCH.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Event API","version":"v1"},"servers":[{"url":"https://api-event.x2bee.com/api/event/","description":"prd"}],"paths":{"/v1/common/mergeMbrDlvp":{"post":{"tags":["Event Common"],"summary":"Process Member Default Delivery Address Merge","description":" ## Function Description\n * This API merges the member's default delivery address.\n ---\n ## Detailed Description\n * Synchronizes the member's delivery address information in the order DB with the member's delivery address information in the event DB.\n * Requires all parameters for the member delivery address information columns.\n * Called from API-BO, API-MEMBER, and event BATCH.\n","operationId":"mergeMbrDlvp","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtMbrDlvpInfoRequest"}}},"required":true},"responses":{"200":{"description":"Member default delivery address merged successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Failed to merge member default delivery address","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"EtMbrDlvpInfoRequest":{"type":"object","description":"Member Delivery Information Request","properties":{"mbrNo":{"type":"string","description":"Member No."},"etMbrDlvpInfo":{"type":"array","description":"Member Delivery Information List","items":{"$ref":"#/components/schemas/EtMbrDlvpInfo"}}}},"EtMbrDlvpInfo":{"type":"object","description":"Member Delivery Information","properties":{"mbrNo":{"type":"string","description":"Member No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"dlvpGbCd":{"type":"string","description":"Delivery Address Type Code (ME044)"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"zipNoSeq":{"type":"integer","format":"int32","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsg":{"type":"string","description":"Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"useYn":{"type":"string","description":"Usage Status"},"userSortSeq":{"type":"integer","format":"int32","description":"User Sort Order"},"emailAddr":{"type":"string","description":"Email"}}},"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"}}}}}}
```

## Process Member Basic Information Merge

> &#x20;\## Function Description\
> &#x20;\* This API synchronizes member information.\
> &#x20;\---\
> &#x20;\## Detailed Description\
> &#x20;\* Synchronizes the member information in the order DB with the member information in the event DB.\
> &#x20;\* Requires all parameters for the member information columns.\
> &#x20;\* Called from api-member and event batch.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Event API","version":"v1"},"servers":[{"url":"https://api-event.x2bee.com/api/event/","description":"prd"}],"paths":{"/v1/common/mergeMbrBase":{"post":{"tags":["Event Common"],"summary":"Process Member Basic Information Merge","description":" ## Function Description\n * This API synchronizes member information.\n ---\n ## Detailed Description\n * Synchronizes the member information in the order DB with the member information in the event DB.\n * Requires all parameters for the member information columns.\n * Called from api-member and event batch.\n","operationId":"mergeMbrBase","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtMbrBaseRequest"}}},"required":true},"responses":{"200":{"description":"Member basic information merged successfully","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Failed to merge member basic information","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"EtMbrBaseRequest":{"type":"object","description":"Member Information Request","properties":{"etMbrBase":{"$ref":"#/components/schemas/EtMbrBase","description":"Member Information"}}},"EtMbrBase":{"type":"object","description":"Member Information","properties":{"siteNo":{"type":"string","description":"Registered Site No."},"sysRegDtm":{"type":"string","format":"date-time","description":"Registration Date/Time"},"sysRegId":{"type":"string","description":"Registrant ID"},"sysModDtm":{"type":"string","format":"date-time","description":"Modification Date/Time"},"sysModId":{"type":"string","description":"Modifier ID"},"mbrNo":{"type":"string","description":"Member No."},"mbrGbCd":{"type":"string","description":"Member Type Code (ME001 - 10: Regular Member, 99: Non-Member)"},"mbrMgrCd":{"type":"string","description":"Member Management Code (ME002 - 10: Integrated Member, 20: General Member, 30: Social Member, 99: Non-Member)"},"mbrStatCd":{"type":"string","description":"Member Status Code (ME003 - 10: Active Member, 20: Dormant Member, 30: Withdrawn Member)"},"lgcMbrNo":{"type":"string","description":"Core System Member No."},"lgcMbrYn":{"type":"string","description":"Core System Member Status"},"lgcWdraTgtYn":{"type":"string","description":"Core System Withdrawal Target Status"},"cmbnMbspMbrNo":{"type":"string","description":"Integrated Membership Member No."},"mbrNm":{"type":"string","description":"Member Name"},"loginId":{"type":"string","description":"Login ID"},"pwd":{"type":"string","description":"Password"},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008 - 10: GREEN, 20: FAMILY, 30: GOLD, 40: VIP, 50: VVIP)"},"solarYn":{"type":"string","description":"Solar Calendar Status"},"brth":{"type":"string","description":"Date of Birth"},"sexGbCd":{"type":"string","description":"Gender Type Code (ME017 - M: Male, F: Female)"},"nafrGbCd":{"type":"string","description":"Domestic/Foreign National Type Code (ME018 - 10: Domestic, 20: Foreign)"},"joinGbCd":{"type":"string","description":"Registration Type Code (ME029)"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"frgnTelNo":{"type":"string","description":"International Phone Number"},"emailAddr":{"type":"string","description":"Email Address"},"zipNoSeq":{"type":"integer","format":"int32","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"stafYn":{"type":"string","description":"Employee Status"},"empNo":{"type":"string","description":"Employee No."},"comGbCd":{"type":"string","description":"Company Classification Code (ME038)"},"adlCertiYn":{"type":"string","description":"Adult Verification Status"},"adlCertiDtm":{"type":"string","format":"date-time","description":"Adult Verification Date/Time"},"mbrJoinDtm":{"type":"string","format":"date-time","description":"Membership Registration Date/Time"},"frstOrdDtm":{"type":"string","format":"date-time","description":"First Order Date/Time"},"lstOrdDtm":{"type":"string","format":"date-time","description":"Last Order Date/Time"},"frstLoginDtm":{"type":"string","format":"date-time","description":"First Login Date/Time"},"lstLoginDtm":{"type":"string","format":"date-time","description":"Last Login Date/Time"},"pgGbCd":{"type":"string","description":"PG Classification Code (OM030)"},"rcntPayWayCd":{"type":"string","description":"Recent Payment Method Code (OM013)"},"stafMgrNo":{"type":"string","description":"Employee Management No."},"stafRegDt":{"type":"string","description":"Employee Registration Date"},"stafRvcDt":{"type":"string","description":"Employee Deregistration Date"},"cmbnMbspLoginId":{"type":"string","description":"Integrated Membership Login ID"},"payNo":{"type":"string","description":"Payment Number"},"smpctAcctIntrlckGbCd":{"type":"string","description":"Simple Account Linking Classification Code (ME052)"},"bmanRegNo":{"type":"string","description":"Business Registration No."},"bmanRegDt":{"type":"string","description":"Business Registration Date"},"rpstmnNm":{"type":"string","description":"Representative Name"},"repTelSctNo":{"type":"string","description":"Main Phone Area Code"},"repTelTxnoNo":{"type":"string","description":"Main Phone Exchange Code"},"repTelEndNo":{"type":"string","description":"Main Phone Last Digits"},"joinSgtStatCd":{"type":"string","description":"Sign-Up Approval Status Code (ME058)"},"aprvRtrnCaus":{"type":"string","description":"Approval Rejection Reason"},"aprvRtrnDtm":{"type":"string","format":"date-time","description":"Processing Date/Time"},"mbrJoinReqDtm":{"type":"string","format":"date-time","description":"Join Request Date"},"bmanNm":{"type":"string","description":"Business Name"},"sysProcId":{"type":"string","description":"Processor"},"bplcZipNo":{"type":"string","description":"Business Registration Certificate Postal Code"},"bplcZipAddr":{"type":"string","description":"Business Registration Certificate Postal Address"},"bplcDtlAddr":{"type":"string","description":"Business Registration Certificate Detailed Address"}}},"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 My Participated Event List (BO)

> \## Function Description\
> \* This is the basic API for retrieving my participated event list (BO).\
> \---\
> \## Detailed Description\
> \* Login is required.\
> \* Ongoing participated events + ended participated events (up to 7 days after entry) + ended gift events (up to 7 days after entry)\
> \* \*\*Member number (mbrNo)\*\* is required.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Event API","version":"v1"},"servers":[{"url":"https://api-event.x2bee.com/api/event/","description":"prd"}],"paths":{"/v1/marketing/getParticipationEvent":{"get":{"tags":["Event Common"],"summary":"Retrieve My Participated Event List (BO)","description":"## Function Description\n* This is the basic API for retrieving my participated event list (BO).\n---\n## Detailed Description\n* Login is required.\n* Ongoing participated events + ended participated events (up to 7 days after entry) + ended gift events (up to 7 days after entry)\n* **Member number (mbrNo)** is required.\n","operationId":"getParticipationEvent","parameters":[{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string","description":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string","description":"string"}},{"name":"mbrNo","in":"query","description":"Member No.","required":true,"schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"My participated event list retrieved successfully (BO)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ParticipationEventResponse"}}}},"900":{"description":"Failed to retrieve my participated event list (BO)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"ParticipationEventResponse":{"type":"object","properties":{"evtNo":{"type":"string","description":"Event No."},"evtNm":{"type":"string","description":"Event Name"},"aplyDt":{"type":"string","description":"Entry Date"},"strDt":{"type":"string","description":"Event Start Date"},"endDt":{"type":"string","description":"Event End Date"},"evtPrgsStatCd":{"type":"string","description":"Management Status (EV005)"},"evtPrgsStatNm":{"type":"string","description":"In Progress Status Name"},"winDt":{"type":"string","description":"Winning Date"},"winYn":{"type":"string","description":"Winning 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 My Participated Event Count

> \## Function Description\
> \* This is the basic API for retrieving the count of my participated events (BO).\
> \---\
> \## Detailed Description\
> \* Login is required.\
> \* Ongoing participated events + ended participated events (up to 7 days after entry) + ended gift events (up to 7 days after entry)\
> \* \*\*Member number (mbrNo)\*\* is required.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Event API","version":"v1"},"servers":[{"url":"https://api-event.x2bee.com/api/event/","description":"prd"}],"paths":{"/v1/marketing/getParticipationEventCount":{"get":{"tags":["Event Common"],"summary":"Retrieve My Participated Event Count","description":"## Function Description\n* This is the basic API for retrieving the count of my participated events (BO).\n---\n## Detailed Description\n* Login is required.\n* Ongoing participated events + ended participated events (up to 7 days after entry) + ended gift events (up to 7 days after entry)\n* **Member number (mbrNo)** is required.\n","operationId":"getParticipationEventCount","parameters":[{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string","description":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string","description":"string"}},{"name":"mbrNo","in":"query","description":"Member No.","required":true,"schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"My participated event count retrieved successfully (BO)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ParticipationEventResponse"}}}},"900":{"description":"Failed to retrieve my participated event count (BO)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"ParticipationEventResponse":{"type":"object","properties":{"evtNo":{"type":"string","description":"Event No."},"evtNm":{"type":"string","description":"Event Name"},"aplyDt":{"type":"string","description":"Entry Date"},"strDt":{"type":"string","description":"Event Start Date"},"endDt":{"type":"string","description":"Event End Date"},"evtPrgsStatCd":{"type":"string","description":"Management Status (EV005)"},"evtPrgsStatNm":{"type":"string","description":"In Progress Status Name"},"winDt":{"type":"string","description":"Winning Date"},"winYn":{"type":"string","description":"Winning 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 Event Member Default Delivery Address

> \## Function Description\
> \* This is the basic API for retrieving the member's default delivery address from the event DB.\
> \---\
> \## Detailed Description\
> \* Retrieves the default delivery address using the member number as a parameter.\
> \* Retrieves the member's default delivery address (EVENT DB)\
> \* \*\*Member number (mbrNo)\*\* is required.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE Event API","version":"v1"},"servers":[{"url":"https://api-event.x2bee.com/api/event/","description":"prd"}],"paths":{"/v1/marketing/getEtMbrDlvpInfo":{"get":{"tags":["Event Common"],"summary":"Retrieve Event Member Default Delivery Address","description":"## Function Description\n* This is the basic API for retrieving the member's default delivery address from the event DB.\n---\n## Detailed Description\n* Retrieves the default delivery address using the member number as a parameter.\n* Retrieves the member's default delivery address (EVENT DB)\n* **Member number (mbrNo)** is required.\n","operationId":"getMbrDlvpInfo","parameters":[{"name":"mbrNo","in":"query","description":"Member No.","required":true,"schema":{"type":"string","description":"string"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Member default delivery address retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EtMbrDlvpInfo"}}}},"900":{"description":"Failed to retrieve member default delivery address","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"EtMbrDlvpInfo":{"type":"object","description":"Member Delivery Information","properties":{"mbrNo":{"type":"string","description":"Member No."},"mbrDlvpSeq":{"type":"string","description":"Member Delivery Address Sequence No."},"dlvpGbCd":{"type":"string","description":"Delivery Address Type Code (ME044)"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"rcvmnNm":{"type":"string","description":"Recipient Name"},"baseDlvpYn":{"type":"string","description":"Default Delivery Address Status"},"zipNoSeq":{"type":"integer","format":"int32","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"cellSctNo":{"type":"string","description":"Mobile Phone Prefix Code"},"cellTxnoNo":{"type":"string","description":"Mobile Phone Exchange Code"},"cellEndNo":{"type":"string","description":"Mobile Phone Last Digits"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"},"deliMsgCd":{"type":"string","description":"Delivery Message Code (ME039)"},"deliMsg":{"type":"string","description":"Delivery Message"},"comnFrdrCogoMethodCd":{"type":"string","description":"Common Entrance Access Method Code (ME040)"},"comnFrdrEtcMethod":{"type":"string","description":"Other Common Entrance Access Method"},"comnFrdrPwd":{"type":"string","description":"Common Entrance Password"},"useYn":{"type":"string","description":"Usage Status"},"userSortSeq":{"type":"integer","format":"int32","description":"User Sort Order"},"emailAddr":{"type":"string","description":"Email"}}},"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"}}}}}}
```