> 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/api-en/store-front-api-reference/order-api/coupon-issuance.md). # Coupon Issuance ## Look Up Downloadable Coupons for Product Detail > \## Function Description\ > \* Looks up coupons downloadable/usable for a product\ > \---\ > \## Detailed Description\ > \* \*\*This is a member-only API; non-members cannot use it.\*\*\ > \* Looks up coupons downloadable/usable for the product.\ > \* Usable coupon lookup (coupon type = 10)\ > \* Lookup conditions\ > \* \*\*Promotion type\*\*: Product discount coupon, cart coupon, stacking discount coupon, free-shipping coupon, free-return coupon\ > \* \*\*Coupon issuer\*\*: All\ > \* \*\*Coupon issuance method\*\*: All\ > \* Downloadable coupon lookup (coupon type = 20)\ > \* Lookup conditions\ > \* \*\*Promotion type\*\*: Product discount coupon, cart coupon, stacking discount coupon, free-shipping coupon, free-return coupon\ > \* \*\*Coupon issuer\*\*: Fixed promotional coupon\ > \* \*\*Coupon issuance method\*\*: Customer download issuance, discount coupon code issuance\ > \---\ > \## Revision History\ > \* Release v2.00\_240425: Added minimum purchase amount and maximum discount amount data\ > \* Release v2.00\_240509: Added lookup of applicable target - special exhibition information
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/goodsDetailCpnList":{"post":{"tags":["Coupon Issuance"],"summary":"Look Up Downloadable Coupons for Product Detail","description":"## Function Description\n* Looks up coupons downloadable/usable for a product\n---\n## Detailed Description\n* **This is a member-only API; non-members cannot use it.**\n* Looks up coupons downloadable/usable for the product.\n* Usable coupon lookup (coupon type = 10)\n * Lookup conditions\n * **Promotion type**: Product discount coupon, cart coupon, stacking discount coupon, free-shipping coupon, free-return coupon\n * **Coupon issuer**: All\n * **Coupon issuance method**: All\n* Downloadable coupon lookup (coupon type = 20)\n * Lookup conditions\n * **Promotion type**: Product discount coupon, cart coupon, stacking discount coupon, free-shipping coupon, free-return coupon\n * **Coupon issuer**: Fixed promotional coupon\n * **Coupon issuance method**: Customer download issuance, discount coupon code issuance\n---\n## Revision History\n* Release v2.00_240425: Added minimum purchase amount and maximum discount amount data\n* Release v2.00_240509: Added lookup of applicable target - special exhibition information\n","operationId":"getCpnListForGoodsDetail","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsDetailCpnListRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoodsDetailCpnListResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"GoodsDetailCpnListRequest":{"required":["cpnType","goodsList","ordMediaCd","pageIdx","rowsPerPage","sortGb"],"type":"object","properties":{"ordMediaCd":{"type":"string","description":"Order Channel Code (OM007)\n 10 : Phone Consultation (CC)\n, 20 : PC\n, 30 : Mobile Web\n, 40 : Android App\n, 50 : iOS App\n, 60 : Subscription Order\n","enum":["10","20","30","40","50","60"]},"cpnType":{"type":"string","description":"Product Detail Coupon Search Condition\n 10 : Usable Coupons\n , 20 : Downloadable Coupons\n","enum":["10","20"]},"sortGb":{"type":"string","description":"Coupon Sort Order\n 10 : Most Recently Registered\n , 20 : Expiring Soon\n","enum":["10","20"]},"rowsPerPage":{"type":"integer","description":"Display Quantity per Screen","format":"int32"},"pageIdx":{"type":"integer","description":"Page No.","format":"int32"},"goodsList":{"type":"array","description":"Product List","items":{"$ref":"#/components/schemas/GoodsDetailGoodsInfo"}}}},"GoodsDetailGoodsInfo":{"required":["brandNo","chlNo","cnt","dispCtgNo","entrNo","goodsNo","infDispCtgNo","infDispCtgNoGbCd","itmNo","norPrc","salePrc","stdCtgNo","supPcost"],"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"supPcost":{"type":"integer","description":"Supply Cost","format":"int64"},"norPrc":{"type":"integer","description":"Regular Price","format":"int64"},"salePrc":{"type":"integer","description":"Selling Price","format":"int64"},"cnt":{"type":"integer","description":"Quantity","format":"int32"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"brandNo":{"type":"string","description":"Brand No."},"entrNo":{"type":"string","description":"Vendor No."},"chlNo":{"type":"string","description":"Channel No."},"infDispCtgNoGbCd":{"type":"string","description":"Inflow Display Category No. Classification Code"},"infDispCtgNo":{"type":"string","description":"Referral Display Category No."},"marketingDisplayNo":{"type":"string","description":"Special Exhibition No."}},"description":"Product List"},"GoodsDetailCpnListResponse":{"required":["cpnIssuList","pageIdx","promoCnt","rowsPerPage"],"type":"object","properties":{"promoCnt":{"type":"integer","description":"Coupon Issuance Quantity","format":"int32"},"rowsPerPage":{"type":"integer","description":"Display Quantity per Screen","format":"int32"},"pageIdx":{"type":"integer","description":"Page No.","format":"int32"},"cpnIssuList":{"type":"array","description":"Issued Coupon List","items":{"$ref":"#/components/schemas/GoodsDetailCpnInfo"}}}},"GoodsDetailCpnInfo":{"required":["dcRateAmt","fixamtFxrtGbCd","maxDcAmt","minBuyAmt","promoNm","promoNo","promoTypCd"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"promoDesc":{"type":"string","description":"Promotion Description"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"valiStrtDtm":{"type":"string","description":"Validity Start Date/Time","format":"date-time"},"valiEndDtm":{"type":"string","description":"Validity End Date/Time","format":"date-time"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code (MK005)\n 01: Fixed Amount\n , 02: Fixed Rate\n","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Discount Amount","format":"int64"}},"description":"Issued Coupon List"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}} ``` ## Download Coupon (FO) > \## Function Description\ > \* An API used to download a coupon on FO.\ > \---\ > \## Detailed Description\ > \* \*\*This is a member-only API; non-members cannot use it.\*\*\ > \* Promotion number\ > \* Only coupons with issuance method code 03 (customer download issuance) can be downloaded.\ > \* To receive multiple copies of the same coupon, enter the promotion number the desired number of times.\ > \* Discount coupon code\ > \* Only coupons with issuance method code 04 (discount coupon code issuance) can be downloaded.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/cpnDown":{"post":{"tags":["Coupon Issuance"],"summary":"Download Coupon (FO)","description":"## Function Description\n* An API used to download a coupon on FO.\n---\n## Detailed Description\n* **This is a member-only API; non-members cannot use it.**\n* Promotion number\n * Only coupons with issuance method code 03 (customer download issuance) can be downloaded.\n * To receive multiple copies of the same coupon, enter the promotion number the desired number of times.\n* Discount coupon code\n * Only coupons with issuance method code 04 (discount coupon code issuance) can be downloaded.\n","operationId":"cpnDownFo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnDownFoRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CpnDownResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CpnDownFoRequest":{"type":"object","properties":{"promoNoList":{"type":"array","description":"Promotion No. (cpnNo)","items":{"type":"string","description":"Promotion No. (cpnNo)"}},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"downloadByPromoNo":{"type":"boolean"}}},"CpnDownResponse":{"required":["cpnIssuList"],"type":"object","properties":{"cpnIssuList":{"type":"array","description":"Coupon Issuance Information","items":{"$ref":"#/components/schemas/CpnIsuInfo"}}}},"CpnIsuInfo":{"required":["cpnIsuNo","promoNm","promoNo"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Coupon Issuance Information"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}} ``` ## Download Coupon (BO) > \## Function Description\ > \* An API used for coupon download from the batch or BO.\ > \---\ > \## Detailed Description\ > \* If the issuance method code is a conditional auto-issue coupon, it is issued according to the auto-issue quantity.\ > \* System user number\ > \* Batch: BATCH\ > \* BO: the system user's ID
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/cpnDownBo":{"post":{"tags":["Coupon Issuance"],"summary":"Download Coupon (BO)","description":"## Function Description\n* An API used for coupon download from the batch or BO.\n---\n## Detailed Description\n* If the issuance method code is a conditional auto-issue coupon, it is issued according to the auto-issue quantity.\n* System user number\n * Batch: BATCH\n * BO: the system user's ID\n","operationId":"cpnDownBo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnDownBoRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CpnDownResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CpnDownBoRequest":{"required":["autoIssuOdr","mbrNo","promoNoList","systemUserNo"],"type":"object","properties":{"promoNoList":{"type":"array","description":"Promotion No. (cpnNo)","items":{"type":"string","description":"Promotion No. (cpnNo)"}},"mbrNo":{"type":"string","description":"Member No."},"csCpnPayCausCd":{"type":"string","description":"Coupon Issuance Reason Code (MK021)\n 01 : Product Defect\n, 02 : Delivery Delay\n, 03 : Incorrect Product Shipped\n, 04 : Product Out of Stock\n, 05 : Out-of-Stock Cancellation\n, 06 : Missing Product\n, 07 : Event Complaint\n, 08 : Site Error\n, 09 : Coupon Reissuance Due to Reorder\n, 10 : Coupon Reissuance Due to Exchange\n, 11 : Difficult Customer Claim\n, 12 : Other\n","enum":["01","02","03","04","05","06","07",8,9,"10","11","12"]},"systemUserNo":{"type":"string","description":"System User No."},"autoIssuOdr":{"type":"string","description":"Auto-Issuance Batch No."},"downloadByPromoNo":{"type":"boolean"},"dcCpnCd":{"type":"string"}}},"CpnDownResponse":{"required":["cpnIssuList"],"type":"object","properties":{"cpnIssuList":{"type":"array","description":"Coupon Issuance Information","items":{"$ref":"#/components/schemas/CpnIsuInfo"}}}},"CpnIsuInfo":{"required":["cpnIsuNo","promoNm","promoNo"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."}},"description":"Coupon Issuance Information"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}} ``` ## Search Coupons by Auto-Issue Type > \## Function Description\ > \* Retrieves coupon information matching the auto-issue type code.\ > \---\ > \## Detailed Description\ > \* Can be used when a batch or program wants to issue coupons matching the same auto-issue type.\ > \* For example, to issue a birthday congratulation coupon, add the corresponding code to MK008,\ > \* then select that code as the auto-issue type on the coupon registration screen when registering.\ > \* Afterward, if the request of this API is set with the added code, it returns the list of coupons registered with that code.
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/getCouponListByAutoIssuTypCd":{"get":{"tags":["Coupon Issuance"],"summary":"Search Coupons by Auto-Issue Type","description":"## Function Description\n* Retrieves coupon information matching the auto-issue type code.\n---\n## Detailed Description\n* Can be used when a batch or program wants to issue coupons matching the same auto-issue type.\n* For example, to issue a birthday congratulation coupon, add the corresponding code to MK008,\n* then select that code as the auto-issue type on the coupon registration screen when registering.\n* Afterward, if the request of this API is set with the added code, it returns the list of coupons registered with that code.\n","operationId":"getCouponListByAutoIssuTypCd","parameters":[{"name":"autoIssuTypCd","in":"query","description":"Auto-Issue Type Code (MK008)","required":true,"schema":{"type":"string"}},{"name":"gradeCd","in":"query","description":"Member Grade Code (ME008)","required":false,"schema":{"type":"string","description":"Member Grade Code (ME008)\n 10 : GREEN\n, 20 : FAMILY\n, 30 : GOLD\n, 40 : VIP\n, 50 : VVIP\n","enum":["10","20","30","40","50"]}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponByAutoIssuTypInfo"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"CouponByAutoIssuTypInfo":{"type":"object","properties":{"promoNo":{"type":"string"},"promoNm":{"type":"string"},"promoTypCd":{"type":"string"},"ourChrgRate":{"type":"integer","format":"int32"},"entrChrgRate":{"type":"integer","format":"int32"},"fixAmtFxrtGbCd":{"type":"string"},"dcRateAmt":{"type":"integer","format":"int64"},"minBuyAmt":{"type":"integer","format":"int64"},"maxDcAmt":{"type":"integer","format":"int64"},"autoIssuPotmCd":{"type":"string"},"anvyPreIsuDds":{"type":"integer","format":"int32"}},"description":"Promotion Info"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}} ``` ## Search Coupons by Member > \## Function Description\ > \* Retrieves the coupon information held by the user in My Page's Coupon Box.\ > \---\ > \## Detailed Description\ > \* \*\*This is a member-only API; non-members cannot use it.\*\*\ > \* Retrieves the coupon information held by the user.\ > \* However, coupons withdrawn by the administrator are not shown.\ > \## Revision History\ > \* Release v2.00\_240401: Added minimum purchase quantity, minimum purchase amount, maximum applicable amount, and applicable media to My Page coupon information\ > \* Release v2.00\_240425: Added site search condition
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/marketing/cpnIssuList":{"get":{"tags":["Coupon Issuance"],"summary":"Search Coupons by Member","description":"## Function Description\n* Retrieves the coupon information held by the user in My Page's Coupon Box.\n---\n## Detailed Description\n* **This is a member-only API; non-members cannot use it.**\n* Retrieves the coupon information held by the user.\n* However, coupons withdrawn by the administrator are not shown.\n## Revision History\n* Release v2.00_240401: Added minimum purchase quantity, minimum purchase amount, maximum applicable amount, and applicable media to My Page coupon information\n* Release v2.00_240425: Added site search condition\n","operationId":"getCpnIssuList","parameters":[{"name":"sortGb","in":"query","description":"Coupon Sort Order 10: Most Recently Registered, 20: Expiring Soon","required":true,"schema":{"type":"string","description":"Coupon Sort Order\n 10 : Most Recently Registered\n , 20 : Expiring Soon\n","enum":["10","20"]}},{"name":"rowsPerPage","in":"query","description":"Display Quantity per Screen","required":true,"schema":{"type":"integer","description":"Display Quantity per Screen"}},{"name":"pageIdx","in":"query","description":"Page No.","required":true,"schema":{"type":"integer","description":"Page No."}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MypageResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"MypageResponse":{"required":["promoCnt","totPromoCnt"],"type":"object","properties":{"promoCnt":{"type":"integer","description":"Total Usable Coupon Quantity","format":"int32"},"totPromoCnt":{"type":"integer","description":"Total Issued Coupon Quantity","format":"int32"},"rowsPerPage":{"type":"integer","description":"Display Quantity per Screen","format":"int32"},"pageIdx":{"type":"integer","description":"Page No.","format":"int32"},"cpnIssuList":{"type":"array","description":"Issued Coupon List","items":{"$ref":"#/components/schemas/MypageCpnInfo"}}}},"MypageCpnInfo":{"required":["cpnIsuNo","dcRateAmt","fixamtFxrtGbCd","promoNm","promoNo","promoStat","promoTypCd","remainingDay","valiEndDtm","valiStrtDtm"],"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No. (cpnNo)"},"promoNm":{"type":"string","description":"Promotion Name (Coupon Name)"},"promoTypCd":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n , 12 : Cart Coupon\n , 13 : Stackable Discount Coupon\n , 14 : Free Shipping Coupon\n , 15 : Free Return Coupon\n , 20 : Employee Discount\n , 21 : Instant Product Discount\n , 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]},"promoDesc":{"type":"string","description":"Promotion Description"},"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"valiStrtDtm":{"type":"string","description":"Validity Start Date/Time","format":"date-time"},"valiEndDtm":{"type":"string","description":"Validity End Date/Time","format":"date-time"},"remainingDay":{"type":"string","description":"Remaining Days"},"promoStat":{"type":"string","description":"Coupon Usage Status\n 10 : Usable\n, 20 : Used\n, 30 : Expired\n","enum":["10","20","30"]},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code (MK005)\n 01: Fixed Amount\n , 02: Fixed Rate\n","enum":["01","02"]},"dcRateAmt":{"type":"integer","description":"Discount Rate/Amount","format":"int64"},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"minBuyQty":{"type":"integer","description":"Minimum Purchase Quantity","format":"int32"},"minBuyAmt":{"type":"integer","description":"Minimum Purchase Amount","format":"int64"},"maxDcAmt":{"type":"integer","description":"Maximum Applicable Amount","format":"int64"},"mediaCdNmArray":{"type":"string","description":"Applicable Media"}},"description":"Issued Coupon List"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}},"description":"validation error list"}}}} ```