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

# Display Category

Based on the whole or on a brand number (`brandNo`), this provides the information needed to compose the display category on the Front screen. It is managed hierarchically by depth in the form of Large/Medium/Small/Detail categories, and provides the basic information and hierarchical structure of display categories. This API is exposed in the GNB category area and category stores, and may also be exposed in the header area.

***

## Key Features

* **Display category list lookup**
  * Retrieves the entire display category information or the display category information for a specific brand.
  * Retrieves only the information of categories whose usage status is "In Use."
  * Provides data in a hierarchical form in which a parent category includes a list of child categories.
  * Entire display category information: retrieves the entire display category information.
  * Brand display category information: when queried by brand number, retrieves the display category information to which that brand's products belong.
* **Display category product lookup**
  * When queried by display category number, explores the child categories and retrieves the list of product detail information for the lowest-level category.
  * When queried by product number, retrieves the list of detail information for that product.
  * Passes the page number and page size to retrieve counts according to the page number and size, and returns the total count together.
* **Single display category information**
  * Retrieves the information of the corresponding display category by display category number.
  * Rather than passing child category information hierarchically, it retrieves only the information for the given display category number.
* **Display icon list lookup**
  * Retrieves the list of display icons based on the site number.
  * Retrieves only icon information whose usage status is "In Use."

## Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FwKNmjFEAtp1ctGFgrAgm%2F183795744.jpg?alt=media&#x26;token=53a6af66-d1fb-40f8-b539-95df406f6929" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Display icon list lookup

Retrieves the display category.

* When retrieving all display categories: retrieves all display categories in use and exposes them in the GNB or the category menu at the top of the store.
* Brand category lookup: when entering a brand store, retrieves only the categories to which that brand's products belong.
  {% endstep %}

{% step %}

### Display product lookup

Retrieves the display products.

* Exposes only products that are for sale or sold out, in "display" status, within the sales period.
* Adult status: checks the member's adult status to restrict exposure of age-restricted (19+) products.
  {% endstep %}

{% step %}

### Display icon list lookup (image mapping)

Retrieves the display icon list.

* Stores the display icon image information in the screen store as key (icon number), value (icon image information) pairs, and retrieves images by matching the icon number key with the icon number on the product.
  {% endstep %}
  {% endstepper %}

## API Function List

<table data-full-width="false"><thead><tr><th width="129.333251953125">API</th><th width="288.888916015625">Description</th><th width="81.2222900390625">Server</th><th width="79.333251953125">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Display category list lookup</td><td>•Retrieves the entire display category information or the brand display category information (when a brand number is passed) hierarchically as Large/Medium/Small/Detail.</td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EC%A0%84%EC%8B%9C%EC%B9%B4%ED%85%8C%EA%B3%A0%EB%A6%AC&#x26;path=getCategoryList">🔗View API></a></td></tr><tr><td>Display category single lookup</td><td><p>•Retrieves only the corresponding display category information, given a display category number.</p><p>•Retrieves only the given category's information, non-hierarchically.</p></td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EC%A0%84%EC%8B%9C%EC%B9%B4%ED%85%8C%EA%B3%A0%EB%A6%AC&#x26;path=getDisplayCategory">🔗View API></a></td></tr><tr><td>Display product lookup</td><td>•When a display category number is passed, retrieves the list of detail information for the products in that display category.<br>•When a product number is passed, retrieves the list of detail information for that product.<br>•When a page number and page size are passed, also retrieves the total count.</td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EC%A0%84%EC%8B%9C%EC%B9%B4%ED%85%8C%EA%B3%A0%EB%A6%AC&#x26;path=getGoodsList">🔗View API></a></td></tr><tr><td>Display icon list lookup</td><td>•Retrieves the list of display icon information based on the site number.</td><td>Display</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=display&#x26;depth=%EC%A0%84%EC%8B%9C%EC%B9%B4%ED%85%8C%EA%B3%A0%EB%A6%AC&#x26;path=getIconList">🔗View API></a></td></tr></tbody></table>

## Terminology

<table><thead><tr><th width="130.6666259765625">Term</th><th>Description</th></tr></thead><tbody><tr><td>Display category</td><td><p>Refers to the entity that is managed and displayed according to a specific classification under the site and mall in the display hierarchy structure.</p><p>It consists of Large/Medium/Small/Detail levels in order, and is connected hierarchically using the parent category number.</p></td></tr><tr><td>Depth</td><td>The unit of hierarchical depth for display categories. Large/Medium/Small/Detail are represented by numbers 1 through 4.<br>Ex) Large category: 1, Detail category: 4</td></tr><tr><td>Lowest-level flag</td><td>A display category classification value indicating that no child category exists and that the category holds display products.<br>If it is the lowest-level category, display products can be added to that category.<br>If it is not the lowest-level category, it has child categories.</td></tr></tbody></table>

## Other Notes

* Icon policy
  * Icons are displayed in the order of BEST, NEW, and BO-configured icons.
  * The number of icons shown on screen is limited to a maximum of 3.
  * The exposure scope of icons can be set to products, boards, events, and cart.
  * BEST: displayed based on ranking data for the current day or (current day + previous day).
  * NEW: displayed based on the 14 days since the product registration date.