> 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-guide/api-guides-en/store-front/member/my-page.md).

# My Page

Provides a feature for logged-in members to efficiently view a variety of information about the shopping mall. Members can easily check their purchase performance over the past 6 months, grade information, employee status, available benefits, order/delivery status, and activity status on My Page.

***

## Key Features

* **Get Member Basic Information**
  * Retrieves the member's own member number, member name, and employee status.
* **Get Benefit and Purchase Information**
  * Members can check their mileage balance and the number of promotion coupons they hold.
  * Retrieves the member's grade and calculates it based on purchase performance over the past 6 months.
* **Get Activity and Inquiry Status**
  * Retrieves the number of event participation records, product Q\&A entries, and 1:1 inquiries.
* **Get Menu and Favorites**
  * Retrieves the full menu list and the list of menus registered as favorites.
* **Get Employee Discount Information**
  * For employees, retrieves the discount limit and remaining balance.
* **Get Grade Renewal Information**
  * Retrieves the current grade and all grade information for grade renewal.
* **Get Purchase Amount by Period**
  * Checks the purchase amount required for grade renewal by retrieving purchase performance over the past 6 months.

## Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FZt3EaduY4La5oOS9GS8K%2F%E1%84%86%E1%85%A1%E1%84%8B%E1%85%B5%E1%84%91%E1%85%A6%E1%84%8B%E1%85%B5%E1%84%8C%E1%85%B5.png?alt=media&#x26;token=c5a6d9d5-525f-4218-976e-4cd458e05cdc" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### My Page

When a member accesses My Page, if the member is logged in their information is displayed; if not logged in, they are redirected to the login page.
{% endstep %}

{% step %}

### Get My Page Main Information

Retrieves the main information for the member's My Page.

* Basic information, all/favorite menus: Retrieves the member number, employee status, and member name corresponding to basic information from the member database, along with the full menu list and favorites menu list.
* Available benefits: Retrieves mileage from the member database and coupon count from the Promotion API.
* Activity status: Retrieves event participation from the Event API, product Q\&A from the Product API, and 1:1 customer service inquiry count from the Order API.
  {% endstep %}

{% step %}

### Get Member's Next Grade

Retrieves the member's grade information. The member's grade is calculated monthly based on purchase performance over the past 6 months.

* Retrieves the grade information registered in the member database along with the current member grade.
* Retrieves purchase performance over the past 6 months from the Order API to calculate the member's next higher grade.
  {% endstep %}

{% step %}

### Get Employee Discount Limit

If the member is registered as an employee, retrieves the discount limit and remaining balance based on the discount limit registered by the corresponding company. The discount limit resets every year.
{% endstep %}
{% endstepper %}

## API Function List

<table><thead><tr><th width="107.888916015625">API</th><th width="347.7779541015625">Description</th><th width="92.4444580078125">Server</th><th width="90.2222900390625">Method</th><th>Remarks</th></tr></thead><tbody><tr><td>Get My Page<br>Main Information</td><td>Retrieves the member's available benefits, activity status, favorites list, and full menu list.<br><br>Get coupon issuance list:<br>v1/marketing/cpnIssuList<br>Get my event participation count:<br>v1/marketing/getParticipationEventCount<br>Get product Q&#x26;A count by member: v1/qna/getUserQnaCount<br>Get 1:1 inquiry count: v1/customerservice/getInquiryCount</td><td>Member</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=member&#x26;depth=%EB%A7%88%EC%9D%B4%ED%8E%98%EC%9D%B4%EC%A7%80&#x26;path=myPageMain">🔗View API ></a></td></tr><tr><td>Get Member's Next Grade</td><td>Looks up the grade information table using the purchase amount from the past 6 months to retrieve the current grade and the next higher grade.</td><td>Member</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=member&#x26;depth=%EB%A7%88%EC%9D%B4%ED%8E%98%EC%9D%B4%EC%A7%80&#x26;path=getHighGradeInfo">🔗View API ></a><br>Get purchase amount by period: v1/member/getOrdTotAmt</td></tr><tr><td>Get<br>Employee Discount Limit</td><td>Retrieves the employee discount limit amount and the remaining balance after usage on orders.</td><td>Member</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=member&#x26;depth=%EB%A7%88%EC%9D%B4%ED%8E%98%EC%9D%B4%EC%A7%80&#x26;path=getHighGradeInfo">🔗View API ></a></td></tr><tr><td>Get Order/Delivery Claim<br>Count</td><td>Retrieves the order/claim count from the Order module upon entering My Page.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%ED%9A%8C%EC%9B%90%EC%A0%9C%EA%B3%B5&#x26;path=getMemberOrderClaimCnt">🔗View API ></a></td></tr></tbody></table>

## Definition of Terms

<table><thead><tr><th width="141.77783203125">Term</th><th>Description</th><th data-hidden></th></tr></thead><tbody><tr><td>Member Grade</td><td>Grades range from GREEN (default) up to VVIP, and are calculated monthly based on purchase performance over the past 6 months. Higher grades receive more benefits.</td><td></td></tr><tr><td>Employee Discount Limit</td><td>If a member is registered as an employee of the corresponding company, they can receive discount benefits up to the limit set by the company. The employee discount limit resets on January 1 every year.</td><td></td></tr></tbody></table>

## Other Notes

**Grade Criteria**

* Grade calculation is processed monthly by a grade calculation batch, which sums each member's purchase amount over the past 6 months.
* The order amount criteria are based on the amount in the reference 2 value of the common code: Member Grade Code (ME008).

| Grade  | Purchase Performance |
| ------ | -------------------- |
| GREEN  | 0 (New)              |
| FAMILY | 50,000 or more       |
| GOLD   | 200,000 or more      |
| VIP    | 300,000 or more      |
| VVIP   | 500,000 or more      |

**Grade Calculation**

e.g. December 2023 grade \\

* If purchase performance from 2023.06.01 to 2023.11.30 is 300,000 KRW, the member's grade is 'GOLD'.

**Order Status**

* If there is no order/delivery claim count data, or if all values are 0, the order status data will not be displayed.
* If an API call results in an error, the count is treated as 0 and the order status is not displayed.

##
