> 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-1/undefined-3.md).

# 기획전

이커머스 특별 기획전을 관리하고 기획전 정보를 사용자에게 전달할 수 있습니다. X2BEE BO에서 생성 된 기획전을 API로 호출하여 현재 진행 중인 기획전에 참여하고 관련 정보를 고객에게 제공 할 수 있습니다.

***

{% 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%2FHVd1HjWW6rZ7Pzmhz3wF%2Fimage-20240416-043947.png?alt=media&amp;token=b259e9be-5c67-4a54-a11e-5d01f9d67a0a" 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%2Fs6XKNqDkMWu7iT35oW4l%2Fimage-20240416-044011.png?alt=media&amp;token=b829676e-54c7-4712-9432-7c64ed82dc98" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## 기획전 리스트 페이지 <a href="#plus" id="plus"></a>

그룹과 브랜드 별로 등록 된 기획전 리스트의 정보를 확인할 수 있습니다.

기획전 리스트에서는 기획전 대표 이미지와 제목, 내용, 날짜 정보를 확인할 수 있습니다.

<p align="center"><img src="https://tech.x2bee.com/download/attachments/266109526/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0-%EA%B8%B0%ED%9A%8D%EC%A0%84.drawio.png" alt=""></p>

### 1. 기획전 그룹 별 조회 <a href="#id-1" id="id-1"></a>

그룹 별로 기획전 목록을 조회할 수 있습니다.

* **기획전 그룹 목록 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanGroupList))\
  사이트, 몰 기준으로 등록된 기획전 그룹을 조회합니다.

```
GET /v1/plan/group 
```

### 2. 기획전 브랜드 별 조회 <a href="#id-2" id="id-2"></a>

브랜드 별로 기획전 목록을 조회할 수 있습니다.

* **기획전 브랜드 조회(**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanBrandList))\
  기획전에 등록된 브랜드 정보를 조회합니다.

```
GET /v1/plan/brand 
```

### 3. 기획전 목록 조회 <a href="#id-3" id="id-3"></a>

조회 조건에 따른 기획전 요약 정보를 리스트 형태로 조회할 수 있습니다.

* **기획전 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanList))\
  사이트, 몰 기준으로 등록 된 기획전 리스트를 조회합니다.

```
GET /v1/plan/planList 
```

### 4. 위시리스트 등록/삭제하기 <a href="#id-4" id="id-4"></a>

기획전 목록 페이지에서 해당 기획전을 위시리스트로 등록하거나 삭제 할 수 있습니다.

* **위시리스트 등록 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=member\&depth=%EC%9C%84%EC%8B%9C%EB%A6%AC%EC%8A%A4%ED%8A%B8\&path=registerWishlist))\
  해당 기획전을 로그인한 사용자의 위시리스트에 등록합니다.

```
POST /v1/front/wishlist 
```

* **위시리스트 삭제 (** [🔗API 확인하기 >](https://api.x2bee.com/content?msa=member\&depth=%EC%9C%84%EC%8B%9C%EB%A6%AC%EC%8A%A4%ED%8A%B8\&path=deleteWishList))\
  해당 기획전을 로그인한 사용자의 위시리스트에 삭제합니다.

```
DEL /v1/front/wishlist  
```

***

## 기획전 상세 조회 <a href="#plus" id="plus"></a>

기획전 리스트에서 기획전을 선택하면, 기획전 상세 내용과 기획전에 등록된 상품을 전시합니다.

BO에서 기획전 생성 시 구분자에 따른 매핑된 상품 전시하여, 영역을 구분할 수 있습니다.

<p align="center"><img src="https://tech.x2bee.com/download/attachments/266109526/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0-%EA%B8%B0%ED%9A%8D%EC%A0%84%20%EC%83%81%EC%84%B8.drawio.png" alt=""></p>

&#x20;

### 1. 기획전 상세 정보조회 <a href="#id-1" id="id-1"></a>

선택한 기획전의 상세 페이지를 조회할 수 있습니다.

* **기획전 상세 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanDetailInfo))\
  기획전 기본 정보, 구분자 및 해당 상품정보를 조회 합니다.

```
GET /v1/plan/planDetail/{mkdpNo} 
```

### 2. 구분자 별 상품 전시 <a href="#id-2" id="id-2"></a>

기획전 내에 구분자에 매핑된 상품을 전시 할 수있습니다.

* **기획전 구분자별 상품 전시 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanGoodsInfo))\
  기획전 번호 기준으로 기획전 구분자별 상품을 조회하며, 구분자 번호가 없을때는 전체 구분자 정보를 조회합니다.

```
GET /v1/plan/planGoodsInfo 
```