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

# Promotion Management

## Change Coupon Status

> \## Function Description\
> \* Saves the changed status for each coupon.\
> \---\
> \## Detailed Description\
> \* Saves the coupon status changed for each coupon on the Coupon Management screen.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CouponRequest":{"type":"object","properties":{"searchDateType":{"type":"string","description":"Search Period Type Code (0: Display Start Date, 1: Usage Start Date, 2: Registration Date)"},"startDate":{"type":"string","format":"date","description":"Period Start Date"},"endDate":{"type":"string","format":"date","description":"Period End Date"},"userId":{"type":"string","description":"Registrant ID"},"promoTypCd":{"type":"string","description":"Coupon Type Code [MK002] (11: Product Discount Coupon, 12: Cart Coupon, 13: Overlapping Discount Coupon, 14: Free Shipping Coupon, 15: Free Return Coupon)"},"promoStatCd":{"type":"string","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)"},"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"issuMethCd":{"type":"string","description":"Issuance Method Code [MK007] (01: Designated Recipient Issuance, 02: Conditional Auto Issuance, 03: Customer Download Issuance, 04: Discount Coupon Code Issuance)"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code [MK006] (01: Fixed Promotional Coupon, 02: Event Coupon, 04: Affiliate, 05: Customer Compensation Coupon)"},"autoIssuTypCd":{"type":"string","description":"Auto Issuance Type Code [MK008]"},"entiretyPeriodYn":{"type":"string","description":"All Period Status"}},"required":["endDate","searchDateType","startDate"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/couponMgmt/saveCouponState":{"post":{"tags":["Promotion Management"],"summary":"Change Coupon Status","description":"## Function Description\n* Saves the changed status for each coupon.\n---\n## Detailed Description\n* Saves the coupon status changed for each coupon on the Coupon Management screen.\n","operationId":"saveCouponState","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponRequest"}}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register and Update Discount/Mileage

> \## Function Description\
> \* Saves the entered discount/mileage information.\
> \---\
> \## Detailed Description\
> \* Saves the detailed information of the entered discount/mileage (basic information, discount/mileage benefits, applicable targets, excluded targets).\
> &#x20; \* \*\*When a discount/mileage number is present\*\*: Discount/mileage registration\
> &#x20; \* \*\*When a discount/mileage number is absent\*\*: Discount/mileage modification\
> \* Unlike coupons, discount/mileage benefits are 100% company-funded, with no limits on minimum purchase quantity, minimum purchase amount, or maximum discount amount.\
> \* Additional validation is performed according to each condition based on the selected discount/mileage type.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PromotionCudRequest":{"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoNm":{"type":"string","description":"Promotion Name"},"promoGbCd":{"type":"string","description":"Coupon Type (MK001)","enum":["10","20"]},"promoTypCd":{"type":"string","description":"Promotion Type","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"Promotion Status","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"Display Start Date and Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Display End Date and Time"},"promoDesc":{"type":"string","description":"Promotion Description"},"comGbCd":{"type":"string","description":"Company Classification Code (ME038)","enum":["P00"]},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"Applicable Media List"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"Applicable Member Grade List"}},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code (MK005)","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"Discount Rate/Amount"},"aplySites":{"type":"array","items":{"type":"string","description":"Application Condition - Site"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Product"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Standard Category"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"Applicable Condition - Brand"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"Applicable Condition - Vendor"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"Applicable Condition - Channel"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Standard Category"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Brand"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Vendor"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Product"}}},"required":["aplyPsbMediaCd","dcRateAmt","fixamtFxrtGbCd","mbrGradeCd","promoDesc","promoEndDtm","promoGbCd","promoNm","promoNo","promoStatCd","promoStrDtm","promoTypCd"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/promotionMgmt/registerPromotion":{"post":{"tags":["Promotion Management"],"summary":"Register and Update Discount/Mileage","description":"## Function Description\n* Saves the entered discount/mileage information.\n---\n## Detailed Description\n* Saves the detailed information of the entered discount/mileage (basic information, discount/mileage benefits, applicable targets, excluded targets).\n  * **When a discount/mileage number is present**: Discount/mileage registration\n  * **When a discount/mileage number is absent**: Discount/mileage modification\n* Unlike coupons, discount/mileage benefits are 100% company-funded, with no limits on minimum purchase quantity, minimum purchase amount, or maximum discount amount.\n* Additional validation is performed according to each condition based on the selected discount/mileage type.\n","operationId":"cudPromotion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Save Mileage Standard Info

> \## Function Description\
> \* Saves the mileage standard information list.\
> \---\
> \## Detailed Description\
> \* Processing differs depending on whether existing data is present at the time of saving.\
> \* Existing data information is looked up by the accrual type code.\
> \* No existing data - Registration\
> &#x20;   \* Standard information: insert\
> &#x20;   \* Standard information change history: insert\
> \* Existing data present - Modification\
> &#x20;   \* Standard information: update\
> &#x20;   \* Standard information change history: update (ends the previously saved information)\
> &#x20;   \* Standard information change history: insert (newly saved information)\
> \---\
> \## Revision History\
> \* Release v1.03\_231106: Initial development of mileage standard information<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SaveMilgStdDetailRequest":{"type":"object","properties":{"rsrvGbCd":{"type":"string","description":"Accrual Classification Code (CM016)","enum":["100","110","120","130","200","210","220"]},"rsrvTgtCd":{"type":"string","description":"Accrual Target Code (CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]},"milgTypNm":{"type":"string","description":"Mileage Type Name"},"baseRsrvRate":{"type":"number","format":"double","description":"Base Accrual Rate"},"addRsrvAmt":{"type":"number","description":"Additional Accrual Amount"},"rsrvStdAmt":{"type":"number","description":"Accrual Standard Amount"},"rsrvStdDds":{"type":"integer","format":"int32","description":"Accrual Reference Days"},"valiTermDds":{"type":"integer","format":"int32","description":"Validity Period (Days)"},"mmMaxRsrvAmt":{"type":"number","description":"Monthly Maximum Accrual Amount"},"yyMaxRsrvAmt":{"type":"number","description":"Annual Maximum Accrual Amount"},"mmMaxRsrvUseYn":{"type":"string","description":"Monthly Limit Usage Status (Y=Maximum Set, N=Unlimited)"},"yyMaxRsrvUseYn":{"type":"string","description":"Annual Limit Usage Status (Y=Maximum Set, N=Unlimited)"},"useYn":{"type":"string","description":"Accrual Standard Usage Status (Y=Used, N=Not Used)"},"chgCausDesc":{"type":"string","description":"Change Reason Description"},"rmkCont":{"type":"string","description":"Remarks"}},"required":["milgTypNm","rsrvGbCd","rsrvTgtCd"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/mileageMgmt/saveMilgStdDetail":{"post":{"tags":["Promotion Management"],"summary":"Save Mileage Standard Info","description":"## Function Description\n* Saves the mileage standard information list.\n---\n## Detailed Description\n* Processing differs depending on whether existing data is present at the time of saving.\n* Existing data information is looked up by the accrual type code.\n* No existing data - Registration\n    * Standard information: insert\n    * Standard information change history: insert\n* Existing data present - Modification\n    * Standard information: update\n    * Standard information change history: update (ends the previously saved information)\n    * Standard information change history: insert (newly saved information)\n---\n## Revision History\n* Release v1.03_231106: Initial development of mileage standard information\n","operationId":"saveMilgStdDetail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveMilgStdDetailRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Reclaim Coupon

> \## Function Description\
> \* Reclaims a coupon issued to a user.\
> \---\
> \## Detailed Description\
> \* Reclaims a coupon issued to a user.\
> \* A reclaimed coupon is no longer displayed in the user's coupon wallet.\
> \* \*\*A coupon that has already been used cannot be reclaimed.\*\*<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CpnIsuNoListRequest":{"type":"object","properties":{"cpnIsuNoList":{"type":"array","items":{"type":"string","description":"Coupon Issuance No."}},"valiStrtDtm":{"type":"string","format":"date-time","description":"Coupon Period Change Valid Start Date and Time"},"valiEndDtm":{"type":"string","format":"date-time","description":"Coupon Period Change Valid End Date and Time"}},"required":["cpnIsuNoList"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/withdrawCoupon":{"post":{"tags":["Promotion Management"],"summary":"Reclaim Coupon","description":"## Function Description\n* Reclaims a coupon issued to a user.\n---\n## Detailed Description\n* Reclaims a coupon issued to a user.\n* A reclaimed coupon is no longer displayed in the user's coupon wallet.\n* **A coupon that has already been used cannot be reclaimed.**\n","operationId":"withdrawCoupon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnIsuNoListRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register/Modify Coupon

> \## Function Description\
> \* Saves the entered coupon information.\
> \---\
> \## Detailed Description\
> \* Saves the detailed information of the entered coupon (basic information, coupon benefit, applicable targets, excluded targets).\
> &#x20; \* \*\*If a coupon number exists\*\*: Register coupon\
> &#x20; \* \*\*If a coupon number does not exist\*\*: Modify coupon\
> \* Performs additional validation according to the selected coupon type, issuer, and issuance type.\
> \## Revision History\
> \* Release v2.00\_240509: Added saving of applicable target - special promotion information<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CouponMgmtCudRequest":{"type":"object","description":"Coupon Save Request","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoGbCd":{"type":"string","description":"Coupon/Promotion Classification Code","enum":["10","20"]},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"},"ourChrgRate":{"type":"integer","format":"int32","description":"Company Cost-Sharing Rate"},"entrChrgRate":{"type":"integer","format":"int32","description":"Vendor Cost-Sharing Rate"},"promoDesc":{"type":"string","description":"Coupon Description"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"Per-Member Issuance Limit Status"},"idIssuQty":{"type":"integer","format":"int32","description":"Per-Member Issuance Limit Count"},"totCpnIssuLmtYn":{"type":"string","description":"Total Issuance Limit Status"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"Total Issuance Limit Count"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"Applicable Media Code"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"Member Grade Code"}},"issuMethCd":{"type":"string","description":"Issuance Method Code","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"Issuance Type Code (MK008)"},"aplyTermGbCd":{"type":"string","description":"Application Period Classification Code","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"Coupon Usage Days from Issuance Date"},"usePsbStrDt":{"type":"string","description":"Usage Available Start Date"},"usePsbEndDt":{"type":"string","description":"Usage Available End Date"},"useWdayCd":{"type":"array","items":{"type":"string","description":"Usable Day of Week Code"}},"tmCpnYn":{"type":"string","description":"Time Coupon Status"},"usePsbStrTm":{"type":"string","description":"Time Coupon Start Time"},"usePsbEndTm":{"type":"string","description":"Time Coupon End Time"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"Discount Rate/Amount"},"minBuyQty":{"type":"integer","format":"int32","description":"Minimum Purchase Quantity"},"minBuyAmt":{"type":"number","description":"Minimum Purchase Amount"},"maxDcAmt":{"type":"number","description":"Maximum Discount Amount"},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"autoIssuPotmCd":{"type":"string","description":"Auto Issuance Timing Code","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"Anniversary Advance Issuance Days"},"cpbookDispYn":{"type":"string","description":"Coupon Book Display Status"},"dcCpbookCd":{"type":"string","description":"Discount Coupon Book Code (MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"Auto-Issuance Quantity"},"aplySites":{"type":"array","items":{"type":"string","description":"Application Condition - Site"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Product"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Standard Category"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"Applicable Condition - Brand"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"Applicable Condition - Vendor"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"Applicable Condition - Channel"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"string","description":"Application Condition - Special Promotion"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Product"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Standard Category"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Brand"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Vendor"}}},"required":["entrChrgRate","fixamtFxrtGbCd","idIssuLmtYn","issuSubCd","ourChrgRate","promoDesc","promoEndDtm","promoGbCd","promoNm","promoNo","promoStatCd","promoStrDtm","promoTypCd","totCpnIssuLmtYn"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/registerCoupon":{"post":{"tags":["Promotion Management"],"summary":"Register/Modify Coupon","description":"## Function Description\n* Saves the entered coupon information.\n---\n## Detailed Description\n* Saves the detailed information of the entered coupon (basic information, coupon benefit, applicable targets, excluded targets).\n  * **If a coupon number exists**: Register coupon\n  * **If a coupon number does not exist**: Modify coupon\n* Performs additional validation according to the selected coupon type, issuer, and issuance type.\n## Revision History\n* Release v2.00_240509: Added saving of applicable target - special promotion information\n","operationId":"registerCoupon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponMgmtCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Issue Member Coupon

> \## Function Description\
> \* Issues a coupon to valid members among the entered members.\
> \---\
> \## Detailed Description\
> \* Issues a coupon to members among the entered members who meet the conditions of the entered coupon.\
> \* Coupon conditions\
> &#x20; \* Basic information\
> &#x20; \* Promotion period\
> &#x20; \* Issuance count limit<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CcCpnIsuMbr":{"type":"object","description":"Member Coupon Issuance Request","properties":{"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"mbrNo":{"type":"string","description":"Member No."},"cpnNo":{"type":"string","description":"Coupon No."},"cpnIsuDtm":{"type":"string","format":"date-time","description":"Coupon Issuance Date/Time"},"valiStrtDtm":{"type":"string","format":"date-time","description":"Validity Start Date/Time"},"valiEndDtm":{"type":"string","format":"date-time","description":"Validity End Date/Time"},"orgCpnIsuNo":{"type":"string","description":"Original Coupon Issuance No."},"useGbCd":{"type":"string","description":"Usage Type Code (ME014)"},"useYn":{"type":"string","description":"Usage Status"},"useDtm":{"type":"string","format":"date-time","description":"Usage Date/Time"},"payNo":{"type":"string","description":"Payment Number"},"mbrNtcYn":{"type":"string","description":"Member Notification Status"},"csCpnPayCausCd":{"type":"string","description":"CS Coupon Payment Reason Code (MK021)"},"mgrMemo":{"type":"string","description":"Management Memo"},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"integer","format":"int32","description":"Order Sequence No."},"ordProcSeq":{"type":"integer","format":"int32","description":"Order Processing Sequence No."},"autoIssuOdr":{"type":"string","description":"Auto-Issuance Batch No."}},"required":["autoIssuOdr","cpnIsuDtm","cpnIsuNo","cpnNo","csCpnPayCausCd","mbrNo","mbrNtcYn","mgrMemo","ordNo","ordProcSeq","ordSeq","orgCpnIsuNo","payNo","useDtm","useGbCd","useYn","valiEndDtm","valiStrtDtm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/registCouponIssuedMember":{"post":{"tags":["Promotion Management"],"summary":"Issue Member Coupon","description":"## Function Description\n* Issues a coupon to valid members among the entered members.\n---\n## Detailed Description\n* Issues a coupon to members among the entered members who meet the conditions of the entered coupon.\n* Coupon conditions\n  * Basic information\n  * Promotion period\n  * Issuance count limit\n","operationId":"registCouponIssuedMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CcCpnIsuMbr"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Change Coupon Period

> \## Function Description\
> \* Changes the validity period of a coupon issued to a user.\
> \---\
> \## Detailed Description\
> \* Changes the validity period of a coupon issued to a user.\
> \* \*\*The period cannot be changed if the coupon has already been used.\*\*<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CpnIsuNoListRequest":{"type":"object","properties":{"cpnIsuNoList":{"type":"array","items":{"type":"string","description":"Coupon Issuance No."}},"valiStrtDtm":{"type":"string","format":"date-time","description":"Coupon Period Change Valid Start Date and Time"},"valiEndDtm":{"type":"string","format":"date-time","description":"Coupon Period Change Valid End Date and Time"}},"required":["cpnIsuNoList"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/modifyCouponValiDtm":{"post":{"tags":["Promotion Management"],"summary":"Change Coupon Period","description":"## Function Description\n* Changes the validity period of a coupon issued to a user.\n---\n## Detailed Description\n* Changes the validity period of a coupon issued to a user.\n* **The period cannot be changed if the coupon has already been used.**\n","operationId":"modifyCouponValiDtm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnIsuNoListRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve List of Coupons with the Same Issuance Type

> \## Function Description\
> \* Retrieves coupon information with the same issuance type.\
> \---\
> \## Detailed Description\
> \* Retrieves coupon information that has the same issuance type and whose promotion period is after the current date.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CouponMgmtCudRequest":{"type":"object","description":"Coupon Save Request","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoGbCd":{"type":"string","description":"Coupon/Promotion Classification Code","enum":["10","20"]},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"},"ourChrgRate":{"type":"integer","format":"int32","description":"Company Cost-Sharing Rate"},"entrChrgRate":{"type":"integer","format":"int32","description":"Vendor Cost-Sharing Rate"},"promoDesc":{"type":"string","description":"Coupon Description"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"Per-Member Issuance Limit Status"},"idIssuQty":{"type":"integer","format":"int32","description":"Per-Member Issuance Limit Count"},"totCpnIssuLmtYn":{"type":"string","description":"Total Issuance Limit Status"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"Total Issuance Limit Count"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"Applicable Media Code"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"Member Grade Code"}},"issuMethCd":{"type":"string","description":"Issuance Method Code","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"Issuance Type Code (MK008)"},"aplyTermGbCd":{"type":"string","description":"Application Period Classification Code","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"Coupon Usage Days from Issuance Date"},"usePsbStrDt":{"type":"string","description":"Usage Available Start Date"},"usePsbEndDt":{"type":"string","description":"Usage Available End Date"},"useWdayCd":{"type":"array","items":{"type":"string","description":"Usable Day of Week Code"}},"tmCpnYn":{"type":"string","description":"Time Coupon Status"},"usePsbStrTm":{"type":"string","description":"Time Coupon Start Time"},"usePsbEndTm":{"type":"string","description":"Time Coupon End Time"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"Discount Rate/Amount"},"minBuyQty":{"type":"integer","format":"int32","description":"Minimum Purchase Quantity"},"minBuyAmt":{"type":"number","description":"Minimum Purchase Amount"},"maxDcAmt":{"type":"number","description":"Maximum Discount Amount"},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"autoIssuPotmCd":{"type":"string","description":"Auto Issuance Timing Code","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"Anniversary Advance Issuance Days"},"cpbookDispYn":{"type":"string","description":"Coupon Book Display Status"},"dcCpbookCd":{"type":"string","description":"Discount Coupon Book Code (MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"Auto-Issuance Quantity"},"aplySites":{"type":"array","items":{"type":"string","description":"Application Condition - Site"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Product"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Standard Category"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"Applicable Condition - Brand"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"Applicable Condition - Vendor"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"Applicable Condition - Channel"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"string","description":"Application Condition - Special Promotion"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Product"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Standard Category"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Brand"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Vendor"}}},"required":["entrChrgRate","fixamtFxrtGbCd","idIssuLmtYn","issuSubCd","ourChrgRate","promoDesc","promoEndDtm","promoGbCd","promoNm","promoNo","promoStatCd","promoStrDtm","promoTypCd","totCpnIssuLmtYn"]},"CouponResponse":{"type":"object","description":"Coupon Management Retrieval Response","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoTypNm":{"type":"string","description":"Coupon Type Name"},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStatNm":{"type":"string","description":"Coupon Status Name"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"fixamtFxrtGbNm":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Name"},"dcRateAmt":{"type":"number","description":"Discount Amount (Rate)"},"promoStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"},"usePsbStrDt":{"type":"string","description":"Usage Start Date"},"usePsbEndDt":{"type":"string","description":"Usage End Date"},"issuMethCd":{"type":"string","description":"Issuance Method Code","enum":["01","02","03","04"]},"issuMethCdNm":{"type":"string","description":"Issuance Method Code Name"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code","enum":["01","02","03","04"]},"issuSubCdNm":{"type":"string","description":"Coupon Issuer Code Name"},"autoIssuTypCd":{"type":"string","description":"Issuance Type Code (MK008)"},"autoIssuTypNm":{"type":"string","description":"Issuance Type Name"},"autoIssuPotmCd":{"type":"string","description":"Auto Issuance Timing Code","enum":["01","02"]},"autoIssuPotmNm":{"type":"string","description":"Automatic Issuance Timing Name"},"anvyPreIsuDds":{"type":"string","description":"Anniversary Advance Issuance Days"}},"required":["dcRateAmt","fixamtFxrtGbCd","fixamtFxrtGbNm","promoEndDtm","promoNm","promoNo","promoStatCd","promoStatNm","promoStrDtm","promoTypCd","promoTypNm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/getValidCouponListForSameAutoIssueType":{"post":{"tags":["Promotion Management"],"summary":"Retrieve List of Coupons with the Same Issuance Type","description":"## Function Description\n* Retrieves coupon information with the same issuance type.\n---\n## Detailed Description\n* Retrieves coupon information that has the same issuance type and whose promotion period is after the current date.\n","operationId":"getValidCouponListForSameAutoIssueType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponMgmtCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Check for Loss-Making Products When Registering a Benefit

> \## Function Description\
> \* Checks whether there are any loss-making products among the applicable conditions.\
> \---\
> \## Detailed Description\
> \* Checks the applicable - product list for products with a reverse margin (loss).\
> \* A reverse margin occurs in the following case:\
> &#x20; \* Supply price > Selling price - Discount amount\
> \* Reverse margin checks are not performed for other applicable conditions or excluded targets.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PromotionGoodsOverCheckRequest":{"type":"object","properties":{"goodsList":{"type":"array","items":{"type":"string","description":"Product No."}},"fixamtFxrtGbCd":{"type":"string","description":"Current Coupon Fixed Amount/Rate Type Code","enum":["01","02"]},"dcRateAmt":{"type":"integer","format":"int64","description":"Current Coupon Discount Amount/Rate"}},"required":["dcRateAmt","fixamtFxrtGbCd","goodsList"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/getOverMrgnGoods":{"post":{"tags":["Promotion Management"],"summary":"Check for Loss-Making Products When Registering a Benefit","description":"## Function Description\n* Checks whether there are any loss-making products among the applicable conditions.\n---\n## Detailed Description\n* Checks the applicable - product list for products with a reverse margin (loss).\n* A reverse margin occurs in the following case:\n  * Supply price > Selling price - Discount amount\n* Reverse margin checks are not performed for other applicable conditions or excluded targets.\n","operationId":"getOverMrgnGoods","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionGoodsOverCheckRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Member Coupon Bulk Issuance

> \## Function Description\
> \* An API that loads member information contained in the attached form.\
> \---\
> \## Detailed Description\
> \* Retrieves member information that is valid among the member information entered in the attached form and displays it in the grid.\
> \* The registration methods that can be used in the form are as follows:\
> &#x20; \* \*\*Registration Type\*\*\
> &#x20;   \* 10: Member No.\
> &#x20;   \* 20: Login ID<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CouponIssuedMemberListRequest":{"type":"object","description":"Member Coupon Bulk Issuance Retrieval Request","properties":{"promoNo":{"type":"string","description":"Coupon No."},"couponIssuedMemberResponse":{"type":"array","items":{"$ref":"#/components/schemas/CouponIssuedMemberResponse"}}},"required":["promoNo"]},"CouponIssuedMemberResponse":{"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"orgCpnIsuNo":{"type":"string","description":"Original Coupon Issuance No."},"mbrNo":{"type":"string","description":"Member No."},"mbrNm":{"type":"string","description":"Member Name"},"loginId":{"type":"string","description":"Member ID"},"mbrGradeCd":{"type":"string","description":"Member Grade Code"},"mbrGradeNm":{"type":"string","description":"Member Grade Code Name"},"cpnNo":{"type":"string","description":"Coupon No."},"cpnIsuDtm":{"type":"string","format":"date-time","description":"Coupon Issuance Date/Time"},"valiStrtDtm":{"type":"string","format":"date-time","description":"Validity Start Date/Time"},"valiEndDtm":{"type":"string","format":"date-time","description":"Validity End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"mgrMemo":{"type":"string","description":"Coupon Management Memo"},"dataType":{"type":"string","description":"Key Value Type Code for Bulk Registration (CouponUploadMbrType. 10: Member No., 20: Login ID, 30: Legacy System Member No.)"}},"required":["cpnIsuDtm","cpnIsuNo","cpnNo","dataType","loginId","mbrGradeCd","mbrGradeNm","mbrNm","mbrNo","mgrMemo","orgCpnIsuNo","useYn","valiEndDtm","valiStrtDtm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/couponIssuedMbrLoadByExcel":{"post":{"tags":["Promotion Management"],"summary":"Retrieve Member Coupon Bulk Issuance","description":"## Function Description\n* An API that loads member information contained in the attached form.\n---\n## Detailed Description\n* Retrieves member information that is valid among the member information entered in the attached form and displays it in the grid.\n* The registration methods that can be used in the form are as follows:\n  * **Registration Type**\n    * 10: Member No.\n    * 20: Login ID\n","operationId":"couponIssuedMbrLoadByExcel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponIssuedMemberListRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponIssuedMemberResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register/Modify Gift Promotion

> \## Function Description\
> \* Saves the entered gift promotion information.\
> \---\
> \## Detailed Description\
> \* Saves the detailed information of the entered gift promotion (basic information, payment settings, applicable targets).\
> &#x20; \* \*\*If a gift promotion number exists\*\*: Modifies the existing gift promotion information.\
> &#x20; \* \*\*If a gift promotion number does not exist\*\*: Registers new gift promotion information.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.06\_231218\`\`\` : Added a check for duplicate gift item code registration when registering a promotional gift promotion<br>

````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AppreciationCudRequest":{"type":"object","description":"Gift Promotion Registration Request","properties":{"aeNo":{"type":"string","description":"Gift Event No."},"aeNm":{"type":"string","description":"Gift Event Name"},"addEvtTypCd":{"type":"string","description":"Gift Event Type Code","enum":["10","20"]},"aePrgsStatCd":{"type":"string","description":"Gift Event Status Code","enum":["10","20"]},"aeDesc":{"type":"string","description":"Gift Event Description"},"entrNo":{"type":"string","description":"Participating Vendor No."},"aeStrDtm":{"type":"string","format":"date-time","description":"Gift Promotion Start Date and Time"},"aeEndDtm":{"type":"string","format":"date-time","description":"Gift Promotion End Date and Time"},"payStrDt":{"type":"string","description":"Gift Promotion Payment Start Date"},"payEndDt":{"type":"string","description":"Gift Promotion Payment End Date"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"Applicable Media List"}},"mbrTypCd":{"type":"string","description":"Gift Promotion Applicable Target","enum":["01","02","03"]},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"Applicable Member Grade List"}},"tmEvtYn":{"type":"string","description":"Time Event Status"},"aplyStrTm":{"type":"string","description":"Time Event Start Time"},"aplyEndTm":{"type":"string","description":"Time Event End Time"},"aeFvrInfo":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Promotion Condition Information"}},"aplySites":{"type":"array","items":{"type":"string","description":"Application Condition - Site"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Product"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"Applicable Condition - Standard Category"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"Applicable Condition - Brand"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"Applicable Condition - Vendor"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"Applicable Condition - Channel"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Product"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Standard Category"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Brand"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"Exclusion Condition - Vendor"}}},"required":["addEvtTypCd","aeDesc","aeEndDtm","aeFvrInfo","aeNm","aePrgsStatCd","aeStrDtm","aplyGoods","aplyPsbMediaCd","aplySites","entrNo","mbrGradeCd","mbrTypCd"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/appreciationEventMgmt/registAppreciation":{"post":{"tags":["Promotion Management"],"summary":"Register/Modify Gift Promotion","description":"## Function Description\n* Saves the entered gift promotion information.\n---\n## Detailed Description\n* Saves the detailed information of the entered gift promotion (basic information, payment settings, applicable targets).\n  * **If a gift promotion number exists**: Modifies the existing gift promotion information.\n  * **If a gift promotion number does not exist**: Registers new gift promotion information.\n---\n## Revision History\n* ```Release v1.06_231218``` : Added a check for duplicate gift item code registration when registering a promotional gift promotion\n","operationId":"registAppreciation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppreciationCudRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Retrieve Discount/Mileage List

> \## Function Description\
> \* Retrieves registered discount/mileage information.\
> \---\
> \## Detailed Description\
> \* Retrieves discounts/mileage matching the search conditions. The search conditions are as follows:\
> &#x20; \* Discount/mileage period\
> &#x20; \* Discount/mileage type\
> &#x20; \* Discount/mileage status\
> &#x20; \* Discount/mileage No./Name\
> &#x20; \* Registrant\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed date query<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponsePromotionResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PromotionResponse"}}}},"PromotionResponse":{"type":"object","properties":{"promoNo":{"type":"string","description":"Promotion No."},"promoTypNm":{"type":"string","description":"Promotion Name"},"promoTypCd":{"type":"string","description":"Promotion Type Name"},"promoNm":{"type":"string","description":"Promotion Type","enum":["11","12","13","14","15","20","21","40"]},"promoStatNm":{"type":"string","description":"Promotion Status Name"},"promoStatCd":{"type":"string","description":"Promotion Status","enum":["10","20"]},"fixamtFxrtGbNm":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Name"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"Discount Amount (Rate)"},"promoStrDtm":{"type":"string","format":"date-time","description":"Promotion Start Date"},"promoEndDtm":{"type":"string","format":"date-time","description":"Promotion End Date"}},"required":["dcRateAmt","fixamtFxrtGbCd","fixamtFxrtGbNm","promoEndDtm","promoNm","promoNo","promoStatCd","promoStatNm","promoStrDtm","promoTypCd","promoTypNm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/promotionMgmt/getPromotionManagingList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Discount/Mileage List","description":"## Function Description\n* Retrieves registered discount/mileage information.\n---\n## Detailed Description\n* Retrieves discounts/mileage matching the search conditions. The search conditions are as follows:\n  * Discount/mileage period\n  * Discount/mileage type\n  * Discount/mileage status\n  * Discount/mileage No./Name\n  * Registrant\n---\n## Revision History\n* Release v2.00_240530: Changed date query\n","operationId":"getPromotionManagingList","parameters":[{"name":"searchDateType","in":"query","description":"Search Period Type Code (0: Application Start Date, 1: Registration Date)","required":true,"schema":{"type":"string","description":"Search Period Type Code (0: Application Start Date, 1: Registration Date)"}},{"name":"startDate","in":"query","description":"Start Date","required":true,"schema":{"type":"string","format":"date","description":"Start Date"}},{"name":"endDate","in":"query","description":"End Date","required":true,"schema":{"type":"string","format":"date","description":"End Date"}},{"name":"userId","in":"query","description":"Registrant ID","required":false,"schema":{"type":"string","description":"Registrant ID"}},{"name":"promoTypCd","in":"query","description":"Promotion Type Code [MK002] (20: Employee Discount, 21: Instant Product Discount, 40: Product Mileage)","required":false,"schema":{"type":"string","description":"Promotion Type Code [MK002] (20: Employee Discount, 21: Instant Product Discount, 40: Product Mileage)"}},{"name":"promoStatCd","in":"query","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)","required":false,"schema":{"type":"string","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)"}},{"name":"promoNo","in":"query","description":"Promotion No.","required":false,"schema":{"type":"string","description":"Promotion No."}},{"name":"promoNm","in":"query","description":"Promotion Name","required":false,"schema":{"type":"string","description":"Promotion Name"}},{"name":"entiretyPeriodYn","in":"query","description":"All Period Status","required":false,"schema":{"type":"string","description":"All Period Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePromotionResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Mileage Standard Information List/Count

> \## Function Description\
> \* Retrieves the Mileage Standard Information list.\
> \---\
> \## Detailed Description\
> \* Retrieves the Mileage Standard Information list matching the selected accrual type code.\
> \---<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseMilgStdResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/MilgStdResponse"}}}},"MilgStdResponse":{"type":"object","properties":{"milgStdInfoSeq":{"type":"string","description":" Mileage Standard Information Sequence No."},"rsrvGbCd":{"type":"string","description":" Accrual Type Code (CM016)"},"rsrvTgtCd":{"type":"string","description":" Accrual Target Code (CM017)"},"milgTypNm":{"type":"string","description":" Mileage Type Name"},"baseRsrvRate":{"type":"number","format":"double","description":" Basic Accrual Rate"},"addRsrvAmt":{"type":"number","description":" Additional Accrual Amount"},"mbrGradeCd":{"type":"string","description":" Member Grade Code (ME008)"},"rsrvStdAmt":{"type":"number","description":" Accrual Standard Amount"},"rsrvStdDds":{"type":"integer","format":"int32","description":" Accrual Standard Days"},"valiTermDds":{"type":"integer","format":"int32","description":" Validity Period Days"},"mmMaxRsrvAmt":{"type":"number","description":" Monthly Maximum Accrual Amount"},"yyMaxRsrvAmt":{"type":"number","description":" Annual Maximum Accrual Amount"},"mmMaxRsrvUseYn":{"type":"string","description":" Monthly Limit Usage Status (Y=Max Set, N=Unlimited)"},"yyMaxRsrvUseYn":{"type":"string","description":" Annual Limit Usage Status (Y=Max Set, N=Unlimited)"},"useYn":{"type":"string","description":" Accrual Standard Usage Status (Y=Used, N=Not Used)"},"chgCausDesc":{"type":"string","description":" Change Reason Description"},"rmkCont":{"type":"string","description":" Remarks"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/mileageMgmt/milgStdList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Mileage Standard Information List/Count","description":"## Function Description\n* Retrieves the Mileage Standard Information list.\n---\n## Detailed Description\n* Retrieves the Mileage Standard Information list matching the selected accrual type code.\n---\n","operationId":"getMilgStdList","parameters":[{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}},{"name":"rsrvGbCd","in":"query","description":"Accrual Classification Code (CM016)","required":true,"schema":{"type":"string","description":"Accrual Classification Code (CM016)","enum":["100","110","120","130","200","210","220"]}},{"name":"useYn","in":"query","description":"Usage Status","required":true,"schema":{"type":"string","description":"Usage Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseMilgStdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Mileage Standard Information Change History List/Count

> \## Function Description\
> \* Retrieves the Mileage Standard Information change history list.\
> \---\
> \## Detailed Description\
> \* Retrieves the Mileage Standard Information change history list matching the conditions.\
> &#x20; \* Mileage Standard Information Sequence No.\
> &#x20; \* Accrual Type Code\
> &#x20; \* Accrual Target Code\
> \---<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseMilgStdChgHistResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/MilgStdChgHistResponse"}}}},"MilgStdChgHistResponse":{"type":"object","properties":{"milgStdInfoSeq":{"type":"string","description":"Mileage Standard Information Sequence No."},"histStrDtm":{"type":"string","format":"date-time","description":"History Start Date/Time"},"histEndDtm":{"type":"string","format":"date-time","description":"History End Date/Time"},"rsrvGbCd":{"type":"string","description":"Accrual Classification Code (CM016)"},"rsrvTgtCd":{"type":"string","description":"Accrual Target Code (CM017)"},"milgTypNm":{"type":"string","description":"Mileage Type Name"},"baseRsrvRate":{"type":"number","format":"double","description":"Base Accrual Rate"},"addRsrvAmt":{"type":"number","description":"Additional Accrual Amount"},"mbrGradeCd":{"type":"string","description":"Member Grade Code (ME008)"},"rsrvStdAmt":{"type":"number","description":"Accrual Standard Amount"},"rsrvStdDds":{"type":"integer","format":"int32","description":"Accrual Reference Days"},"valiTermDds":{"type":"integer","format":"int32","description":"Validity Period (Days)"},"mmMaxRsrvAmt":{"type":"number","description":"Monthly Maximum Accrual Amount"},"yyMaxRsrvAmt":{"type":"number","description":"Annual Maximum Accrual Amount"},"mmMaxRsrvUseYn":{"type":"string","description":"Monthly Limit Usage Status (Y=Maximum Set, N=Unlimited)"},"yyMaxRsrvUseYn":{"type":"string","description":"Annual Limit Usage Status (Y=Maximum Set, N=Unlimited)"},"useYn":{"type":"string","description":"Accrual Standard Usage Status (Y=Used, N=Not Used)"},"chgCausDesc":{"type":"string","description":"Change Reason Description"},"rmkCont":{"type":"string","description":"Remarks"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/mileageMgmt/getMilgStdChgHistList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Mileage Standard Information Change History List/Count","description":"## Function Description\n* Retrieves the Mileage Standard Information change history list.\n---\n## Detailed Description\n* Retrieves the Mileage Standard Information change history list matching the conditions.\n  * Mileage Standard Information Sequence No.\n  * Accrual Type Code\n  * Accrual Target Code\n---\n","operationId":"getMilgStdChgHistList","parameters":[{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}},{"name":"milgStdInfoSeq","in":"query","description":"Mileage Reference Information Sequence No.","required":true,"schema":{"type":"string","description":"Mileage Reference Information Sequence No."}},{"name":"rsrvGbCd","in":"query","description":"Accrual Classification Code (CM016)","required":true,"schema":{"type":"string","description":"Accrual Classification Code (CM016)","enum":["100","110","120","130","200","210","220"]}},{"name":"rsrvTgtCd","in":"query","description":"Accrual Target Code (CM017)","required":true,"schema":{"type":"string","description":"Accrual Target Code (CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseMilgStdChgHistResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Coupon Management List/Count

> \## Function Description\
> \* Retrieves registered coupon information and count.\
> \---\
> \## Detailed Description\
> \* Retrieves coupon information matching the search conditions. The search conditions are as follows:\
> &#x20; \* Period (promotion period, usable period, registration period)\
> &#x20; \* Coupon type\
> &#x20; \* Coupon status\
> &#x20; \* Registrant\
> &#x20; \* Coupon No./Name\
> &#x20; \* Issuance method\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed date query<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseCouponResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CouponResponse"}}}},"CouponResponse":{"type":"object","description":"Coupon Management Retrieval Response","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoTypNm":{"type":"string","description":"Coupon Type Name"},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStatNm":{"type":"string","description":"Coupon Status Name"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"fixamtFxrtGbNm":{"type":"string","description":"Fixed Amount/Fixed Rate Classification Name"},"dcRateAmt":{"type":"number","description":"Discount Amount (Rate)"},"promoStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"},"usePsbStrDt":{"type":"string","description":"Usage Start Date"},"usePsbEndDt":{"type":"string","description":"Usage End Date"},"issuMethCd":{"type":"string","description":"Issuance Method Code","enum":["01","02","03","04"]},"issuMethCdNm":{"type":"string","description":"Issuance Method Code Name"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code","enum":["01","02","03","04"]},"issuSubCdNm":{"type":"string","description":"Coupon Issuer Code Name"},"autoIssuTypCd":{"type":"string","description":"Issuance Type Code (MK008)"},"autoIssuTypNm":{"type":"string","description":"Issuance Type Name"},"autoIssuPotmCd":{"type":"string","description":"Auto Issuance Timing Code","enum":["01","02"]},"autoIssuPotmNm":{"type":"string","description":"Automatic Issuance Timing Name"},"anvyPreIsuDds":{"type":"string","description":"Anniversary Advance Issuance Days"}},"required":["dcRateAmt","fixamtFxrtGbCd","fixamtFxrtGbNm","promoEndDtm","promoNm","promoNo","promoStatCd","promoStatNm","promoStrDtm","promoTypCd","promoTypNm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/couponMgmt/getCouponList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Coupon Management List/Count","description":"## Function Description\n* Retrieves registered coupon information and count.\n---\n## Detailed Description\n* Retrieves coupon information matching the search conditions. The search conditions are as follows:\n  * Period (promotion period, usable period, registration period)\n  * Coupon type\n  * Coupon status\n  * Registrant\n  * Coupon No./Name\n  * Issuance method\n---\n## Revision History\n* Release v2.00_240530: Changed date query\n","operationId":"getCouponList","parameters":[{"name":"searchDateType","in":"query","description":"Search Period Type Code (0: Display Start Date, 1: Usage Start Date, 2: Registration Date)","required":true,"schema":{"type":"string","description":"Search Period Type Code (0: Display Start Date, 1: Usage Start Date, 2: Registration Date)"}},{"name":"startDate","in":"query","description":"Period Start Date","required":true,"schema":{"type":"string","format":"date","description":"Period Start Date"}},{"name":"endDate","in":"query","description":"Period End Date","required":true,"schema":{"type":"string","format":"date","description":"Period End Date"}},{"name":"userId","in":"query","description":"Registrant ID","required":false,"schema":{"type":"string","description":"Registrant ID"}},{"name":"promoTypCd","in":"query","description":"Coupon Type Code [MK002] (11: Product Discount Coupon, 12: Cart Coupon, 13: Overlapping Discount Coupon, 14: Free Shipping Coupon, 15: Free Return Coupon)","required":false,"schema":{"type":"string","description":"Coupon Type Code [MK002] (11: Product Discount Coupon, 12: Cart Coupon, 13: Overlapping Discount Coupon, 14: Free Shipping Coupon, 15: Free Return Coupon)"}},{"name":"promoStatCd","in":"query","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)","required":false,"schema":{"type":"string","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)"}},{"name":"promoNo","in":"query","description":"Coupon No.","required":false,"schema":{"type":"string","description":"Coupon No."}},{"name":"promoNm","in":"query","description":"Coupon Name","required":false,"schema":{"type":"string","description":"Coupon Name"}},{"name":"issuMethCd","in":"query","description":"Issuance Method Code [MK007] (01: Designated Recipient Issuance, 02: Conditional Auto Issuance, 03: Customer Download Issuance, 04: Discount Coupon Code Issuance)","required":false,"schema":{"type":"string","description":"Issuance Method Code [MK007] (01: Designated Recipient Issuance, 02: Conditional Auto Issuance, 03: Customer Download Issuance, 04: Discount Coupon Code Issuance)"}},{"name":"issuSubCd","in":"query","description":"Coupon Issuing Entity Code [MK006] (01: Fixed Promotional Coupon, 02: Event Coupon, 04: Affiliate, 05: Customer Compensation Coupon)","required":false,"schema":{"type":"string","description":"Coupon Issuing Entity Code [MK006] (01: Fixed Promotional Coupon, 02: Event Coupon, 04: Affiliate, 05: Customer Compensation Coupon)"}},{"name":"autoIssuTypCd","in":"query","description":"Auto Issuance Type Code [MK008]","required":false,"schema":{"type":"string","description":"Auto Issuance Type Code [MK008]"}},{"name":"entiretyPeriodYn","in":"query","description":"All Period Status","required":false,"schema":{"type":"string","description":"All Period Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Coupon-Issued Members

> &#x20;        \## Function Description\
> &#x20;        \* Retrieves the information of members who were issued the coupon.\
> &#x20;        \---\
> &#x20;        \## Detailed Description\
> &#x20;        \* Retrieves the information of members who were issued the coupon.\
> &#x20;        \* The following information is displayed \*\*masked\*\*:\
> &#x20;          \* Member ID\
> &#x20;          \* Member Name\
> &#x20;        \---\
> \## Revision History\
> \* Release v2.00\_240829 : Updated masking processing<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseCouponIssuedMemberResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CouponIssuedMemberResponse"}}}},"CouponIssuedMemberResponse":{"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"Coupon Issuance No."},"orgCpnIsuNo":{"type":"string","description":"Original Coupon Issuance No."},"mbrNo":{"type":"string","description":"Member No."},"mbrNm":{"type":"string","description":"Member Name"},"loginId":{"type":"string","description":"Member ID"},"mbrGradeCd":{"type":"string","description":"Member Grade Code"},"mbrGradeNm":{"type":"string","description":"Member Grade Code Name"},"cpnNo":{"type":"string","description":"Coupon No."},"cpnIsuDtm":{"type":"string","format":"date-time","description":"Coupon Issuance Date/Time"},"valiStrtDtm":{"type":"string","format":"date-time","description":"Validity Start Date/Time"},"valiEndDtm":{"type":"string","format":"date-time","description":"Validity End Date/Time"},"useYn":{"type":"string","description":"Usage Status"},"mgrMemo":{"type":"string","description":"Coupon Management Memo"},"dataType":{"type":"string","description":"Key Value Type Code for Bulk Registration (CouponUploadMbrType. 10: Member No., 20: Login ID, 30: Legacy System Member No.)"}},"required":["cpnIsuDtm","cpnIsuNo","cpnNo","dataType","loginId","mbrGradeCd","mbrGradeNm","mbrNm","mbrNo","mgrMemo","orgCpnIsuNo","useYn","valiEndDtm","valiStrtDtm"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/couponMgmt/getCouponIssuedMemberList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Coupon-Issued Members","description":"         ## Function Description\n         * Retrieves the information of members who were issued the coupon.\n         ---\n         ## Detailed Description\n         * Retrieves the information of members who were issued the coupon.\n         * The following information is displayed **masked**:\n           * Member ID\n           * Member Name\n         ---\n## Revision History\n* Release v2.00_240829 : Updated masking processing\n","operationId":"getCouponIssuedMemberList","parameters":[{"name":"cpnNo","in":"query","description":"Coupon No.","required":true,"schema":{"type":"string","description":"Coupon No."}},{"name":"mbrNo","in":"query","description":"Member No.","required":false,"schema":{"type":"string","description":"Member No."}},{"name":"useYn","in":"query","description":"Usage Status","required":false,"schema":{"type":"string","description":"Usage Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponIssuedMemberResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Coupon Cost Management List and Count

> \## Function Description\
> \* Retrieves issuance and usage information by coupon.\
> \---\
> \## Detailed Description\
> \* Retrieves the issuance count, usage count, etc. for the given date by coupon.\
> \* The search conditions are as follows:\
> &#x20; \* Issuance period\
> &#x20; \* Coupon type\
> &#x20; \* Coupon status\
> &#x20; \* Coupon No./Name\
> &#x20; \* Registrant\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed date query<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseCouponCostResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CouponCostResponse"}}}},"CouponCostResponse":{"type":"object","description":"Coupon Cost Management Retrieval Response","properties":{"cpnNo":{"type":"string","description":"Coupon No."},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoTypCdNm":{"type":"string","description":"Coupon Type Code Name"},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStatCdNm":{"type":"string","description":"Coupon Status Code Name"},"promoNm":{"type":"string","description":"Coupon Name"},"isuCnt":{"type":"integer","format":"int32","description":"Issuance Count"},"useCnt":{"type":"integer","format":"int32","description":"Number of Uses"},"notUseCnt":{"type":"integer","format":"int32","description":"Unused Count"},"productAmt":{"type":"integer","format":"int32","description":"Total Product Amount"},"cpnAmt":{"type":"integer","format":"int32","description":"Coupon Cost"},"useRate":{"type":"number","format":"double","description":"Usage Rate"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"fixamtFxrtGbCdNm":{"type":"string","description":"Fixed Amount/Rate Type Code Name"},"dcRateAmt":{"type":"number","description":"Discount Amount"},"totalCount":{"type":"integer","format":"int32","description":"Total Count"}},"required":["cpnAmt","cpnNo","dcRateAmt","fixamtFxrtGbCd","fixamtFxrtGbCdNm","isuCnt","notUseCnt","productAmt","promoNm","promoStatCd","promoStatCdNm","promoTypCd","promoTypCdNm","useCnt","useRate"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/couponCostMgmt/getCouponCostList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Coupon Cost Management List and Count","description":"## Function Description\n* Retrieves issuance and usage information by coupon.\n---\n## Detailed Description\n* Retrieves the issuance count, usage count, etc. for the given date by coupon.\n* The search conditions are as follows:\n  * Issuance period\n  * Coupon type\n  * Coupon status\n  * Coupon No./Name\n  * Registrant\n---\n## Revision History\n* Release v2.00_240530: Changed date query\n","operationId":"getCouponCostList","parameters":[{"name":"searchDateType","in":"query","description":"Search Period Type Code (0: Issuance Start Date, 1: Registration Date)","required":true,"schema":{"type":"string","description":"Search Period Type Code (0: Issuance Start Date, 1: Registration Date)"}},{"name":"startDate","in":"query","description":"Period Start Date","required":true,"schema":{"type":"string","format":"date","description":"Period Start Date"}},{"name":"endDate","in":"query","description":"Period Start Date","required":true,"schema":{"type":"string","format":"date","description":"Period Start Date"}},{"name":"promoTypCd","in":"query","description":"Coupon Type Code [MK002] (11: Product Discount Coupon, 12: Cart Coupon, 13: Overlapping Discount Coupon, 14: Free Shipping Coupon, 15: Free Return Coupon)","required":false,"schema":{"type":"string","description":"Coupon Type Code [MK002] (11: Product Discount Coupon, 12: Cart Coupon, 13: Overlapping Discount Coupon, 14: Free Shipping Coupon, 15: Free Return Coupon)"}},{"name":"promoStatCd","in":"query","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)","required":false,"schema":{"type":"string","description":"Coupon Status Code [MK003] (10: Active, 20: Suspended)"}},{"name":"fixamtFxrtGbCd","in":"query","description":"Discount Type Code [MK005]","required":false,"schema":{"type":"string","description":"Discount Type Code [MK005]"}},{"name":"promoNo","in":"query","description":"Coupon No.","required":false,"schema":{"type":"string","description":"Coupon No."}},{"name":"promoNm","in":"query","description":"Coupon Name","required":false,"schema":{"type":"string","description":"Coupon Name"}},{"name":"userId","in":"query","description":"Registrant ID","required":false,"schema":{"type":"string","description":"Registrant ID"}},{"name":"isEntiretyPeriod","in":"query","description":"All Period Status","required":false,"schema":{"type":"boolean","description":"All Period Status"}},{"name":"dateSelect","in":"query","description":"Select Search Period","required":false,"schema":{"type":"string","description":"Select Search Period"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponCostResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Gift Promotion Management List

> \## Function Description\
> \* An API that retrieves registered gift promotion information.\
> \---\
> \## Detailed Description\
> \* Retrieves gift promotion information matching the search conditions. The search conditions are as follows:\
> &#x20; \* Gift promotion period\
> &#x20; \* Gift promotion type\
> &#x20; \* Gift promotion status\
> &#x20; \* Registrant\
> &#x20; \* Gift promotion No./Name\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed date query<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseAppreciateResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/AppreciateResponse"}}}},"AppreciateResponse":{"type":"object","description":"Gift Promotion Management Retrieval Response","properties":{"aeGubun":{"type":"string","description":"Gift Promotion Major Category (10: Promotion Gift Promotion, 20: Event Gift Promotion)"},"aeNo":{"type":"string","description":"Gift Event No."},"aeNm":{"type":"string","description":"Gift Event Name"},"addEvtTypCd":{"type":"string","description":"Gift Event Type Code","enum":["10","20"]},"addEvtTypNm":{"type":"string","description":"Gift Promotion Type Name"},"aePrgsStatCd":{"type":"string","description":"Gift Event Status Code","enum":["10","20"]},"aePrgsStatNm":{"type":"string","description":"Gift Promotion Status Name"},"aeDesc":{"type":"string","description":"Gift Event Description"},"entrNo":{"type":"string","description":"Participating Vendor No."},"entrNm":{"type":"string","description":"Participating Vendor Name"},"aeStrDtm":{"type":"string","format":"date-time","description":"Gift Promotion Start Date and Time"},"aeEndDtm":{"type":"string","format":"date-time","description":"Gift Promotion End Date and Time"},"payStrDt":{"type":"string","description":"Gift Promotion Payment Start Date"},"payEndDt":{"type":"string","description":"Gift Promotion Payment End Date"},"mbrTypCd":{"type":"string","description":"Applicable Target (Member Type)","enum":["01","02","03"]},"mbrTypCdNm":{"type":"string","description":"Applicable Target Name (Member Type)"},"tmEvtYn":{"type":"string","description":"Time Event Status"},"aplyStrTm":{"type":"string","description":"Time Event Start Time"},"aplyEndTm":{"type":"string","description":"Time Event End Time"}},"required":["addEvtTypCd","addEvtTypNm","aeDesc","aeEndDtm","aeGubun","aeNm","aeNo","aePrgsStatCd","aePrgsStatNm","aeStrDtm","entrNm","entrNo","mbrTypCd","tmEvtYn"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/appreciationEventMgmt/getAppreciationEventList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Gift Promotion Management List","description":"## Function Description\n* An API that retrieves registered gift promotion information.\n---\n## Detailed Description\n* Retrieves gift promotion information matching the search conditions. The search conditions are as follows:\n  * Gift promotion period\n  * Gift promotion type\n  * Gift promotion status\n  * Registrant\n  * Gift promotion No./Name\n---\n## Revision History\n* Release v2.00_240530: Changed date query\n","operationId":"getAppreciationEventList","parameters":[{"name":"searchDateType","in":"query","description":"Search Period Type Code (0: Event Start Date, 1: Payment Date)","required":true,"schema":{"type":"string","description":"Search Period Type Code (0: Event Start Date, 1: Payment Date)"}},{"name":"startDate","in":"query","description":"Gift Event Period Start Date","required":true,"schema":{"type":"string","format":"date","description":"Gift Event Period Start Date"}},{"name":"endDate","in":"query","description":"Gift Event Period End Date","required":true,"schema":{"type":"string","format":"date","description":"Gift Event Period End Date"}},{"name":"userId","in":"query","description":"Registrant ID","required":false,"schema":{"type":"string","description":"Registrant ID"}},{"name":"addEvtTypCd","in":"query","description":"Gift Event Type Code [MK012] (10: Purchase Amount Gift Event, 20: Product Gift Event","required":false,"schema":{"type":"string","description":"Gift Event Type Code [MK012] (10: Purchase Amount Gift Event, 20: Product Gift Event"}},{"name":"aePrgsStatCd","in":"query","description":"Gift Event Status Code [MK003] (10: Normal, 20: Suspended)","required":false,"schema":{"type":"string","description":"Gift Event Status Code [MK003] (10: Normal, 20: Suspended)"}},{"name":"aeNo","in":"query","description":"Gift Event No.","required":false,"schema":{"type":"string","description":"Gift Event No."}},{"name":"aeNm","in":"query","description":"Gift Event Name","required":false,"schema":{"type":"string","description":"Gift Event Name"}},{"name":"mbrTypCd","in":"query","description":"Application Target","required":false,"schema":{"type":"string","description":"Application Target"}},{"name":"entiretyPeriodYn","in":"query","description":"All Period Status","required":false,"schema":{"type":"string","description":"All Period Status"}},{"name":"entrNo","in":"query","description":"Participating Vendor Code","required":false,"schema":{"type":"string","description":"Participating Vendor Code"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseAppreciateResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Customer Information for Gift Item Payment

> \## Function Description\
> \* Retrieves the list of orders for which a gift item was selected.\
> \---\
> \## Detailed Description\
> \* Retrieves order information matching the search conditions among orders for which a gift item was selected. The search conditions are as follows:\
> &#x20; \* Gift promotion period\
> &#x20; \* Gift promotion type\
> &#x20; \* Gift promotion status\
> &#x20; \* Registrant\
> &#x20; \* Gift promotion No./Name\
> \* The following information in the response is displayed \*\*masked\*\*:\
> &#x20; \* Member ID\
> &#x20; \* Member Name\
> &#x20; \* Mobile Phone No.\
> &#x20; \* Order Delivery Address<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponseAppreciateOrderItem":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/AppreciateOrderItem"}}}},"AppreciateOrderItem":{"type":"object","description":"Gift Item Payment Customer Management Information","properties":{"ordNo":{"type":"string","description":"Order No."},"loginId":{"type":"string","description":"Member ID"},"mbrGbCdNm":{"type":"string","description":"Member Type Code Name"},"mbrNm":{"type":"string","description":"Member Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrGradeCdNm":{"type":"string","description":"Member Grade Code Name"},"mbrJoinDtm":{"type":"string","format":"date-time","description":"Membership Registration Date/Time"},"tellNo":{"type":"string","description":"Mobile Phone Number"},"ordAccpDtm":{"type":"string","format":"date-time","description":"Order Received Date"},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Delivery Address"},"dtlAddr":{"type":"string","description":"Detailed Delivery Address"},"aeNm":{"type":"string","description":"Gift Event Name"},"aeNo":{"type":"string","description":"Gift Event No."},"aeGoodsNo":{"type":"string","description":"Free Gift No."},"aeGoodsNm":{"type":"string","description":"Gift Item Name"},"realAmt":{"type":"integer","format":"int64","description":"Actual Payment Amount"},"ordCnt":{"type":"integer","format":"int32","description":"Order Product Quantity"},"aeStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"aeEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"}},"required":["aeGoodsNm","aeGoodsNo","aeNm","aeNo","dtlAddr","loginId","mbrGbCdNm","mbrGradeCdNm","mbrJoinDtm","mbrNm","mbrNo","ordAccpDtm","ordCnt","ordNo","realAmt","tellNo","zipAddr","zipNo"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v2/marketing/appreciationEventMgmt/getAeOrderList":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Customer Information for Gift Item Payment","description":"## Function Description\n* Retrieves the list of orders for which a gift item was selected.\n---\n## Detailed Description\n* Retrieves order information matching the search conditions among orders for which a gift item was selected. The search conditions are as follows:\n  * Gift promotion period\n  * Gift promotion type\n  * Gift promotion status\n  * Registrant\n  * Gift promotion No./Name\n* The following information in the response is displayed **masked**:\n  * Member ID\n  * Member Name\n  * Mobile Phone No.\n  * Order Delivery Address\n","operationId":"getAeOrderList","parameters":[{"name":"startDate","in":"query","description":"Order Receipt Start Date","required":true,"schema":{"type":"string","format":"date","description":"Order Receipt Start Date"}},{"name":"endDate","in":"query","description":"Order Receipt End Date","required":true,"schema":{"type":"string","format":"date","description":"Order Receipt End Date"}},{"name":"ordNo","in":"query","description":"Order No.","required":false,"schema":{"type":"string","description":"Order No."}},{"name":"mbrNo","in":"query","description":"Member No.","required":false,"schema":{"type":"string","description":"Member No."}},{"name":"aeNo","in":"query","description":"Gift Event No.","required":false,"schema":{"type":"string","description":"Gift Event No."}},{"name":"aeNm","in":"query","description":"Gift Event Name","required":false,"schema":{"type":"string","description":"Gift Event Name"}},{"name":"goodsNo","in":"query","description":"Free Gift No.","required":false,"schema":{"type":"string","description":"Free Gift No."}},{"name":"dateSelect","in":"query","description":"Select Search Period","required":false,"schema":{"type":"string","description":"Select Search Period"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseAppreciateOrderItem"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Discount/Mileage Detail Screen

> \## Function Description\
> \* Retrieves the detail information of the selected discount/mileage.\
> \---\
> \## Detailed Description\
> \* Retrieves the detail information of the selected discount/mileage.\
> \* Retrieved information\
> &#x20; \* Basic information\
> &#x20; \* Discount/mileage benefit\
> &#x20; \* Applicable targets, excluded targets<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PromotionDetailResponse":{"type":"object","description":"Coupon Detail Information Retrieval Response","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoGbCd":{"type":"string","description":"Coupon/Promotion Classification Code","enum":["10","20"]},"comGbCd":{"type":"string","description":"Company Type Code (ME038)"},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"},"ourChrgRate":{"type":"integer","format":"int32","description":"Company Cost-Sharing Rate"},"entrChrgRate":{"type":"integer","format":"int32","description":"Vendor Cost-Sharing Rate"},"promoDesc":{"type":"string","description":"Coupon Description"},"possibleUpdateYn":{"type":"string","description":"Modifiable Status"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"Per-Member Issuance Limit Status"},"idIssuQty":{"type":"integer","format":"int32","description":"Per-Member Issuance Limit Count"},"totCpnIssuLmtYn":{"type":"string","description":"Total Issuance Limit Status"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"Total Issuance Limit Count"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"Applicable Media Code"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"Member Grade Code"}},"issuMethCd":{"type":"string","description":"Issuance Method Code","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"Issuance Type Code (MK008)"},"aplyTermGbCd":{"type":"string","description":"Application Period Classification Code","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"Coupon Usage Days from Issuance Date"},"usePsbStrDt":{"type":"string","description":"Usage Available Start Date"},"usePsbEndDt":{"type":"string","description":"Usage Available End Date"},"useWdayCd":{"type":"array","items":{"type":"string","description":"Usable Day of Week Code"}},"tmCpnYn":{"type":"string","description":"Time Coupon Status"},"usePsbStrTm":{"type":"string","description":"Time Coupon Start Time"},"usePsbEndTm":{"type":"string","description":"Time Coupon End Time"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"Discount Rate/Amount"},"minBuyQty":{"type":"integer","format":"int32","description":"Minimum Purchase Quantity"},"minBuyAmt":{"type":"number","description":"Minimum Purchase Amount"},"maxDcAmt":{"type":"number","description":"Maximum Discount Amount"},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"autoIssuPotmCd":{"type":"string","description":"Auto Issuance Timing Code","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"Anniversary Advance Issuance Days"},"cpbookDispYn":{"type":"string","description":"Coupon Book Display Status"},"dcCpbookCd":{"type":"string","description":"Discount Coupon Book Code (MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"Auto-Issuance Quantity"},"aplySites":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Application Condition - Site"}},"aplyGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Product"}},"aplyStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Standard Category"}},"aplyCategory":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Brand"}},"aplyEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Vendor"}},"aplyChannel":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Channel"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Application Condition - Special Promotion"}},"exceptGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Product"}},"exceptStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Standard Category"}},"exceptBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Brand"}},"exceptEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Vendor"}}},"required":["comGbCd","entrChrgRate","fixamtFxrtGbCd","idIssuLmtYn","issuSubCd","ourChrgRate","possibleUpdateYn","promoDesc","promoEndDtm","promoGbCd","promoNm","promoNo","promoStatCd","promoStrDtm","promoTypCd","totCpnIssuLmtYn"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/promotionMgmt/getPromotion":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Discount/Mileage Detail Screen","description":"## Function Description\n* Retrieves the detail information of the selected discount/mileage.\n---\n## Detailed Description\n* Retrieves the detail information of the selected discount/mileage.\n* Retrieved information\n  * Basic information\n  * Discount/mileage benefit\n  * Applicable targets, excluded targets\n","operationId":"getPromotion","parameters":[{"name":"promoNo","in":"query","description":"Promotion No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PromotionDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Mileage Standard Information

> \## Function Description\
> \* Retrieves the Mileage Standard Information.\
> \---\
> \## Detailed Description\
> \* Retrieves the Mileage Standard Information matching the selected accrual target code.\
> \---\
> \## Revision History\
> \* Release v1.03\_231106: Initial development of Mileage Standard Information<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MilgStdResponse":{"type":"object","properties":{"milgStdInfoSeq":{"type":"string","description":" Mileage Standard Information Sequence No."},"rsrvGbCd":{"type":"string","description":" Accrual Type Code (CM016)"},"rsrvTgtCd":{"type":"string","description":" Accrual Target Code (CM017)"},"milgTypNm":{"type":"string","description":" Mileage Type Name"},"baseRsrvRate":{"type":"number","format":"double","description":" Basic Accrual Rate"},"addRsrvAmt":{"type":"number","description":" Additional Accrual Amount"},"mbrGradeCd":{"type":"string","description":" Member Grade Code (ME008)"},"rsrvStdAmt":{"type":"number","description":" Accrual Standard Amount"},"rsrvStdDds":{"type":"integer","format":"int32","description":" Accrual Standard Days"},"valiTermDds":{"type":"integer","format":"int32","description":" Validity Period Days"},"mmMaxRsrvAmt":{"type":"number","description":" Monthly Maximum Accrual Amount"},"yyMaxRsrvAmt":{"type":"number","description":" Annual Maximum Accrual Amount"},"mmMaxRsrvUseYn":{"type":"string","description":" Monthly Limit Usage Status (Y=Max Set, N=Unlimited)"},"yyMaxRsrvUseYn":{"type":"string","description":" Annual Limit Usage Status (Y=Max Set, N=Unlimited)"},"useYn":{"type":"string","description":" Accrual Standard Usage Status (Y=Used, N=Not Used)"},"chgCausDesc":{"type":"string","description":" Change Reason Description"},"rmkCont":{"type":"string","description":" Remarks"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/mileageMgmt/milgStdDetail":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Mileage Standard Information","description":"## Function Description\n* Retrieves the Mileage Standard Information.\n---\n## Detailed Description\n* Retrieves the Mileage Standard Information matching the selected accrual target code.\n---\n## Revision History\n* Release v1.03_231106: Initial development of Mileage Standard Information\n","operationId":"getMilgStdDetail","parameters":[{"name":"rsrvTgtCd","in":"query","description":"Accrual Target Code (CM017)","required":true,"schema":{"type":"string","description":"Accrual Target Code (CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MilgStdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Basic Information for Mileage Standard Information Registration

> \## Function Description\
> \* Retrieves the basic information for Mileage Standard Information registration.\
> \---\
> \## Detailed Description\
> \* Retrieves reference data for registering Mileage Standard Information.\
> \* The priority order of the retrieved data is as follows:\
> &#x20;   \* Accrual Target Code\
> &#x20;   \* Accrual Type Code (the largest value among accrual type code and accrual target code)\
> \---\
> \## Revision History\
> \* Release v1.03\_231106: Initial development of Mileage Standard Information<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MilgStdResponse":{"type":"object","properties":{"milgStdInfoSeq":{"type":"string","description":" Mileage Standard Information Sequence No."},"rsrvGbCd":{"type":"string","description":" Accrual Type Code (CM016)"},"rsrvTgtCd":{"type":"string","description":" Accrual Target Code (CM017)"},"milgTypNm":{"type":"string","description":" Mileage Type Name"},"baseRsrvRate":{"type":"number","format":"double","description":" Basic Accrual Rate"},"addRsrvAmt":{"type":"number","description":" Additional Accrual Amount"},"mbrGradeCd":{"type":"string","description":" Member Grade Code (ME008)"},"rsrvStdAmt":{"type":"number","description":" Accrual Standard Amount"},"rsrvStdDds":{"type":"integer","format":"int32","description":" Accrual Standard Days"},"valiTermDds":{"type":"integer","format":"int32","description":" Validity Period Days"},"mmMaxRsrvAmt":{"type":"number","description":" Monthly Maximum Accrual Amount"},"yyMaxRsrvAmt":{"type":"number","description":" Annual Maximum Accrual Amount"},"mmMaxRsrvUseYn":{"type":"string","description":" Monthly Limit Usage Status (Y=Max Set, N=Unlimited)"},"yyMaxRsrvUseYn":{"type":"string","description":" Annual Limit Usage Status (Y=Max Set, N=Unlimited)"},"useYn":{"type":"string","description":" Accrual Standard Usage Status (Y=Used, N=Not Used)"},"chgCausDesc":{"type":"string","description":" Change Reason Description"},"rmkCont":{"type":"string","description":" Remarks"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/mileageMgmt/getSaveBasedMilgStdDetail":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Basic Information for Mileage Standard Information Registration","description":"## Function Description\n* Retrieves the basic information for Mileage Standard Information registration.\n---\n## Detailed Description\n* Retrieves reference data for registering Mileage Standard Information.\n* The priority order of the retrieved data is as follows:\n    * Accrual Target Code\n    * Accrual Type Code (the largest value among accrual type code and accrual target code)\n---\n## Revision History\n* Release v1.03_231106: Initial development of Mileage Standard Information\n","operationId":"getSaveBasedMilgStdDetail","parameters":[{"name":"rsrvGbCd","in":"query","description":"Accrual Classification Code (CM016)","required":true,"schema":{"type":"string","description":"Accrual Classification Code (CM016)","enum":["100","110","120","130","200","210","220"]}},{"name":"rsrvTgtCd","in":"query","description":"Accrual Target Code (CM017)","required":true,"schema":{"type":"string","description":"Accrual Target Code (CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MilgStdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Coupon Detail Information

> \## Function Description\
> \* Retrieves the detail information of the selected coupon.\
> \---\
> \## Detailed Description\
> \* Retrieves the detail information of the selected coupon.\
> \* Retrieved information\
> &#x20; \* Basic information\
> &#x20; \* Coupon benefit\
> &#x20; \* Applicable targets\
> \## Revision History\
> \* Release v2.00\_240509: Added retrieval of applicable target - special promotion information<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PromotionDetailResponse":{"type":"object","description":"Coupon Detail Information Retrieval Response","properties":{"promoNo":{"type":"string","description":"Coupon No."},"promoGbCd":{"type":"string","description":"Coupon/Promotion Classification Code","enum":["10","20"]},"comGbCd":{"type":"string","description":"Company Type Code (ME038)"},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type Code","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"Coupon Status Code","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"Event Start Date/Time"},"promoEndDtm":{"type":"string","format":"date-time","description":"Event End Date/Time"},"ourChrgRate":{"type":"integer","format":"int32","description":"Company Cost-Sharing Rate"},"entrChrgRate":{"type":"integer","format":"int32","description":"Vendor Cost-Sharing Rate"},"promoDesc":{"type":"string","description":"Coupon Description"},"possibleUpdateYn":{"type":"string","description":"Modifiable Status"},"issuSubCd":{"type":"string","description":"Coupon Issuing Entity Code","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"Per-Member Issuance Limit Status"},"idIssuQty":{"type":"integer","format":"int32","description":"Per-Member Issuance Limit Count"},"totCpnIssuLmtYn":{"type":"string","description":"Total Issuance Limit Status"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"Total Issuance Limit Count"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"Applicable Media Code"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"Member Grade Code"}},"issuMethCd":{"type":"string","description":"Issuance Method Code","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"Issuance Type Code (MK008)"},"aplyTermGbCd":{"type":"string","description":"Application Period Classification Code","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"Coupon Usage Days from Issuance Date"},"usePsbStrDt":{"type":"string","description":"Usage Available Start Date"},"usePsbEndDt":{"type":"string","description":"Usage Available End Date"},"useWdayCd":{"type":"array","items":{"type":"string","description":"Usable Day of Week Code"}},"tmCpnYn":{"type":"string","description":"Time Coupon Status"},"usePsbStrTm":{"type":"string","description":"Time Coupon Start Time"},"usePsbEndTm":{"type":"string","description":"Time Coupon End Time"},"fixamtFxrtGbCd":{"type":"string","description":"Fixed Amount/Rate Type Code","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"Discount Rate/Amount"},"minBuyQty":{"type":"integer","format":"int32","description":"Minimum Purchase Quantity"},"minBuyAmt":{"type":"number","description":"Minimum Purchase Amount"},"maxDcAmt":{"type":"number","description":"Maximum Discount Amount"},"dcCpnCd":{"type":"string","description":"Discount Coupon Code"},"autoIssuPotmCd":{"type":"string","description":"Auto Issuance Timing Code","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"Anniversary Advance Issuance Days"},"cpbookDispYn":{"type":"string","description":"Coupon Book Display Status"},"dcCpbookCd":{"type":"string","description":"Discount Coupon Book Code (MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"Auto-Issuance Quantity"},"aplySites":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Application Condition - Site"}},"aplyGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Product"}},"aplyStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Standard Category"}},"aplyCategory":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Display Category"}},"aplyBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Brand"}},"aplyEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Vendor"}},"aplyChannel":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Applicable Condition - Channel"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Application Condition - Special Promotion"}},"exceptGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Product"}},"exceptStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Standard Category"}},"exceptBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Brand"}},"exceptEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"Exclusion Condition - Vendor"}}},"required":["comGbCd","entrChrgRate","fixamtFxrtGbCd","idIssuLmtYn","issuSubCd","ourChrgRate","possibleUpdateYn","promoDesc","promoEndDtm","promoGbCd","promoNm","promoNo","promoStatCd","promoStrDtm","promoTypCd","totCpnIssuLmtYn"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/couponMgmt/getCouponData":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Coupon Detail Information","description":"## Function Description\n* Retrieves the detail information of the selected coupon.\n---\n## Detailed Description\n* Retrieves the detail information of the selected coupon.\n* Retrieved information\n  * Basic information\n  * Coupon benefit\n  * Applicable targets\n## Revision History\n* Release v2.00_240509: Added retrieval of applicable target - special promotion information\n","operationId":"getCouponData","parameters":[{"name":"promoNo","in":"query","description":"Coupon No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PromotionDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Ongoing Gift Promotion Count

> \## Function Description\
> \* Retrieves the count of ongoing gift promotions in which the gift item is included as a promotion condition.\
> \---\
> \## Detailed Description\
> \* Retrieves the count of ongoing gift promotions in which the gift item is included as a promotion condition.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"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"}}}}},"paths":{"/v1/marketing/appreciationEventMgmt/getProgressAeEvtCount":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Ongoing Gift Promotion Count","description":"## Function Description\n* Retrieves the count of ongoing gift promotions in which the gift item is included as a promotion condition.\n---\n## Detailed Description\n* Retrieves the count of ongoing gift promotions in which the gift item is included as a promotion condition.\n","operationId":"getProgressAeEvtCount","parameters":[{"name":"goodsNo","in":"query","description":"Gift No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```