> 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/promotion/coupon-issuance.md).

# Coupon Issuance

The shopping mall provides codes or coupons that offer discounts and various benefits. They have two properties, percentage-rate coupons and fixed-amount coupons, and applying such a coupon at checkout provides a discount benefit. There are also special coupons that provide free shipping or free returns.

***

## Key Features

* **Coupon issuance system**
  * Members can directly obtain coupons from the Store Front.
  * The system also operates a mechanism for issuing coupons from the Back Office.
* **Automatic issuance system**
  * A conditional coupon issuance system exists that automatically issues coupons meeting the conditions via the automatic issuance type code.
* **Coupon inquiry**
  * On the product detail page, the downloadable coupon inquiry API can be used to retrieve the list of coupons downloadable for the product.
  * The per-member coupon inquiry API can be used to retrieve the list of coupons a member holds.

## Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FKCNaSxmepI7TKsXWe6Ow%2F182813300.jpg?alt=media&#x26;token=60a499d6-1722-4ab6-b17b-6df1c4acc231" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Product detail downloadable coupon inquiry

Retrieves coupons applicable to the corresponding product on the product detail page.
{% endstep %}

{% step %}

### Per-member coupon inquiry

Retrieves the list of coupons held by the member to check their expiration date, type, and so on.
{% endstep %}

{% step %}

### Coupon download (BO)

An API used when the system issues coupons, used for issuing coupons such as new member sign-up coupons and birthday coupons.
{% endstep %}

{% step %}

### Coupon download (FO)

A service through which a member directly requests a coupon download and receives the coupon through a series of actions.
{% endstep %}

{% step %}

### Coupon inquiry by automatic issuance type

Checks whether a valid coupon exists that matches the automatic issuance type condition.
{% endstep %}
{% endstepper %}

## API Function List

<table><thead><tr><th width="129">API</th><th width="386.2222900390625">Description</th><th width="96.888916015625">Server</th><th width="92.4444580078125">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Coupon download (FO)</td><td>A service through which logged-in members, via product pages, event pages, and so on, can directly obtain coupons.</td><td>Order</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=order&#x26;depth=%EC%BF%A0%ED%8F%B0%20%EB%B0%9C%EA%B8%89&#x26;path=cpnDownFo">🔗View API></a></td></tr><tr><td>Coupon download (BO)</td><td>A service through which other module services, such as batch jobs or new member sign-up, request coupon issuance when a coupon needs to be issued.</td><td>Order</td><td>POST</td><td><p><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%BF%A0%ED%8F%B0%20%EB%B0%9C%EA%B8%89&#x26;path=cpnDownBo">🔗View API></a></p><p>Member information list inquiry: /api/member/v1/member/getMemberInfoList</p></td></tr><tr><td>Per-member coupon inquiry</td><td>Retrieves the coupon information held by the member.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%BF%A0%ED%8F%B0%20%EB%B0%9C%EA%B8%89&#x26;path=getCpnIssuList">🔗View API></a></td></tr><tr><td>Product detail downloadable coupon inquiry</td><td>Retrieves the list of coupons downloadable for the corresponding product on the product detail page.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%BF%A0%ED%8F%B0%20%EB%B0%9C%EA%B8%89&#x26;path=getCpnListForGoodsDetail">🔗View API></a></td></tr><tr><td>Coupon inquiry by automatic issuance type</td><td>To automatically issue a coupon to a member meeting a specific criterion, retrieves the list of valid issuable coupons for the corresponding automatic issuance type code.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%EC%BF%A0%ED%8F%B0%20%EB%B0%9C%EA%B8%89&#x26;path=getCouponListByAutoIssuTypCd">🔗View API></a></td></tr></tbody></table>

## Term Definitions

<table><thead><tr><th width="155.111083984375">Term</th><th>Description</th><th data-hidden></th></tr></thead><tbody><tr><td>Conditional automatic issuance coupon</td><td>A system in which the system automatically issues a coupon to a member who meets a specific criterion (automatic issuance type), without the member having to request it directly.</td><td></td></tr><tr><td>Automatic issuance type code (MK008)</td><td>A code defining the type of automatically issued coupon.<br>New member sign-up coupon (2101), shopping bag exclusive coupon (2201)<br>long-term non-purchase customer coupon (2301), birthday coupon (2401)<br>grade celebration coupon (2501), app first login welcome coupon (2601)<br>PUSH opt-in coupon (2701)</td><td></td></tr></tbody></table>

## Other Notes

* Coupon usage processing
  * Marks the corresponding coupon issuance number as used during orders and claims.
* Coupon expiration notice
  * If a coupon held by the user has 3 days or less remaining or expires today, an expiration notice is sent (notification inbox, email).
* Coupon usage cancellation processing
  * At order time (upon order processing failure): the "used" attribute of the issued coupon is changed to 'N'; however, since this can be done within the same transaction based on the creation date, this feature is not used.
  * On claims and other calls
    * Creates a new coupon based on the existing issuance history.
    * If an issuance history already exists, coupon issuance is not performed again.
    * The coupon issuance count limit is not checked; upon reissuance, if the original coupon's usable period has not yet passed, it is reissued with the original period, and if the original coupon's usable period has passed, it is issued as a usable coupon by looking up the coupon restoration validity days (ST001) value from today.