> 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/popup-bo-api/promotion-management.md).

# Promotion Management

## Register Promotion Multilingual Information

> \## Function Description\
> \* Registers the multilingual information for a promotion.\
> \---\
> \## Detailed Description\
> \* Registers the following multilingual information according to the promotion multilingual type code and language code.\
> &#x20;   \* Promotion/Gift Event Name\
> &#x20;   \* Promotion/Gift Event Description\
> \* Used in coupons, discounts/mileage, and gift events.<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":[]}],"paths":{"/v1/marketing/prmMltLngMgmt/saveMultilingualInfo":{"post":{"tags":["Promotion Management"],"summary":"Register Promotion Multilingual Information","description":"## Function Description\n* Registers the multilingual information for a promotion.\n---\n## Detailed Description\n* Registers the following multilingual information according to the promotion multilingual type code and language code.\n    * Promotion/Gift Event Name\n    * Promotion/Gift Event Description\n* Used in coupons, discounts/mileage, and gift events.\n","operationId":"saveMultilingualInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionMultillingualRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PromotionMultillingualRequest":{"type":"object","properties":{"promoKey":{"type":"string","description":"Promotion Key (promoNo, aeNo)"},"promoCallTyp":{"type":"string","description":"Promotion Multilingual Type Code (PromotionType): 10: Coupon, 20: Discount/Mileage, 30: Gift Event"},"dataLangCd":{"type":"string","description":"Language Code (CM009) ko: Korean, en: English"},"nm":{"type":"string","description":"Promotion/Gift Event Name"},"desc":{"type":"string","description":"Promotion/Gift Event Description"}},"required":["promoCallTyp","promoKey"]},"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"}}}}}}
```

## Retrieve Coupon List and Count

> \## Function Description\
> \* Retrieves the coupon list and count.\
> \---\
> \## Detailed Description\
> \* Retrieves the coupon list and count matching the search conditions. The search conditions are as follows.\
> &#x20; \* Coupon validity period\
> &#x20; \* Coupon type\
> &#x20; \* Usage status\
> &#x20; \* Expiration status<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":[]}],"paths":{"/v1/member/memberMgmt/getCustomerCouponGrid":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Coupon List and Count","description":"## Function Description\n* Retrieves the coupon list and count.\n---\n## Detailed Description\n* Retrieves the coupon list and count matching the search conditions. The search conditions are as follows.\n  * Coupon validity period\n  * Coupon type\n  * Usage status\n  * Expiration status\n","operationId":"getCustomerCouponGrid","parameters":[{"name":"argSelectType","in":"query","description":"Selection Type 1: Single, N: Multiple","required":true,"schema":{"type":"string","description":"Selection Type 1: Single, N: Multiple","minLength":1}},{"name":"mbrNo","in":"query","description":"Member No.","required":true,"schema":{"type":"string","description":"Member No."}},{"name":"promoTypCd","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","description":"Promotion Type Code (MK002)\n 11 : Product Discount Coupon\n, 12 : Cart Coupon\n, 13 : Stackable Discount Coupon\n, 14 : Free Shipping Coupon\n, 15 : Free Return Coupon\n, 20 : Employee Discount\n, 21 : Instant Product Discount\n, 40 : Product Mileage\n","enum":["11","12","13","14","15","20","21","40"]}}},{"name":"startDate","in":"query","description":"Start Date","required":true,"schema":{"type":"string","format":"date-time","description":"Start Date"}},{"name":"endDate","in":"query","description":"End Date","required":true,"schema":{"type":"string","format":"date-time","description":"End Date"}},{"name":"useYN","in":"query","description":"Usage Status Y: In Use, N: Not in Use","required":false,"schema":{"type":"string","description":"Usage Status Y: In Use, N: Not in Use"}},{"name":"promoDiv","in":"query","description":"Coupon Search Type Code Y: Free Shipping/Return Coupon, N: Coupon","required":true,"schema":{"type":"string","description":"Coupon Search Type Code Y: Free Shipping/Return Coupon, N: Coupon"}},{"name":"expiredCd","in":"query","description":"Period Expiration Search Code 10: Valid Period, 20: Expired Period","required":false,"schema":{"type":"string","description":"Period Expiration Search Code 10: Valid Period, 20: Expired Period"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderClaimCoupon"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"RealGridListResponseOrderClaimCoupon":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimCoupon"}}}},"OrderClaimCoupon":{"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"Coupon Issuance No.","minLength":1},"mbrNo":{"type":"string","description":"Member No.","minLength":1},"useYn":{"type":"string","description":"Usage Status"},"ordNo":{"type":"string","description":"Order No."},"ordSeq":{"type":"string","description":"Order Sequence No."},"promoNo":{"type":"string","description":"Coupon No."},"promoNm":{"type":"string","description":"Coupon Name"},"promoTypCd":{"type":"string","description":"Coupon Type","enum":["11","12","13","14","15","20","21","40"]},"promoTypNm":{"type":"string","description":"Coupon Type Name"},"validDtm":{"type":"string","description":"Validity Period"},"useDtm":{"type":"string","format":"date-time","description":"Usage Date/Time"},"useGbCd":{"type":"string","description":"Usage Type Code"},"useGbNm":{"type":"string","description":"Usage Type Name"},"dcRateAmt":{"type":"number","description":"Discount Amount"},"fixamtFxrtGbCd":{"type":"string","description":"Discount (Flat Rate/Percentage) Type Code","enum":["01","02"]},"fixamtFxrtGbNm":{"type":"string","description":"Discount (Flat Rate/Percentage) Type Code Name"},"expiredYn":{"type":"string","description":"Period Expiration Status"}},"required":["cpnIsuNo","mbrNo"]},"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"}}}}}}
```

