> 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-api/product-and-search-pages/search.md).

# Search

Provides information about the APIs used to implement the online commerce search feature.

Helps customers search for products/events/special promotions and quickly explore information during their purchase journey.

{% columns %}
{% column %}

<p align="center"><strong>PC</strong></p>

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FPfGdyfaOtNoASVSQJxqL%2Fimage-20240416-045711.png?alt=media&#x26;token=71e1df3c-69e5-440b-a42f-b553b1750b7c" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<p align="center"><strong>Mobile</strong></p>

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FO8CpMd2ZCWmD5DPcx5KW%2Fimage-20240416-045703.png?alt=media&#x26;token=81e5b2b7-b83e-4076-97f5-3fe14c801052" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## Search <a href="#plus" id="plus"></a>

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266110078/%EA%B2%80%EC%83%89%20%ED%8E%98%EC%9D%B4%EC%A7%80.drawio.png" alt=""></div>

### 1. Recommended Search Terms <a href="#id-1" id="id-1"></a>

Can display recommended search terms/markup search terms registered in the search page BO.

* **Look up recommended search term list (**[🔗View API >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  Looks up the single most recently registered search term from the BO's search term management menu.

```
GET v1/search/recommendWord 
```

### 2. Recent Search Terms <a href="#id-2" id="id-2"></a>

Displays the search terms the customer has recently searched for. This feature is implemented using local storage.

### 3. Popular Search Terms <a href="#id-3" id="id-3"></a>

Can display up to 10 search results that have rapidly risen within the past 24 hours.

* **Popular search terms (**[🔗View API >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  Looks up the list of the 10 most searched keywords within the past 24 hours.

```
GET v1/search/popularKeword 
```

### 4. Search Term Autocomplete <a href="#id-4" id="id-4"></a>

Can provide recommended search terms related to a word in real time while the search term is being entered.

* **Real-time recommended word search (autocomplete) (**[🔗View API >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  Returns recommended search terms for the entered search term.

```
GET v1/search/recommendation 
```

***

## 2. View Search Results Page (Product List) <a href="#id-2" id="id-2"></a>

When the customer enters a search term and clicks the search button, the search results for that term are displayed.

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266110078/%EA%B2%80%EC%83%89%20%EA%B2%B0%EA%B3%BC%20%ED%8E%98%EC%9D%B4%EC%A7%80.drawio.png" alt=""></div>

### 1. Search Results <a href="#id-1" id="id-1"></a>

The completed search results page shows the following information:

1\) Related search term search: search terms highly related to the term entered in the search box

2\) Category information: category information for the categories the searched products belong to

3\) Product list information: information about the list of searched products<br>

* **Integrated product search (**[🔗View API >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  Calls the integrated product search API and references the following result values for each feature
  * Related search term search: assocwordDataList
  * Category information: categoryDataList
  * Product list information: searchDataList

```
Post v1/search/search 
```

### 2. Product Result List Sort/Filter Conditions <a href="#id-2" id="id-2"></a>

Clicking the sort/filter area to set conditions lets you search for products.

1\) Sort: by sales rank / lowest price / highest price / discount rate / newest / most reviewed

2\) Filter: category / brand / price / age restriction / delivery fee policy / rating / payment method<br>

* **Search products by condition (**[🔗View API >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8%20%EB%B0%B0%EC%86%A1%EC%A0%95%EB%B3%B4/getPdReturnOrChangeInfo))\
  Looks up product information matching the sort/filter values.

```
Post /v1/search/ product  
```

***

## View Search Results Page (Event/Special Promotion List) <a href="#plus" id="plus"></a>

Clicking the content tab in the search results shows a list of special promotions and events related to the search term.

### 1. Special Promotion Search Results <a href="#id-1" id="id-1"></a>

Displays a list of special promotions related to the search term.

* **Special promotion search list results (**[🔗View API >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductOptionInfo))\
  Looks up special promotion information related to the search term.

```
Post /v1/search/marketing 
```

### 2. Event Search Results <a href="#id-2" id="id-2"></a>

Displays a list of events related to the search term.

* **Event search list results (**[🔗 View API >](https://api.x2bee.com/content?msa=order\&depth=%EC%9E%A5%EB%B0%94%EA%B5%AC%EB%8B%88/registerBasket))\
  Looks up event information related to the search term.

```
POST /v1/search/event 
```