> 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-4.md).

# 이벤트

X2BEE BO에 등록된 이벤트 정보를 호출하여 이벤트 페이지에 사용되는 API를 설명합니다.

이벤트 유형

* 추첨 이벤트 : 단순클릭, 설문, 댓글, 구매자 추첨
* 비추첨 이벤트 : 구매사은, 출석체크, 쿠폰 다운로드, 룰렛

{% hint style="info" %}
2023년 11월 06일 룰렛과 구매자 추첨 이벤트 기능이 추가되어 각 이벤트에 대한 설명이 추가되었습니다.
{% endhint %}

***

{% 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%2FJ7djdY7nXFJ0ePHjZIkP%2Fimage-20240416-044219.png?alt=media&amp;token=d4811266-b7dc-40f8-a7db-6f8ca0825787" 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%2FQ8mLOTCvtUhh69EqRv06%2Fimage-20240416-044225.png?alt=media&amp;token=217684e3-6ce9-40e6-8968-352346542b24" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## 이벤트 페이지(공통) <a href="#plus" id="plus"></a>

이벤트는 공통으로 사용하는 API 활용합니다.

해당 API 외 이벤트에 필요한 API는 추가로 설명하였습니다.

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

&#x20;

### 1. 목록 조회 <a href="#id-1" id="id-1"></a>

전시기간, 전시여부, 진행상태등에 다양한 조건으로 이벤트 목록을 조회할 수 있습니다.

조회 결과에는 등록 된 이벤트의 이미지, 제목, 진행일정에 대한 정보가 포함됩니다.

-적용가능 이벤트 유형 : 일반응모/댓글/출석체크/구매사은/쿠폰 다운로드<br>

* **이벤트 목록 조회(**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getEventList))\
  전시기간, 전시여부, 진행상태 등 조건에 맞는 이벤트 조회할 수 있습니다.

```
GET /v1/marketing/getEventList 
```

### 2. 이벤트 상세 조회 <a href="#id-2" id="id-2"></a>

이벤트의 상세 정보를 조회할 수 있습니다. 이 API를 사용하여 일반응모, 댓글, 출석체크, 구매사은, 쿠폰 다운로드 이벤트의 상세 정보를 조회할 수 있습니다.

* **이벤트 상세 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getEventDetail))\
  이벤트에 대한 상세 정보를 조회 할 수 있습니다.

```
GET /v1/marketing/getEventDetail 
```

### 3. 이벤트 응모하기 <a href="#id-3" id="id-3"></a>

X2BEE에서 제공하는 모든 이벤트 유형에 따른 응모 할 수 있는 API입니다. 이 API를 사용하여 일반응모, 댓글, 출석체크, 구매사은, 쿠폰 다운로드 및 설문과 같은 다양한 이벤트에 응모할 수 있습니다.

* **이벤트 종합 응모(**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%9D%91%EB%AA%A8/registerEvent))
  * 다음 이벤트 유형에 따른 이벤트 응모 형태를 제공합니다.
    * 추첨 이벤트 : 단순클릭, 설문, 댓글, 구매자 추첨
    * 비추첨 이벤트 : 출석체크, 구매사은, 쿠폰 다운로드, 룰렛

```
POST /v1/marketing/registerEvent 
```

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

{% hint style="info" %}
‘이벤트 상세 조회하기’와 ‘이벤트 응모하기’ API가 이벤트 유형에 따라 동작하는 내용을 설명합니다.\
다음 이벤트 유형에 대한 API는 [이벤트 페이지(공통)](/api-guide/store-front/undefined/undefined.md)를 참고해주세요
{% endhint %}

### 4. 출석체크 이벤트 <a href="#id-4" id="id-4"></a>

**4.1 출석체크 이벤트 상세 조회하기**

이벤트 기본 정보와 고객의 출석체크 정보와 기 출석 회수에 대한 정보를 조회할 수 있습니다.

**4.2 응모하기**\
\[출석하기] 버튼을 클릭하면 출석 처리가 진행되고, 베네핏을 지급합니다.

### 5. 구매 사은 이벤트 <a href="#id-5" id="id-5"></a>

**5.1 구매 사은 이벤트 상세 조회하기**

이벤트 기본 정보와 회원 주문 정보 목록을 조회하여 지정된 목표 금액 달성여부를 조회할 수 있습니다.

**5.2 응모하기**

나의 구매 금액이 이벤트 조건이 충족되면, \[응모하기] 버튼을 클릭해 이벤트에 응모를 할 수 있습니다.

### 6. 댓글 이벤트 <a href="#id-6" id="id-6"></a>

**6.1 댓글 이벤트 상세 조회하기**

댓글 이벤트의 기본 정보와 등록된 댓글 목록을 조회 할 수 있습니다

**6.2 등록(응모)하기**

해당 이벤트의 댓글 입력란에 댓글이 등롣되면 \[등록하기] 버튼이 활성화 되며, 클릭하면 댓글 등록과 함께 이벤트에 응모 할 수 있습니다.

