> 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/main-and-full-menu/special-promotion.md).

# Special Promotion

Manages e-commerce special promotions and delivers special promotion information to users. You can call special promotions created in the X2BEE BO via API to have customers participate in the currently running special promotion and provide related information to them.

***

{% 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&#x26;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&#x26;token=b829676e-54c7-4712-9432-7c64ed82dc98" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## Special Promotion List Page <a href="#plus" id="plus"></a>

You can check the special promotion list information registered by group and brand.

On the special promotion list, you can check the representative image, title, content, and date information of each special promotion.

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

### 1. Look Up by Special Promotion Group <a href="#id-1" id="id-1"></a>

You can look up the special promotion list by group.

* **Look up special promotion group list (**[🔗View API >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanGroupList))\
  Looks up special promotion groups registered by site or mall.

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

### 2. Look Up by Special Promotion Brand <a href="#id-2" id="id-2"></a>

You can look up the special promotion list by brand.

* **Look up special promotion brands(**[🔗View API >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanBrandList))\
  Looks up the brand information registered in the special promotion.

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

### 3. Look Up Special Promotion List <a href="#id-3" id="id-3"></a>

You can look up summary information for special promotions matching the search conditions, in list form.

* **Look up special promotions (**[🔗View API >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanList))\
  Looks up the list of special promotions registered by site or mall.

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

### 4. Add/Remove Wishlist <a href="#id-4" id="id-4"></a>

On the special promotion list page, you can add or remove that special promotion from your wishlist.

* **Add to wishlist (**[🔗View 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))\
  Adds that special promotion to the logged-in user's wishlist.

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

* **Remove from wishlist (** [🔗View 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))\
  Removes that special promotion from the logged-in user's wishlist.

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

***

## Special Promotion Detail View <a href="#plus" id="plus"></a>

Selecting a special promotion from the list displays the special promotion's detailed content and the products registered to it.

When a special promotion is created in the BO, products are mapped and displayed by segment, allowing areas to be distinguished.

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

### 1. Look Up Special Promotion Details <a href="#id-1" id="id-1"></a>

You can look up the detail page for the selected special promotion.

* **Look up special promotion details (**[🔗View API >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanDetailInfo))\
  Looks up the special promotion's basic information, segments, and the corresponding product information.

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

### 2. Display Products by Segment <a href="#id-2" id="id-2"></a>

You can display products mapped to a segment within the special promotion.

* **Display products by special promotion segment (**[🔗View API >](https://api.x2bee.com/content?msa=display\&depth=%EA%B8%B0%ED%9A%8D%EC%A0%84/getPlanGoodsInfo))\
  Looks up products by special promotion segment based on the special promotion number; if no segment number is provided, looks up information for all segments.

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