> 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/back-office/marketing-bo/coupon-management.md).

# Coupon Management

The Coupon Management service lets you register and edit various types of coupons, and look up the list of registered coupons to check detailed information and status. This service focuses on preventing indiscriminate coupon usage and issuance, and efficiently managing coupon-related costs.

***

## Key Features

* **Coupon Registration and Editing**
  * Register and edit coupons with detailed settings such as basic information, coupon benefits, applicable targets, and excluded targets.
  * Set the issuance method so that a coupon is automatically issued to members who meet the corresponding conditions.
  * Set the coupon's discount type as fixed-amount or percentage, and limit coupon usage by specifying a minimum/maximum amount.
* **Coupon Status Management**
  * Check the status of registered coupons, and manage discontinued coupons so they can no longer be issued or used.
* **Coupon Cost Inquiry**
  * Efficiently look up the status of issued coupons and the cost incurred from coupon usage in a single inquiry.
  * Monitor overall coupon-related costs based on the number of members who received a coupon, the coupon usage rate, and the usage count.

## Process Definition

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FJhvmTEW8kii4bFCUUf8Z%2F%E1%84%8F%E1%85%AE%E1%84%91%E1%85%A9%E1%86%AB%E1%84%80%E1%85%AA%E1%86%AB%E1%84%85%E1%85%B5.png?alt=media&#x26;token=54f782f9-0c6f-469e-9051-99bedcbf20de" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Registered Coupon Inquiry

Looks up the list and count of registered coupons.
{% endstep %}

{% step %}

### Coupon Status Change

Changes the status of a registered coupon. Status classifications include Normal Coupon and Discontinued Coupon.
{% endstep %}

{% step %}

### Coupon Setup and Issuance

Enters the coupon issuance conditions, such as basic information, coupon benefits, and applicable targets, and issues the coupon.
{% endstep %}

{% step %}

### Issuance Status Inquiry

Looks up the list and count of cost information for coupon usage, such as issuance status, usage status, and incurred cost status.
{% endstep %}

{% step %}

### Coupon Detail Inquiry

Looks up the detail information of a coupon entered at the time of registration.
{% endstep %}

{% step %}

### Coupon Issuance Status

Looks up the list and count of members who received a registered coupon.
{% endstep %}

{% step %}

### Data Download

Uploads registered member information within an Excel file, looks up the content recorded in the file, and delivers it.
{% endstep %}

{% step %}

### Coupon Withdrawal Procedure

Withdraws a coupon issued incorrectly or abnormally to a specific member among the list of members who were issued it.
{% endstep %}

{% step %}

### Coupon Period Edit

Changes the validity period of a coupon held by a member.
{% endstep %}

{% step %}

### Manual Coupon Issuance

Manually issues a coupon to a member that was not issued due to a system error.
{% endstep %}

{% step %}

### Coupon Multilingual Inquiry

Looks up the multilingual registration information for coupon management.
{% endstep %}

{% step %}

### Coupon Multilingual Registration

Registers the multilingual information for coupon management.
{% endstep %}
{% endstepper %}

## API Function List

