> For the complete documentation index, see [llms.txt](https://workspace-help.nhn-commerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://workspace-help.nhn-commerce.com/aurora-guide/api-1/event.md).

# 기획전

쇼핑몰 상단에서 \[기획전] 버튼 클릭 시 기획전 목록 페이지로 이동합니다.

기획전은 아래 어드민 경로에서 등록/관리가 가능합니다. &#x20;

```
shop by basic/pro : 프로모션 > 기획전 관리
shop by premium : 전시관리 > 기획전 관리
```

#### ◼︎ 기획전 목록

<figure><img src="/files/stwk4qRDlBHAi6je2CRB" alt=""><figcaption></figcaption></figure>

등록된 기획전 목록을 조회할 수 있습니다. \
기획전은 최신순 / 마감순 정렬 버튼을 통해 순서대로 나열되며, \
기획전은 진행 중인 기간에 따라, 진행중 / 종료 라벨으로 구분됩니다.&#x20;

> [GET /display/events](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-by-keyword-type)
>
> ► 기획전 조회하기\
> 기획전을 조회할 수 있습니다.&#x20;

#### ◼︎ 기획전 상세

기획전 목록에서 기획전을 클릭하면 기획전 상세 페이지로 이동합니다.\
종료된 기획전은 상세 페이지로 이동이 불가합니다.&#x20;

<figure><img src="/files/xg8EeObw807zADpQ3R9m" alt=""><figcaption></figcaption></figure>

**기획전 상세 정보 조회**

> [GET /display/events/{eventKey}](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-v2)
>
> [GET /display/events/ids/{eventId}](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-by-id-v2)
>
> ► 기획전 상세 조회하기 v2.0\
> 기획전 상세 정보를 조회할 수 있습니다.

* eventKey: 기획전 번호, 기획전 ID로 모두 조회 가능
* eventId: 기획전 ID로만 조회 가능

기획전 상세에서는 아래 항목을 제공합니다.

* `top`: 기획전 상세 이미지를 화면에 노출합니다.
  * 상세 이미지 미 등록 시 출력되지 않습니다.
* `coupon`: 쿠폰 정보를 화면에 노출합니다.
  * \[쿠폰받기] 버튼 클릭 시 해당 기획전에 설정된 쿠폰을 다운받을 수 있습니다.
* `section`: 기획전에 설정된 상품 진열 정보가 조회됩니다.
  * 상품 진열 내 상품 리스트는 제공되지 않습니다.

**기획전 상품진열 상품 조회**

상품진열의 상품 리스트는 [기획전 상품진열 상품 조회하기 API](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-section-products)를 통해 조회합니다.<br>

> [GET /display/events/{eventNo}/sections/{sectionNo}](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-section-products)
>
> ► 기획전 상품진열 상품 조회하기\
> 기획전 상품진열에 있는 상품 리스트를 조회할 수 있습니다.

기획전 상세에서 응답된 기획전 번호(`eventNo`)와 상품진열 번호(`section[].sectionNo`)로

원하는 상품 진열의 상품 리스트를 조회할 수 있습니다.

`products` 값을 활용하여 화면에 상품을 노출할 수 있습니다.

**미리보기**

진행 중이 아닌 기획전은 기획전 정보가 조회되지 않습니다.

다만, 진행 중이 아닌 기획전 상세 내용을 미리보기 하고 싶다면 다음 API 호출 시 `preview` 값을 전달하여 미리보기가 가능합니다.

* [기획전 상세 조회하기 v2.0](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-v2)
* [기획전 상품진열 상품 조회하기](https://docs.shopby.co.kr/?url.primaryName=display/#/Event/get-event-section-products)

자세한 내용은 API 문서에서 참고하실 수 있습니다.