### 7. 쿠폰 이벤트 <a href="#id-7" id="id-7"></a>

**7.1 쿠폰 이벤트 상세 조회하기**

쿠폰 이벤트의 기본 정보를 조회할 수 있습니다.

**7.2 쿠폰 다운받기**

해당 이벤트에 등록된 쿠폰의 \[다운받기] 버튼을 클릭하면, 쿠폰을 다운로드 할 수 있습니다.

### 8. 룰렛 이벤트 <a href="#id-8" id="id-8"></a>

**8.1 이벤트 상세 조회**

룰렛 이벤트의 기본 정보를 조회할 수 있습니다.

**8.2 이벤트 응모하기**

룰렛 이벤트는 \[START] 버튼을 클릭하여 참여할 수 있고, 당첨 결과에 따른 경품을 즉시 수령할 수 있습니다.

### 9. 구매자 추첨 이벤트 <a href="#id-9" id="id-9"></a>

**9.1 이벤트 상세 조회**

이벤트 기본 정보와 회원 주문 정보 목록을 조회하여 지정된 목표 금액 달성여부를 조회할 수 있습니다. 화면은 구매사은이벤트와 동일합니다.

**9.2 이벤트 응모하기**

해당 이벤트에 등록된 \[응모하기] 버튼을 클릭하면 응모가 완료됩니다.

{% hint style="info" %}
**5.구매 사은 이벤트**와 **9.구매자 추첨 이벤트**와의 차이점은 비추첨과 추첨 이벤트로 다음과 같습니다.

* 구매사은 : 목표 금액 달성 후 이벤트에 응모하면, 이벤트 종료일로부터\
  \*<mark style="color:$danger;">14일 이후</mark> 당첨 처리 및 사은품 지급\
  \*<mark style="color:$danger;">당첨 처리 및 사은품 지급일은 운영자가 지정할 수 있습니다.</mark>
* 구매자 추첨 : 목표 금액 달성 후 이벤트에 응모하면, 운영자가 당첨자 추첨 절차를 진행하고 당첨자에게 경품 지급
  {% endhint %}

***

## 댓글 이벤트 -댓글 수정/삭제 <a href="#plus" id="plus"></a>

로그인 사용자가 댓글 이벤트 참여 및 댓글 조회하는 기능을 제공하고 있습니다.

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

### 1. 댓글 더보기 <a href="#id-1" id="id-1"></a>

* **이벤트 댓글 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C\&path=getEventReplies))\
  이벤트 번호로 작성된 댓글 목록을 페이징 처리하여 조회합니다.

```
GET/v1/marketing/getEventReplies 
```

***

## 설문 이벤트 - 리스트 및 상세 페이지  <a href="#plus" id="plus"></a>

설문 이벤트는 고객리뷰를 통해 접근할 수 있습니다.

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

### 1. 설문 이벤트 리스트 <a href="#id-1" id="id-1"></a>

등록 된 설문 이벤트의 상태, 제목, 기간 정보를 조회하여 리스트 생성할 수 있습니다.

* **이벤트 고객리뷰(설문) 목록 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getCustReviewList))\
  BO에 등록 된 이벤트를 조회할 수 있습니다.

```
GET /v1/marketing/getCustReviewList 
```

### 2. 설문 이벤트 상세페이지 <a href="#id-2" id="id-2"></a>

해당 설문 이벤트의 상세 내용을 조회하여 항목을 선택하여 클릭 할 수 있습니다.

* **이벤트 고객리뷰(설문) 상세 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getCustReviewDetail))\
  설문 이벤트의 내용과 설문문항을 조회 할 수 있습니다.

```
GET /v1/marketing/getCustReviewDetail 
```

### 3.설문 이벤트 응모하기 <a href="#id-3" id="id-3"></a>

설문 선택이 완료되면 응모하기 버튼이 활성화 됩니다.

\[응모하기] 버튼을 클릭하면 응모가 완료됩니다.

설문 이벤트 응모하기 API는 이벤트 문서의 [3. 이벤트 응모하기](/api-guide/store-front/undefined/undefined-3.md)를 참고해주세요.

***

## 이벤트 참여 내역 페이지 <a href="#plus" id="plus"></a>

고객이 참여한 이벤트 내역 정보를 확인할 수 있습니다.

<p align="center"><img src="https://tech.x2bee.com/download/attachments/266109587/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0%20-%20%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%B0%B8%EC%97%AC%EB%82%B4%EC%97%AD.drawio.png" alt=""></p>

### 1. 이벤트 참여 내역 <a href="#id-1" id="id-1"></a>

고객이 이벤트 참여 내역 목록으로 조회 할 수 있습니다.

* **이벤트 참여내역 조회 (**[🔗API 확인하기 >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%B0%B8%EC%97%AC%EB%82%B4%EC%97%AD\&path=getMyEventEntryList))\
  이벤트에 참여한 내역을 조회 합니다.

```
GET /v1/marketing/getMyEventEntryList 
```