> 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/discount.md).

# Discount

The shopping mall provides codes or coupons that let consumers receive benefits, and using them lets consumers purchase products at a discounted price. Coupons are provided in two forms, general discount coupons and free-shipping coupons, and these benefits are used as a marketing tool to draw consumer interest and encourage more purchases.

### Key Features

* Applying coupons and discounts
  * Members can purchase products using the various coupons and discounts provided by the shopping mall.
* A variety of coupons and promotions
  * The shopping mall offers many kinds of coupons and promotions, providing members with a wide range of discount benefits.
* Discount types
  * Two types of discounts are provided when applying a discount benefit: fixed-amount benefits and percentage-rate benefits.
* Margin check
  * When applying a discount benefit, a margin check restricts discount benefits larger than the supply cost, minimizing losses for the company's own products.

### Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F7ICW4SDiHl3ftU2yWTwz%2Fimage.png?alt=media&#x26;token=9e13b3ee-630a-4d1e-85b6-5249d7eacad4" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Order form coupon list inquiry

Retrieves the list of coupons held by the member on the order form page.
{% endstep %}

{% step %}

### Coupon basic information inquiry

For coupon download events among event types, retrieves the corresponding coupon's basic information.
{% endstep %}

{% step %}

### Per-member coupon count inquiry

Retrieves the number of free-shipping coupons and the number of general coupons held by the member, respectively.
{% endstep %}

{% step %}

### Per-product instant discount price inquiry

Retrieves the available product instant discount price for each product.
{% endstep %}

{% step %}

### Product detail maximum benefit price inquiry

Retrieves the maximum benefit price for the corresponding product on the product detail page.
{% endstep %}

{% step %}

### Order form coupon usage processing

Marks the selected coupon as used during order and claim processing.
{% endstep %}

{% step %}

### Order form maximum benefit price inquiry

Retrieves the maximum benefit amount available to the member and the applicable discount information when processing a cart, order, or claim.
{% endstep %}

{% step %}

### Order form shipping coupon inquiry

Retrieves the list of free-shipping and free-return coupons during order and claim processing.
{% endstep %}

{% step %}

### Coupon cancellation/restoration

Changes the status of a previously used coupon back to unused during claim processing.
{% endstep %}

{% step %}

### Available benefit information inquiry

This logic is a service-level validation and calculation logic; please refer to the 'business process definition' in the \[Promotion Validation] feature overview.
{% endstep %}
{% endstepper %}

### API Function List

<table><thead><tr><th width="122.333251953125">API</th><th width="360.4444580078125">Description</th><th width="94.666748046875">Server</th><th width="93.5555419921875">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Per-member coupon count inquiry</td><td>Retrieves the number of coupons held by the member, by type. Retrieves the counts of general coupons and free-shipping coupons.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getMbrCpnCnt">🔗View API></a></td></tr><tr><td>Order form coupon list inquiry</td><td>Retrieves the coupons and discount information held by the member within the order form.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getCouponPopupData">🔗View API></a> Staff discount limit inquiry: /api/member/v1/staff/getDsctLmtStat</td></tr><tr><td>Product detail maximum benefit price inquiry</td><td>Retrieves the maximum benefit price within the product detail page.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getGoodsMaxBenefit">🔗View API></a> Staff discount limit inquiry: /api/member/v1/staff/getDsctLmtStat</td></tr><tr><td>Coupon basic information inquiry</td><td>Retrieves the information of the coupon issued for the coupon download event type.</td><td>Order</td><td>GET</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getCouponInfo">🔗View API></a></td></tr><tr><td>Per-product instant discount price inquiry</td><td>Retrieves the available product instant discount price for each product.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getGoodsDirectDiscountInfo">🔗View API></a> Discount&#x26;path=getGoodsDirectDiscountInfo</td></tr><tr><td>Order form coupon usage processing</td><td>Marks the selected coupon as used at order time, applying the product price and shipping benefits.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=useCpn">🔗View API></a></td></tr><tr><td>Coupon cancellation/<br>restoration</td><td>When an order is cancelled through claim processing, cancels and restores the coupon used in the original order.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=cnclCpn">🔗View API></a></td></tr><tr><td>Order form maximum benefit price inquiry</td><td>Retrieves the maximum benefit price for the order when processing a cart, order form, or claim.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getBenefitInfo">🔗View API></a> Staff discount limit inquiry: /api/member/v1/staff/getDsctLmtStat</td></tr><tr><td>Order form shipping coupon inquiry</td><td>Retrieves the free-shipping coupons or free-return coupons held by the member during order and claim processing.</td><td>Order</td><td>POST</td><td><a href="https://api.x2bee.com/content?msa=order&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%ED%95%A0%EC%9D%B8&#x26;path=getDlvBenefitInfo">🔗View API></a></td></tr></tbody></table>

### Term Definitions

