> 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/mypage-benefit/coupon-list.md).

# 쿠폰

기본 스킨에서 쿠폰은 '사용가능 쿠폰', '사용불가 쿠폰'으로 나눠서 쿠폰 리스트를 제공합니다.

* 사용 가능 쿠폰
  * 발급 받은 쿠폰 중 사용기간이 남아 있는 쿠폰

<figure><img src="https://67612295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLt0GowPleXLWRjzGIAiV%2Fuploads%2Fgd4a69tiiGWLizzogPQg%2F%E1%84%89%E1%85%A1%E1%84%8B%E1%85%AD%E1%86%BC%E1%84%80%E1%85%A1%E1%84%82%E1%85%B3%E1%86%BC.png?alt=media&amp;token=2fdabd40-45c7-4fcb-8cd2-184c4313a8dc" alt=""><figcaption></figcaption></figure>

* 사용 불가 쿠폰
  * 발급 받은 쿠폰 중 사용이 불가한 쿠폰 (기간 만료 및 사용 완료)

<figure><img src="https://67612295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLt0GowPleXLWRjzGIAiV%2Fuploads%2FlxQSaOCSUyy2bvFCxJAa%2F%E1%84%89%E1%85%A1%E1%84%8B%E1%85%AD%E1%86%BC%E1%84%87%E1%85%AE%E1%86%AF%E1%84%80%E1%85%A1.png?alt=media&amp;token=e12ce075-b9c9-4a52-92cc-e8b90b1d1d12" alt=""><figcaption></figcaption></figure>

#### ◼︎ 쿠폰 리스트

<figure><img src="https://67612295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLt0GowPleXLWRjzGIAiV%2Fuploads%2FNtm853cGYX0iDinqtMQE%2F%E1%84%8F%E1%85%AE%E1%84%91%E1%85%A9%E1%86%AB%E1%84%85%E1%85%B5%E1%84%89%E1%85%B3%E1%84%90%E1%85%B3.png?alt=media&amp;token=0058056d-816b-4177-8cd7-03e24a119f53" alt=""><figcaption></figcaption></figure>

> [GET /coupons](https://docs.shopby.co.kr/?url.primaryName=promotion/#/Coupon/get-my-coupons)
>
> ▶ 내 쿠폰 가져오기\
> 회원의 사용가능 쿠폰과 사용불가 쿠폰을 구분하여 조회합니다.

API 호출 시 요청 파라미터 <mark style="background-color:yellow;">usable</mark> 의 값에 따라 사용 가능 쿠폰 혹은 사용 불가 쿠폰 정보를 조회 할 수 있습니다.

<mark style="background-color:yellow;">usable=true</mark> 인 경우에는 조회 시점 기준으로 사용 가능한 쿠폰의 정보를 확인 가능하며,\ <mark style="background-color:yellow;">usable=false</mark>인 경우에는 조회 시점 기준으로 사용 불가한 쿠폰의 정보를 확인할 수 있습니다.

기본 스킨의 경우 사용가능 쿠폰 리스트에서는 '만료일'을 출력하고, 사용불가 쿠폰리스트에서는 '사용일' 또는 '만료일'을 출력합니다.\
각 날짜 출력 구분은 아래의 내용으로 처리 하시면 됩니다.

{% code overflow="wrap" %}

```
사용가능 쿠폰리스트의 만료일은 used 가 true일때, useEndYmdt 값을 만료일로 출력 
사용불가 쿠폰리스트의 만료일은 used가 true일때, useEndYmdt 값을 만료일로 출력 
사용불가 쿠폰리스트의 만료일은 used가 false일때, expireYmdt 값을 만료일로 출력
```

{% endcode %}

#### ◼︎ 쿠폰 등록 하기

<figure><img src="https://67612295-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLt0GowPleXLWRjzGIAiV%2Fuploads%2FhV6a5dJxzsrRSe7sD9W2%2F%E1%84%8F%E1%85%AE%E1%84%91%E1%85%A9%E1%86%AB%E1%84%83%E1%85%B3%E1%86%BC%E1%84%85%E1%85%A9%E1%86%A8.png?alt=media&amp;token=718d0c63-5944-4184-883a-96889fe0c55a" alt=""><figcaption></figcaption></figure>

기본 스킨에서는 쿠폰 등록 버튼을 통해 쿠폰코드를 입력하여 쿠폰을 추가할 수 있는 기능을 제공합니다.\
쿠폰 등록 가능한 쿠폰 발급은 에서 발급 유형을 '코드발급'으로 등록한 쿠폰을 추가 할 수 있습니다.

아래 어드민 경로에서 쿠폰 등록이 가능합니다.

```
shop by basic/pro : 프로모션 > 쿠폰 관리
shop by premium : 프로모션 관리 > 할인쿠폰 관리 
```

쿠폰 코드는 쇼핑몰 운영자가 쿠폰 등록 시 입력한 프로모션 코드를 입력하면 쿠폰 추가가 가능합니다.

```
▶ 코드 쿠폰 발급하기
등록된 프로모션 코드를 입력하여 회원에게 쿠폰을 발급합니다.
```

> [POST /coupons/register-code/{promotionCode}](https://docs.shopby.co.kr/?url.primaryName=promotion/#/Coupon/post-register-code-download)
>
> ► 코드 쿠폰 발급하기\
> 등록된 프로모션 코드를 입력하여 회원에게 쿠폰을 발급합니다.