> 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/display/planned-exhibition.md).

# Planned Exhibition

The Planned Exhibition management page API provides the information needed to compose the planned exhibition list and planned exhibition detail information on the Front screen, based on the registered site (`siteNo`), mall (`mallNo`), and planned exhibition number (`mkdpNo`). This API includes a variety of information, and is designed to minimize data traffic and optimize the customer experience by applying caching to external content (images, planned exhibition detail HTML).

***

## Key Features

* **Planned exhibition list page**
  * Retrieves planned exhibition information according to the selected sort criteria — most recent or closing soonest.
  * An ongoing planned exhibition has a status of "In Progress," and today's date must fall within the display period. (If the period has ended, it is exposed in the "Past Planned Exhibition List.")
  * A planned exhibition group is exposed in the group list only if its usage status is "Y" and today's date falls within the group's display period.
  * Planned exhibition brands are exposed in the brand list by retrieving the brands registered to the planned exhibition.
  * Exposure of the planned exhibition is restricted according to the display member grade and employee status.
* **Planned exhibition detail page**
  * Composes the planned exhibition detail page according to the planned exhibition template.
  * Planned exhibition divider information is exposed according to display order.
  * The product sort code can be used to control the display order of products.
  * Exposure of the planned exhibition is restricted according to the display member grade and employee status.
* **Planned exhibition permission check**
  * Exposure of the planned exhibition can be restricted according to the display member grade and employee status.
  * The permission check is performed on an AND basis; if both the display member grade (GREEN) and employee-only are checked, the planned exhibition is exposed only to members who are both "employee" and "GREEN."
  * If neither the display member grade nor employee-only is checked, the exhibition is exposed to all users, including non-members.

## Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FkfchZ1tcLs5BjjpnoJGj%2F183631977.jpg?alt=media&#x26;token=c3979b72-5fe8-4fec-abd9-d42958673c8e" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Planned exhibition list lookup

* Ongoing planned exhibition: when today's date falls within the display period.
* Past planned exhibition: when the display period date has passed.
* Controls planned exhibition exposure according to the display member grade and employee status.
  {% endstep %}

{% step %}

### Planned exhibition detail lookup

* If a planned exhibition that is not ongoing is accessed for detail, a "Page Not Found" screen is displayed.
* If accessed while not logged in for a display-member-grade or employee-only planned exhibition, an alert "You can check this after logging in." is displayed.
* If accessed while logged in and the member does not meet the display member grade or employee status requirement for the planned exhibition, an alert "You cannot access this page. (Accessible only to specific customers)" is displayed.
* If accessed while not logged in and a coupon banner is clicked, an alert "You can receive the coupon after logging in." is displayed.
* Retrieves the latest 10 planned exhibitions.
  {% endstep %}

{% step %}

### Planned exhibition exposure restriction

* Restricts planned exhibition exposure according to display member grade and employee status.
  * The permission check criteria are display member grade and employee status, combined with AND.
  * A planned exhibition that does not have display member grade or employee-only checked is exposed to all users, including non-members.
    {% endstep %}
    {% endstepper %}

## API Function List

<table><thead><tr><th width="111.6666259765625">API</th><th width="307">Description</th><th width="88">Server</th><th width="77.333251953125">Method</th><th>Text</th></tr></thead><tbody><tr><td>Planned exhibition lookup</td><td><p>•Retrieves planned exhibition information on the planned exhibition list page, based on site and mall.</p><p>•Retrieves planned exhibition information based on brand, sort type (most recent, closing soonest), and progress status.</p></td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EA%B8%B0%ED%9A%8D%EC%A0%84&#x26;path=getPlanList">🔗View API></a></td></tr><tr><td>Planned exhibition brand lookup</td><td>•Retrieves brand information on the planned exhibition list page, based on site and mall.</td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EA%B8%B0%ED%9A%8D%EC%A0%84&#x26;path=getPlanBrandList">🔗View API></a><br>Brand information lookup:<br>/api/goods/v1/brands/list</td></tr><tr><td>Planned exhibition group list lookup</td><td><p>•Retrieves group information on the planned exhibition list page, based on site and mall.</p><p>•Retrieves information whose usage status is Y and that falls within the display period as of the current date.</p></td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EA%B8%B0%ED%9A%8D%EC%A0%84&#x26;path=getPlanGroupList">🔗View API></a></td></tr><tr><td>Planned exhibition detail lookup</td><td><p>•An API that retrieves detail information, the latest planned exhibition information, divider information, and the corresponding product information by planned exhibition number.</p><p>•The planned exhibition dividers and the products for each divider are exposed in the configured display order.</p></td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EA%B8%B0%ED%9A%8D%EC%A0%84&#x26;path=getPlanDetailInfo">🔗View API></a></td></tr><tr><td>Planned exhibition products by divider lookup</td><td><p>•Retrieves the product information for a divider using the planned exhibition number and divider number.</p><p>•Exposes products according to the product sort type (newest, best-selling, highest price, lowest price, most reviewed).</p></td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EA%B8%B0%ED%9A%8D%EC%A0%84&#x26;path=getPlanGoodsInfo">🔗View API></a></td></tr><tr><td>Planned exhibition lookup (wishlist)</td><td>•Receives the planned exhibition number as a parameter and provides the corresponding planned exhibition information.<br>*An API that provides planned exhibition information for the wishlist</td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EA%B8%B0%ED%9A%8D%EC%A0%84&#x26;path=getPlanList_1">🔗View API></a></td></tr></tbody></table>

## Terminology

<table><thead><tr><th width="154">Term</th><th>Description</th></tr></thead><tbody><tr><td>Display period</td><td>Refers to the period during which a planned exhibition is displayed in the planned exhibition list. A planned exhibition whose display period has ended cannot be accessed for detail.</td></tr><tr><td>Template</td><td>The planned exhibition detail page is composed according to the planned exhibition template. There are currently 4 templates (Planned Exhibition Template 1, 2, 3, 4).</td></tr><tr><td>Member grade</td><td>Restricts planned exhibition exposure according to member grade.<br>Member grades: GREEN, FAMILY, GOLD, VIP, VVIP</td></tr><tr><td>Employee-only</td><td>Restricts planned exhibition exposure according to whether the employee-only setting applies.</td></tr><tr><td>Planned exhibition divider</td><td>A term referring to the dividing sections on the planned exhibition detail page. Each planned exhibition divider includes divider information, a coupon banner, and a product list.</td></tr></tbody></table>

## Other Notes

* If the Planned Exhibition Lookup API is called with planned exhibition numbers in the parameters, it retrieves the information corresponding to those planned exhibition numbers.\
  Example: <https://beta-venus-api-display.x2bee.com/api/display/v1/plan/planWishList?dispMediaCd=20\\&mkdpNoList=14862,14952\\&pageNo=1\\&pageSize=20\\>
  Calling this API retrieves the planned exhibition information for planned exhibition numbers 14862 and 14952.