<table><thead><tr><th width="137.888916015625">API</th><th width="334.22216796875">Description</th><th width="94.666748046875">Server</th><th width="93.5555419921875">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Coupon Management List Inquiry</td><td>Looks up the list of registered coupons using the entered conditions.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponList">🔗View API ></a></td></tr><tr><td>Coupon Management List Count Inquiry</td><td>Looks up the count of registered coupons using the entered conditions. Pagination is applied based on the count returned.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponListCount">🔗View API ></a></td></tr><tr><td>Common Code Inquiry</td><td>Looks up the common code for coupon type among the search conditions when looking up the coupon list.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5%EC%BD%94%EB%93%9C%20%EC%A1%B0%ED%9A%8C&#x26;path=getStStdCd">🔗View API ></a></td></tr><tr><td>Coupon Registration/Edit</td><td>Registers or edits the coupon information entered by the administrator.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=registerCoupon">🔗View API ></a></td></tr><tr><td>Coupon Status Change</td><td>Changes the status code of a coupon.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=saveCouponState">🔗View API ></a></td></tr><tr><td>Coupon Detail Information Inquiry</td><td>Looks up the detail information of a registered coupon.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponData">🔗View API ></a></td></tr><tr><td>Coupon Issued Member Inquiry</td><td>Looks up the members and member list who received a registered coupon.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponIssuedMemberList">🔗View API ></a></td></tr><tr><td>Coupon Issued Member Count Inquiry</td><td>Looks up the count of the member list who received a registered coupon.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponIssuedMemberListCount">🔗View API ></a></td></tr><tr><td>Member Coupon Bulk Issuance Inquiry</td><td>Uploads an Excel file, looks up the member information recorded in the Excel file, and delivers it.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=couponIssuedMbrLoadByExcel">🔗View API ></a></td></tr><tr><td>Member Coupon Issuance</td><td>Issues a specific coupon to the specified member.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=registCouponIssuedMember">🔗View API ></a></td></tr><tr><td>Coupon Period Change</td><td>Changes the validity period of a specific coupon among the coupons issued to a member.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=modifyCouponValiDtm">🔗View API ></a></td></tr><tr><td>Coupon Withdrawal</td><td>Marks a specific coupon among the coupons issued to a member as used, thereby withdrawing it.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=withdrawCoupon">🔗View API ></a></td></tr><tr><td>Coupon Cost Management Inquiry</td><td>Looks up the list of coupon costs registered using the entered conditions.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponCostList">🔗View API ></a></td></tr><tr><td>Coupon Cost Management Result Count Inquiry</td><td>Looks up the count of the coupon cost list registered using the entered conditions. Pagination is applied based on the count returned.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponCostManageListCount">🔗View API ></a></td></tr><tr><td>Common Code Inquiry</td><td>Looks up the common code for coupon type among the search conditions when looking up the coupon list.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B3%B5%ED%86%B5%EC%BD%94%EB%93%9C%20%EC%A1%B0%ED%9A%8C&#x26;path=getStStdCd">🔗View API ></a></td></tr><tr><td>Coupon Detail Information Inquiry</td><td>Looks up the detail information of a registered coupon.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponData">🔗View API ></a></td></tr><tr><td>Coupon Issued Member Inquiry</td><td>Looks up the members and member list who received a registered coupon.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getCouponIssuedMemberList">🔗View API ></a></td></tr><tr><td>Coupon Issued Member Count Inquiry</td><td>Looks up the count of the member list who received a registered coupon.</td><td>BO</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗View API ></a></td></tr><tr><td>Member Coupon Bulk Issuance Inquiry</td><td>Uploads an Excel file, looks up the member information recorded in the Excel file, and delivers it.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=couponIssuedMbrLoadByExcel">🔗View API ></a></td></tr><tr><td>Member Coupon Issuance</td><td>Issues a specific coupon to the specified member.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=registCouponIssuedMember">🔗View API ></a></td></tr><tr><td>Coupon Period Change</td><td>Changes the validity period of a specific coupon among the coupons issued to a member.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=modifyCouponValiDtm">🔗View API ></a></td></tr><tr><td>Coupon Withdrawal</td><td>Marks a specific coupon among the coupons issued to a member as used, thereby withdrawing it.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=withdrawCoupon">🔗View API ></a></td></tr><tr><td>Promotion Multilingual Information Inquiry</td><td>Looks up the multilingual information of a discount/mileage benefit.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=getMultilingualInfo">🔗View API ></a></td></tr><tr><td>Promotion Multilingual Registration</td><td>Registers the multilingual information of a discount/mileage benefit.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=marketing&#x26;depth=%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98%20%EA%B4%80%EB%A6%AC&#x26;path=saveMultilingualInfo">🔗View API ></a></td></tr></tbody></table>

## Terminology