## Retrieve Promotion Multilingual Information

> \## Function Description\
> \* Retrieves the multilingual information for a promotion.\
> \---\
> \## Detailed Description\
> \* Retrieves the multilingual information for a promotion using the promotion multilingual type code and language code.\
> \* Used in coupons, discounts/mileage, and gift events.<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":[]}],"paths":{"/v1/marketing/prmMltLngMgmt/getMultilingualInfo":{"get":{"tags":["Promotion Management"],"summary":"Retrieve Promotion Multilingual Information","description":"## Function Description\n* Retrieves the multilingual information for a promotion.\n---\n## Detailed Description\n* Retrieves the multilingual information for a promotion using the promotion multilingual type code and language code.\n* Used in coupons, discounts/mileage, and gift events.\n","operationId":"getMultilingualInfo","parameters":[{"name":"promoKey","in":"query","description":"Promotion Key (promoNo, aeNo)","required":true,"schema":{"type":"string","description":"Promotion Key (promoNo, aeNo)"}},{"name":"promoCallTyp","in":"query","description":"Promotion Multilingual Type Code (PromotionType): 10: Coupon, 20: Discount/Mileage, 30: Gift Event","required":true,"schema":{"type":"string","description":"Promotion Multilingual Type Code (PromotionType): 10: Coupon, 20: Discount/Mileage, 30: Gift Event"}},{"name":"dataLangCd","in":"query","description":"Language Code (CM009) ko: Korean, en: English","required":false,"schema":{"type":"string","description":"Language Code (CM009) ko: Korean, en: English"}},{"name":"nm","in":"query","description":"Promotion/Gift Event Name","required":false,"schema":{"type":"string","description":"Promotion/Gift Event Name"}},{"name":"desc","in":"query","description":"Promotion/Gift Event Description","required":false,"schema":{"type":"string","description":"Promotion/Gift Event Description"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PromotionMultillingualResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"PromotionMultillingualResponse":{"type":"object","properties":{"promoKey":{"type":"string","description":"Promotion Key (promoNo, aeNo)"},"promoCallTyp":{"type":"string","description":"Promotion Multilingual Type Code 10: Coupon, 20: Discount/Mileage, 30: Gift Event"},"dataLangCd":{"type":"string","description":"Language Code (CM009) ko: Korean, en: English"},"defaultNm":{"type":"string","description":"Default Promotion/Gift Event Name"},"langNm":{"type":"string","description":"Multilingual Promotion/Gift Event Name"},"defaultDesc":{"type":"string","description":"Default Promotion/Gift Event Description"},"langDesc":{"type":"string","description":"Multilingual Promotion/Gift Event Description"},"changePosible":{"type":"boolean","description":"Changeable Status"}},"required":["promoCallTyp","promoKey"]},"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"}}}}}}
```
