> 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/store-front-api/undefined-2/undefined-1.md).

# 검색하기

온라인 커머스 검색 기능을 구현하기 위해 활용되는 API 정보를 제공합니다.

고객의 구매여정 시 상품/이벤트/기획전 등을 검색하고 빠르게 정보를 탐색할 수 있도록 돕습니다.

{% columns %}
{% column %}

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

<figure><img src="/files/qnLuW2R54D0Zq1uu3tam" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

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

<figure><img src="/files/lZJxqZrDkQcXj7tyKAUE" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## 검색하기 <a href="#plus" id="plus"></a>

<p 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=""></p>

### 1. 추천 검색어 <a href="#id-1" id="id-1"></a>

검색 페이지 BO에서 등록한 추천 검색어/마크업 검색어를 노출할 수 있습니다.

* **추천 검색어 목록 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  BO 검색어 관리 메뉴에 등록된 가장 최근 검색어를 1건을 조회합니다.

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

### 2. 최근 검색어 <a href="#id-2" id="id-2"></a>

고객이 최근 검색한 검색 단어를 노출합니다. 해당 기능은 로컬 스토리지(Local storage)에서 구현합니다.

### 3. 인기 검색어 <a href="#id-3" id="id-3"></a>

24시간 이내 급 상승한 검색 결과를 최대 10개까지 노출할 수 있습니다.

* **인기 검색어 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  24시간 이내 가장 많이 검색된 키워드 10개의 목록을 조회합니다.

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

### 4. 검색어 자동완성 <a href="#id-4" id="id-4"></a>

검색어 입력 중에 단어와 관련된 추천 검색어를 실시간으로 제공할 수 있습니다.

* **실시간 추천 단어 검색(자동 완성) (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  입력한 검색어에 대한 추천 검색어를 반환합니다.

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

***

## 2. 검색 결과 페이지 보기(상품 목록) <a href="#id-2" id="id-2"></a>

고객이 검색어를 입력후 검색 버튼을 클릭하면 검색어에 따른 검색 결과를 나타냅니다.

<p 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=""></p>

### 1. 검색 결과 <a href="#id-1" id="id-1"></a>

검색을 완료한 결과 페이지는 다음과 같은 정보를 결과로 나타납니다.

1\) 연관 검색어 검색: 검색창에 입력한 검색어와 관련성이 높은 검색어 정보

2\) 카테고리 정보: 검색한 상품이 포함된 카테고리 정보

3\) 상품 목록 정보: 검색한 상품 목록 정보<br>

* **상품 통합 검색 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductDetailInfo))\
  통합 상품 검색 API 호출하여 각 기능별 다음과 같은 결과 값을 참조합니다
  * 연관 검색어 검색: assocwordDataList
  * 카테고리 정보: categoryDataList
  * 상품 목록 정보: searchDataList

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

### 2. 상품 결과 목록 정렬/필터 조건 <a href="#id-2" id="id-2"></a>

정렬/필터 영역을 클릭해, 조건을 설정하면 상품을 검색 할 수 있습니다.

1\) 정렬: 판매순/낮은가격순/높은가격순/할인율순/최신순/상품평 많은 순

2\) 필터: 카테고리/브랜드/가격/구매제한나이/배송비정책/별점/결제수단<br>

* **상품 조건 검색 (**[🔗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))\
  정렬/필터 값에 해당하는 상품 정보를 조회합니다.

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

***

## 검색 결과 페이지 보기(이벤트/기획전 목록) <a href="#plus" id="plus"></a>

검색 결과에서 콘텐츠 탭을 클릭하면, 검색어와 연관된 기획전과 이벤트 목록을 나타냅니다.

### 1. 기획전 검색 결과 <a href="#id-1" id="id-1"></a>

검색어 관련 기획전 목록을 나타냅니다.

* **기획전 검색 목록 결과 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=goods\&depth=%EC%83%81%ED%92%88%EC%83%81%EC%84%B8/seltProductOptionInfo))\
  검색어와 연관된 기획전 정보를 조회합니다.

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

### 2. 이벤트 검색 결과  <a href="#id-2" id="id-2"></a>

검색어 관련 이벤트 목록을 나타냅니다.

* **이벤트 검색 목록 결과 (**[🔗 API 확인하기 >](https://api.x2bee.com/content?msa=order\&depth=%EC%9E%A5%EB%B0%94%EA%B5%AC%EB%8B%88/registerBasket))\
  검색어와 연관된 이벤트 정보를 조회합니다.

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