<table><thead><tr><th width="154">Term</th><th>Description</th><th data-hidden>Notes</th></tr></thead><tbody><tr><td>Discount Type (Fixed Amount)</td><td>A type of coupon that discounts a set amount or amount range when a product is purchased. This type of coupon mainly discounts a fixed amount, or provides a benefit that discounts the amount specified at the time of registration once a minimum purchase amount is met.</td><td></td></tr><tr><td>Discount Type (Percentage)</td><td>A coupon that discounts a certain percentage of a product's price when the product is purchased. With this type of coupon, the discounted amount varies according to the product's price. Because a percentage coupon causes the discounted amount to vary relative to the product's price, the higher the product's price, the greater the discounted amount can be.</td><td></td></tr><tr><td>Issuance Count per Member</td><td>Specifies the maximum number of times a single member can receive the coupon.</td><td></td></tr><tr><td>Total Issuance Count</td><td>Specifies the total issuance count for the coupon. First-come, first-served coupon issuance is possible up to the set number.</td><td></td></tr><tr><td>Issuing Entity</td><td>Fixed Promotional Coupon: A coupon provided on a fixed basis for promotional purposes. Event Coupon: A coupon created for a specific event. Partner: A coupon created for a specific partner's products. Customer Compensation Coupon: A coupon created to compensate a customer claim.</td><td></td></tr></tbody></table>

## Other Notes

* **Targeted Issuance**: A system that automatically issues a coupon to specific members.
* **Conditional Automatic Issuance**: A system that automatically issues a coupon, via a daily batch, to members who meet specific set conditions.
* **Customer Download Issuance**: A system in which customers directly obtain the coupon from within the shopping mall pages.
* **Cost Share Ratio**: A system that coordinates the cost incurred from the coupon between the company and its partner.
* **Coupon and Discount Policy**

<table data-full-width="true"><thead><tr><th width="94.6666259765625">Category</th><th width="112.4444580078125">1st Discount</th><th width="307.9998779296875">2nd Discount</th><th width="81.333251953125"></th><th width="90.22216796875"></th><th width="394.6666259765625">3rd Discount</th><th></th></tr></thead><tbody><tr><td>Type</td><td>Selling price discount (single-item discount)</td><td>Product discount coupon</td><td>Employee discount</td><td>Immediate product discount</td><td>Stackable discount coupon</td><td>Cart coupon</td></tr><tr><td>Discount Type</td><td>Fixed amount</td><td>Fixed amount/Percentage</td><td>Percentage</td><td>Percentage</td><td>Fixed amount/Percentage</td><td>Fixed amount/Percentage</td></tr><tr><td>Characteristics</td><td>Set when the product is registered</td><td><ul><li>Another discount type within the same tier cannot be selected (cannot be used simultaneously)<br>(e.g., 2nd-tier product coupon + employee discount cannot be used together)</li><li>When calculating the maximum benefit price, the larger amount is applied first</li><li>If amounts are equal, applied in the order of immediate product discount -> product discount coupon -> employee discount</li></ul></td><td></td><td></td><td><ul><li>Another discount type within the same tier cannot be selected (cannot be used simultaneously)</li><li>3rd-tier discount can be used independently.</li><li>When calculating the maximum benefit price, the larger amount is applied first</li><li>If amounts are equal, applied in order of the coupon's validity end date</li></ul></td><td></td></tr><tr><td>Calculation Base Amount</td><td>Selling price</td><td>Price after 1st discount applied</td><td></td><td></td><td>Price after 2nd discount applied</td><td></td></tr><tr><td>Minimum Purchase Criteria</td><td>N/A</td><td>Quantity: fixed at 1 Amount: selling price of 1 unit of the product</td><td>N/A</td><td>N/A</td><td>Quantity: fixed at 1 Amount: selling price of 1 unit of the product</td><td>Quantity: sum of eligible products Amount: sum of the post-discount amounts of eligible products (previous tier)</td></tr><tr><td>Application Basis</td><td>Adjusts the product's selling price</td><td>Applies an individual discount to all quantities of the product</td><td></td><td></td><td></td><td>Applies a discount to all quantities of eligible products</td></tr><tr><td>Margin Check</td><td>At product registration</td><td>Coupon/discount is exposed and usable only when “supply price >= selling price - discount amount”</td><td></td><td></td><td></td><td></td></tr><tr><td>3rd-Tier Discount Applicability</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>Common Application Rules</td><td>N/A</td><td><ul><li>Discounts can be applied in 1-won increments, and any amount under 1 won is rounded.</li><li>Promotions are recalculated only when a claim is filed before all products in the order have shipped.</li><li>To prevent a 0-won payment, coupons/discounts with a discount amount greater than the selling price cannot be used.</li></ul></td><td></td><td></td><td></td><td></td></tr></tbody></table>