<table><thead><tr><th width="80.6666259765625">Term</th><th>Description</th><th data-hidden>Notes</th></tr></thead><tbody><tr><td>Discount</td><td>Sale price discount, staff discount, product instant discount</td><td></td></tr><tr><td>Coupon</td><td>Product coupon, stackable coupon, cart coupon, shipping and return fee coupon</td><td></td></tr></tbody></table>

### Other Notes

* **Per-product instant discount price inquiry API**
  * This API is currently called from the product API, but the product API itself is not in use.
* **Benefit**
  * The applicable benefit for each tier is calculated based on whether it is a percentage-rate or fixed-amount benefit.
  * Benefits are applied across a total of three tiers, and one coupon or discount benefit can be received per tier.
  * To prevent losses to the company, when a benefit is applied, coupon and discount benefits are restricted if the result is cheaper than the product's supply cost.
* **Coupon and discount policy**

<table data-full-width="true"><thead><tr><th align="center">Category</th><th>Tier 1 discount</th><th>Tier 2 discount</th><th></th><th></th><th>Tier 3 discount</th><th></th></tr></thead><tbody><tr><td align="center"><strong>Type</strong></td><td>Sale price discount (single-item discount)</td><td>Product discount coupon</td><td>Staff discount</td><td>Product instant discount</td><td>Stackable discount coupon</td><td>Cart coupon</td></tr><tr><td align="center"><strong>Discount type</strong></td><td>Fixed amount</td><td>Fixed amount/percentage rate</td><td>Percentage rate</td><td>Percentage rate</td><td>Fixed amount/percentage rate</td><td>Fixed amount/percentage rate</td></tr><tr><td align="center"><strong>Characteristics</strong></td><td>Set at product registration</td><td>Only one discount type can be selected within the same tier (cannot be used simultaneously) (e.g., Tier 2 product coupon + staff discount cannot be used together) When calculating the maximum benefit price, the larger amount takes priority; if amounts are equal, applied in the order product instant discount -> product discount coupon -> staff discount</td><td></td><td></td><td>Only one discount type can be selected within the same tier (cannot be used simultaneously) Tier 3 discount can be used on its own. When calculating the maximum benefit price, the larger amount takes priority; if amounts are equal, applied in order of the coupon's expiration deadline</td><td></td></tr><tr><td align="center"><strong>Calculation base amount</strong></td><td>Sale price</td><td>Price after Tier 1 discount</td><td></td><td></td><td>Price after Tier 2 discount</td><td></td></tr><tr><td align="center"><strong>Minimum purchase criteria</strong></td><td>N/A</td><td>Quantity: fixed at 1 Amount: sale price of 1 unit of the product</td><td>N/A</td><td>N/A</td><td>Quantity: fixed at 1 Amount: sale price of 1 unit of the product</td><td>Quantity: sum of applicable products Amount: sum of the post-discount amount of applicable products (previous tier)</td></tr><tr><td align="center"><strong>Application basis</strong></td><td>Product sale price adjustment</td><td>Individual discount applied to all quantities of the product</td><td></td><td></td><td></td><td>Discount applied to all quantities of applicable products</td></tr><tr><td align="center"><strong>Margin check</strong></td><td>At product registration</td><td>Coupon/discount is shown and usable only when "supply price >= sale price - discount amount"</td><td></td><td></td><td></td><td></td></tr><tr><td align="center"><strong>Tier 3 discount applicability</strong></td><td>N/A</td><td>O</td><td>X</td><td>O</td><td>N/A</td><td>N/A</td></tr><tr><td align="center"><strong>Common application notes</strong></td><td>N/A</td><td>Discounts can be applied in 1-won units, and amounts below 1 won are rounded. Promotion recalculation is only performed if a claim is made before all products in the order enter "in delivery" status. To prevent 0-won payment, coupons/discounts larger than the sale price cannot be used.</td><td></td><td></td><td></td><td></td></tr></tbody></table>

* Maximum benefit policy

<table data-full-width="true"><thead><tr><th align="center"></th><th>Product Detail</th><th>Cart</th><th>Order Form</th></tr></thead><tbody><tr><td align="center"><strong>Available discount types</strong></td><td>Product discount coupon, product instant discount, staff discount</td><td>Product discount coupon, product instant discount, staff discount</td><td>Product discount coupon, product instant discount, staff discount, stackable discount coupon, cart coupon</td></tr><tr><td align="center"><strong>Target</strong></td><td>Members/non-members (product instant discount only)</td><td>Members</td><td>Members</td></tr><tr><td align="center"><strong>Notes</strong></td><td>If a downloadable product discount coupon exists <strong>that the customer has not downloaded</strong>, <strong>that coupon is included in the maximum benefit calculation</strong>. For non-members, product instant discounts are shown only for discounts where all applicable member grades are selected.</td><td></td><td></td></tr></tbody></table>
