# 프로모션 관리

## 쿠폰 상태 변경

> \## 기능설명\
> \* 쿠폰별로 변경된 상태를 저장합니다.\
> \---\
> \## 상세설명\
> \* 쿠폰관리 화면에서 쿠폰 별로 변경한 쿠폰상태를 저장합니다.<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":"검색기간 유형 코드(0 : 전시시작일자 , 1 : 사용시작일자, 2 : 등록일자)"},"startDate":{"type":"string","format":"date","description":"기간 시작일자"},"endDate":{"type":"string","format":"date","description":"기간 종료일자"},"userId":{"type":"string","description":"등록자ID"},"promoTypCd":{"type":"string","description":"쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)"},"promoStatCd":{"type":"string","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)"},"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"issuMethCd":{"type":"string","description":"발급방식코드[MK007](01 : 대상자지정발급, 02 : 조건부자동발급, 03 : 고객다운로드발급, 04 : 할인쿠폰코드발급)"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드[MK006](01 : 고정판촉쿠폰, 02 : 이벤트쿠폰, 04 : 제휴사, 05 : 고객보상쿠폰)"},"autoIssuTypCd":{"type":"string","description":"자동발급유형코드[MK008]"},"entiretyPeriodYn":{"type":"string","description":"전체기간여부"}},"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":["프로모션 관리"],"summary":"쿠폰 상태 변경","description":"## 기능설명\n* 쿠폰별로 변경된 상태를 저장합니다.\n---\n## 상세설명\n* 쿠폰관리 화면에서 쿠폰 별로 변경한 쿠폰상태를 저장합니다.\n","operationId":"saveCouponState","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponRequest"}}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 할인/마일리지 등록 및 업데이트

> \## 기능설명\
> \* 입력된 할인/마일리지 정보를 저장합니다.\
> \---\
> \## 상세설명\
> \* 입력한 할인/마일리지의 상세 정보(기본정보, 할인/마일리지 혜택, 적용대상, 제외대상)를 저장합니다.\
> &#x20; \* \*\*할인/마일리지번호가 있는 경우\*\* : 할인/마일리지 등록\
> &#x20; \* \*\*할인/마일리지번호가 없는 경우\*\* : 할인/마일리지 수정\
> \* 할인/마일리지의 경우 쿠폰과 다르게, 100% 당사 분담이고, 최소구매수량, 최소구매금액, 최대할인금액 제한이 없습니다.\
> \* 선택한 할인/마일리지 유형에 따라서 각 조건에 맞는 추가 검증을 진행합니다.<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":"프로모션번호"},"promoNm":{"type":"string","description":"프로모션명"},"promoGbCd":{"type":"string","description":"쿠폰구분(MK001)","enum":["10","20"]},"promoTypCd":{"type":"string","description":"프로모션유형","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"프로모션상태","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"전시 시작 일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"전시 종료 일시"},"promoDesc":{"type":"string","description":"프로모션설명"},"comGbCd":{"type":"string","description":"회사구분코드(ME038)","enum":["P00"]},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"적용 매체 리스트"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"적용 회원등급 리스트"}},"fixamtFxrtGbCd":{"type":"string","description":"정액정률구분코드(MK005)","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"할인율금액"},"aplySites":{"type":"array","items":{"type":"string","description":"적용 조건 - 사이트"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 상품"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 표준카테고리"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"적용 조건 - 전시카테고리"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"적용 조건 - 브랜드"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"적용 조건 - 협력사"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"적용 조건 - 채널"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 표준카테고리"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"제외 조건 - 브랜드"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"제외 조건 - 협력사"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 상품"}}},"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":["프로모션 관리"],"summary":"할인/마일리지 등록 및 업데이트","description":"## 기능설명\n* 입력된 할인/마일리지 정보를 저장합니다.\n---\n## 상세설명\n* 입력한 할인/마일리지의 상세 정보(기본정보, 할인/마일리지 혜택, 적용대상, 제외대상)를 저장합니다.\n  * **할인/마일리지번호가 있는 경우** : 할인/마일리지 등록\n  * **할인/마일리지번호가 없는 경우** : 할인/마일리지 수정\n* 할인/마일리지의 경우 쿠폰과 다르게, 100% 당사 분담이고, 최소구매수량, 최소구매금액, 최대할인금액 제한이 없습니다.\n* 선택한 할인/마일리지 유형에 따라서 각 조건에 맞는 추가 검증을 진행합니다.\n","operationId":"cudPromotion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionCudRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 마일리지 기준정보 저장

> \## 기능설명\
> \* 마일리지 기준정보 목록을 저장합니다.\
> \---\
> \## 상세설명\
> \* 저장 시 기존 데이터 유무에 따라 처리가 달라집니다.\
> \* 기존 데이터 정보는 적립구분코드로 조회 합니다.\
> \* 기존 데이터 존재 안함 - 등록\
> &#x20;   \* 기준 정보: insert\
> &#x20;   \* 기준 정보 변경이력: insert\
> \* 기존 데이터 존재함 - 수정\
> &#x20;   \* 기준 정보: update\
> &#x20;   \* 기준 정보 변경이력: update (기존에 저장된 정보 종료)\
> &#x20;   \* 기준 정보 변경이력: insert (새로 저장된 정보)\
> \---\
> \## 수정번호\
> \* Release v1.03\_231106: 마일리지 기준정보 최초 개발<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":"적립구분코드(CM016)","enum":["100","110","120","130","200","210","220"]},"rsrvTgtCd":{"type":"string","description":"적립대상코드(CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]},"milgTypNm":{"type":"string","description":"마일리지유형명"},"baseRsrvRate":{"type":"number","format":"double","description":"기본적립율"},"addRsrvAmt":{"type":"number","description":"추가적립금액"},"rsrvStdAmt":{"type":"number","description":"적립기준금액"},"rsrvStdDds":{"type":"integer","format":"int32","description":"적립기준일수"},"valiTermDds":{"type":"integer","format":"int32","description":"유효기간일수"},"mmMaxRsrvAmt":{"type":"number","description":"월최대적립금액"},"yyMaxRsrvAmt":{"type":"number","description":"년최대적립금액"},"chgCausDesc":{"type":"string","description":"변경사유설명"},"rmkCont":{"type":"string","description":"비고내용"}},"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":["프로모션 관리"],"summary":"마일리지 기준정보 저장","description":"## 기능설명\n* 마일리지 기준정보 목록을 저장합니다.\n---\n## 상세설명\n* 저장 시 기존 데이터 유무에 따라 처리가 달라집니다.\n* 기존 데이터 정보는 적립구분코드로 조회 합니다.\n* 기존 데이터 존재 안함 - 등록\n    * 기준 정보: insert\n    * 기준 정보 변경이력: insert\n* 기존 데이터 존재함 - 수정\n    * 기준 정보: update\n    * 기준 정보 변경이력: update (기존에 저장된 정보 종료)\n    * 기준 정보 변경이력: insert (새로 저장된 정보)\n---\n## 수정번호\n* Release v1.03_231106: 마일리지 기준정보 최초 개발\n","operationId":"saveMilgStdDetail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveMilgStdDetailRequest"}}},"required":true},"responses":{"200":{"description":"성공"},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰 회수

> \## 기능설명\
> \* 사용자에게 발급된 쿠폰을 회수합니다.\
> \---\
> \## 상세설명\
> \* 사용자에게 발급된 쿠폰을 회수합니다.\
> \* 회수된 쿠폰은 사용자의 쿠폰함에서 미노출됩니다.\
> \* \*\*쿠폰이 사용된 경우에는 회수가 불가능합니다.\*\*<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":"쿠폰발급번호"}},"valiStrtDtm":{"type":"string","format":"date-time","description":"쿠폰 기간변경 유효시작일시"},"valiEndDtm":{"type":"string","format":"date-time","description":"쿠폰 기간변경 유효종료일시"}},"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":["프로모션 관리"],"summary":"쿠폰 회수","description":"## 기능설명\n* 사용자에게 발급된 쿠폰을 회수합니다.\n---\n## 상세설명\n* 사용자에게 발급된 쿠폰을 회수합니다.\n* 회수된 쿠폰은 사용자의 쿠폰함에서 미노출됩니다.\n* **쿠폰이 사용된 경우에는 회수가 불가능합니다.**\n","operationId":"withdrawCoupon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnIsuNoListRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰 등록/수정

> \## 기능설명\
> \* 입력된 쿠폰 정보를 저장합니다.\
> \---\
> \## 상세설명\
> \* 입력한 쿠폰의 상세 정보(기본정보, 쿠폰 혜택, 적용대상, 제외대상)를 저장합니다.\
> &#x20; \* \*\*쿠폰번호가 있는 경우\*\* : 쿠폰 등록\
> &#x20; \* \*\*쿠폰번호가 없는 경우\*\* : 쿠폰 수정\
> \* 선택한 쿠폰 유형, 발급주체, 발급유형에 따라서 각 조건에 맞는 추가 검증을 진행합니다.\
> \## 수정번호\
> \* Release v2.00\_240509: 적용대상 - 기획전 정보 저장 추가<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":"쿠폰 저장 Request","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"promoGbCd":{"type":"string","description":"쿠폰/프로모션 구분 코드","enum":["10","20"]},"promoTypCd":{"type":"string","description":"쿠폰유형코드","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"쿠폰상태코드","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"},"ourChrgRate":{"type":"integer","format":"int32","description":"자사 분담률"},"entrChrgRate":{"type":"integer","format":"int32","description":"협력사 분담률"},"promoDesc":{"type":"string","description":"쿠폰 설명"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"회원당 발급 횟수 제한 여부"},"idIssuQty":{"type":"integer","format":"int32","description":"회원당 발급 제한 횟수"},"totCpnIssuLmtYn":{"type":"string","description":"총 발급 횟수 제한 여부"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"총 발급 제한 횟수"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"적용가능매체코드"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"회원등급코드"}},"issuMethCd":{"type":"string","description":"발급방식코드","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"발급유형코드(MK008)"},"aplyTermGbCd":{"type":"string","description":"적용기간구분코드","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"발급일기준쿠폰사용일수"},"usePsbStrDt":{"type":"string","description":"사용가능시작일자"},"usePsbEndDt":{"type":"string","description":"사용가능종료일자"},"useWdayCd":{"type":"array","items":{"type":"string","description":"사용요일코드"}},"tmCpnYn":{"type":"string","description":"타임쿠폰여부"},"usePsbStrTm":{"type":"string","description":"타임쿠폰 시작시간"},"usePsbEndTm":{"type":"string","description":"타임쿠폰 종료시간"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구코드","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"할인율금액"},"minBuyQty":{"type":"integer","format":"int32","description":"최소구매수량"},"minBuyAmt":{"type":"number","description":"최소구매금액"},"maxDcAmt":{"type":"number","description":"최대할인금액"},"dcCpnCd":{"type":"string","description":"할인쿠폰코드"},"autoIssuPotmCd":{"type":"string","description":"자동발급시점코드","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"기념일선발행일수"},"cpbookDispYn":{"type":"string","description":"쿠폰북전시여부"},"dcCpbookCd":{"type":"string","description":"할인쿠폰북코드(MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"자동발급수량"},"aplySites":{"type":"array","items":{"type":"string","description":"적용 조건 - 사이트"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 상품"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 표준카테고리"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"적용 조건 - 전시카테고리"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"적용 조건 - 브랜드"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"적용 조건 - 협력사"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"적용 조건 - 채널"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"string","description":"적용 조건 - 기획전"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 상품"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 표준카테고리"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"제외 조건 - 브랜드"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"제외 조건 - 협력사"}}},"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":["프로모션 관리"],"summary":"쿠폰 등록/수정","description":"## 기능설명\n* 입력된 쿠폰 정보를 저장합니다.\n---\n## 상세설명\n* 입력한 쿠폰의 상세 정보(기본정보, 쿠폰 혜택, 적용대상, 제외대상)를 저장합니다.\n  * **쿠폰번호가 있는 경우** : 쿠폰 등록\n  * **쿠폰번호가 없는 경우** : 쿠폰 수정\n* 선택한 쿠폰 유형, 발급주체, 발급유형에 따라서 각 조건에 맞는 추가 검증을 진행합니다.\n## 수정번호\n* Release v2.00_240509: 적용대상 - 기획전 정보 저장 추가\n","operationId":"registerCoupon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponMgmtCudRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 회원 쿠폰 발급

> \## 기능설명\
> \* 입력된 회원 중 유효한 회원에게 쿠폰을 발급합니다.\
> \---\
> \## 상세설명\
> \* 입력된 회원 중 입력된 쿠폰의 조건에 부합하는 회원에게 쿠폰을 발급합니다.\
> \* 쿠폰 조건\
> &#x20; \* 기본정보\
> &#x20; \* 행사기간\
> &#x20; \* 발급횟수 제한<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":"회원 쿠폰 발급 Request","properties":{"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"mbrNo":{"type":"string","description":"회원번호"},"cpnNo":{"type":"string","description":"쿠폰번호"},"cpnIsuDtm":{"type":"string","format":"date-time","description":"쿠폰발급일시"},"valiStrtDtm":{"type":"string","format":"date-time","description":"유효시작일시"},"valiEndDtm":{"type":"string","format":"date-time","description":"유효종료일시"},"orgCpnIsuNo":{"type":"string","description":"원쿠폰발급번호"},"useGbCd":{"type":"string","description":"사용구분코드(ME014)"},"useYn":{"type":"string","description":"사용여부"},"useDtm":{"type":"string","format":"date-time","description":"사용일시"},"payNo":{"type":"string","description":"결제번호"},"mbrNtcYn":{"type":"string","description":"회원알림여부"},"csCpnPayCausCd":{"type":"string","description":"CS쿠폰지급사유코드(MK021)"},"mgrMemo":{"type":"string","description":"관리메모"},"ordNo":{"type":"string","description":"주문번호"},"ordSeq":{"type":"integer","format":"int32","description":"주문순번"},"ordProcSeq":{"type":"integer","format":"int32","description":"주문처리순번"},"autoIssuOdr":{"type":"string","description":"자동발급차수"}},"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":["프로모션 관리"],"summary":"회원 쿠폰 발급","description":"## 기능설명\n* 입력된 회원 중 유효한 회원에게 쿠폰을 발급합니다.\n---\n## 상세설명\n* 입력된 회원 중 입력된 쿠폰의 조건에 부합하는 회원에게 쿠폰을 발급합니다.\n* 쿠폰 조건\n  * 기본정보\n  * 행사기간\n  * 발급횟수 제한\n","operationId":"registCouponIssuedMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CcCpnIsuMbr"}}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰 기간 변경

> \## 기능설명\
> \* 사용자에게 발급된 쿠폰의 유효기간을 변경합니다.\
> \---\
> \## 상세설명\
> \* 사용자에게 발급된 쿠폰의 유효기간을 변경합니다.\
> \* \*\*쿠폰이 사용된 경우에는 기간변경이 불가능합니다.\*\*<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":"쿠폰발급번호"}},"valiStrtDtm":{"type":"string","format":"date-time","description":"쿠폰 기간변경 유효시작일시"},"valiEndDtm":{"type":"string","format":"date-time","description":"쿠폰 기간변경 유효종료일시"}},"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":["프로모션 관리"],"summary":"쿠폰 기간 변경","description":"## 기능설명\n* 사용자에게 발급된 쿠폰의 유효기간을 변경합니다.\n---\n## 상세설명\n* 사용자에게 발급된 쿠폰의 유효기간을 변경합니다.\n* **쿠폰이 사용된 경우에는 기간변경이 불가능합니다.**\n","operationId":"modifyCouponValiDtm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpnIsuNoListRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 동일 발급 유형 쿠폰 목록 조회

> \## 기능설명\
> \* 발급 유형이 동일한 쿠폰 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 발급 유형이 동일하고, 행사기간이 현재일 이후인 쿠폰 정보를 조회합니다.<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":"쿠폰 저장 Request","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"promoGbCd":{"type":"string","description":"쿠폰/프로모션 구분 코드","enum":["10","20"]},"promoTypCd":{"type":"string","description":"쿠폰유형코드","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"쿠폰상태코드","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"},"ourChrgRate":{"type":"integer","format":"int32","description":"자사 분담률"},"entrChrgRate":{"type":"integer","format":"int32","description":"협력사 분담률"},"promoDesc":{"type":"string","description":"쿠폰 설명"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"회원당 발급 횟수 제한 여부"},"idIssuQty":{"type":"integer","format":"int32","description":"회원당 발급 제한 횟수"},"totCpnIssuLmtYn":{"type":"string","description":"총 발급 횟수 제한 여부"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"총 발급 제한 횟수"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"적용가능매체코드"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"회원등급코드"}},"issuMethCd":{"type":"string","description":"발급방식코드","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"발급유형코드(MK008)"},"aplyTermGbCd":{"type":"string","description":"적용기간구분코드","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"발급일기준쿠폰사용일수"},"usePsbStrDt":{"type":"string","description":"사용가능시작일자"},"usePsbEndDt":{"type":"string","description":"사용가능종료일자"},"useWdayCd":{"type":"array","items":{"type":"string","description":"사용요일코드"}},"tmCpnYn":{"type":"string","description":"타임쿠폰여부"},"usePsbStrTm":{"type":"string","description":"타임쿠폰 시작시간"},"usePsbEndTm":{"type":"string","description":"타임쿠폰 종료시간"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구코드","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"할인율금액"},"minBuyQty":{"type":"integer","format":"int32","description":"최소구매수량"},"minBuyAmt":{"type":"number","description":"최소구매금액"},"maxDcAmt":{"type":"number","description":"최대할인금액"},"dcCpnCd":{"type":"string","description":"할인쿠폰코드"},"autoIssuPotmCd":{"type":"string","description":"자동발급시점코드","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"기념일선발행일수"},"cpbookDispYn":{"type":"string","description":"쿠폰북전시여부"},"dcCpbookCd":{"type":"string","description":"할인쿠폰북코드(MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"자동발급수량"},"aplySites":{"type":"array","items":{"type":"string","description":"적용 조건 - 사이트"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 상품"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 표준카테고리"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"적용 조건 - 전시카테고리"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"적용 조건 - 브랜드"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"적용 조건 - 협력사"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"적용 조건 - 채널"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"string","description":"적용 조건 - 기획전"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 상품"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 표준카테고리"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"제외 조건 - 브랜드"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"제외 조건 - 협력사"}}},"required":["entrChrgRate","fixamtFxrtGbCd","idIssuLmtYn","issuSubCd","ourChrgRate","promoDesc","promoEndDtm","promoGbCd","promoNm","promoNo","promoStatCd","promoStrDtm","promoTypCd","totCpnIssuLmtYn"]},"CouponResponse":{"type":"object","description":"쿠폰 관리 조회 Response","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"promoTypCd":{"type":"string","description":"쿠폰유형코드","enum":["11","12","13","14","15","20","21","40"]},"promoTypNm":{"type":"string","description":"쿠폰유형명"},"promoStatCd":{"type":"string","description":"쿠폰상태코드","enum":["10","20"]},"promoStatNm":{"type":"string","description":"쿠폰상태명"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구코드","enum":["01","02"]},"fixamtFxrtGbNm":{"type":"string","description":"정액정율구분명"},"dcRateAmt":{"type":"number","description":"할인액(율)"},"promoStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"},"usePsbStrDt":{"type":"string","description":"사용시작일자"},"usePsbEndDt":{"type":"string","description":"사용종료일자"},"issuMethCd":{"type":"string","description":"발급방식코드","enum":["01","02","03","04"]},"issuMethCdNm":{"type":"string","description":"발급방식코드명"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드","enum":["01","02","03","04"]},"issuSubCdNm":{"type":"string","description":"쿠폰발급주체코드명"},"autoIssuTypCd":{"type":"string","description":"발급유형코드(MK008)"},"autoIssuTypNm":{"type":"string","description":"발급유형명"},"autoIssuPotmCd":{"type":"string","description":"자동발급시점코드","enum":["01","02"]},"autoIssuPotmNm":{"type":"string","description":"자동발급시점명"},"anvyPreIsuDds":{"type":"string","description":"기념일선발행일수"}},"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":["프로모션 관리"],"summary":"동일 발급 유형 쿠폰 목록 조회","description":"## 기능설명\n* 발급 유형이 동일한 쿠폰 정보를 조회합니다.\n---\n## 상세설명\n* 발급 유형이 동일하고, 행사기간이 현재일 이후인 쿠폰 정보를 조회합니다.\n","operationId":"getValidCouponListForSameAutoIssueType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponMgmtCudRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 혜택 등록 시 역마진 상품 체크

> \## 기능설명\
> \* 적용 조건 중 역마진 상품이 있는지 체크합니다.\
> \---\
> \## 상세설명\
> \* 적용 - 상품 리스트 중에 역마진이 있는 상품을 체크합니다.\
> \* 역마진이 발생하는 경우는 아래와 같습니다.\
> &#x20; \* 공급가 > 판매가 - 할인금액\
> \* 다른 적용 조건과 제외 대상은 역마진 체크를 진행하지 않습니다.<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":"상품번호"}},"fixamtFxrtGbCd":{"type":"string","description":"현재 쿠폰의 정액/정률 구분 코드","enum":["01","02"]},"dcRateAmt":{"type":"integer","format":"int64","description":"현재 쿠폰의 할인금액/률"}},"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":["프로모션 관리"],"summary":"혜택 등록 시 역마진 상품 체크","description":"## 기능설명\n* 적용 조건 중 역마진 상품이 있는지 체크합니다.\n---\n## 상세설명\n* 적용 - 상품 리스트 중에 역마진이 있는 상품을 체크합니다.\n* 역마진이 발생하는 경우는 아래와 같습니다.\n  * 공급가 > 판매가 - 할인금액\n* 다른 적용 조건과 제외 대상은 역마진 체크를 진행하지 않습니다.\n","operationId":"getOverMrgnGoods","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionGoodsOverCheckRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 회원 쿠폰 일괄발급 조회

> \## 기능설명\
> \* 첨부한 양식에 있는 회원 정보를 불러오는 API입니다.\
> \---\
> \## 상세설명\
> \* 첨부한 양식에 입력된 회원 정보 중 유효한 정보에 해당하는 회원정보를 조회하여 그리드에 표시합니다.\
> \* 양식에서 사용할 수 있는 등록 방법은 아래와 같습니다.\
> &#x20; \* \*\*등록구분\*\*\
> &#x20;   \* 10 : 회원번호\
> &#x20;   \* 20 : 로그인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":"회원 쿠폰 일괄발급 조회 Request","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"couponIssuedMemberResponse":{"type":"array","items":{"$ref":"#/components/schemas/CouponIssuedMemberResponse"}}},"required":["promoNo"]},"CouponIssuedMemberResponse":{"type":"object","properties":{"cpnIsuNo":{"type":"string","description":"쿠폰발급번호"},"orgCpnIsuNo":{"type":"string","description":"원쿠폰발급번호"},"mbrNo":{"type":"string","description":"회원번호"},"mbrNm":{"type":"string","description":"회원명"},"loginId":{"type":"string","description":"회원ID"},"mbrGradeCd":{"type":"string","description":"회원등급코드"},"mbrGradeNm":{"type":"string","description":"회원등급코드명"},"cpnNo":{"type":"string","description":"쿠폰번호"},"cpnIsuDtm":{"type":"string","format":"date-time","description":"쿠폰발급일시"},"valiStrtDtm":{"type":"string","format":"date-time","description":"유효시작일시"},"valiEndDtm":{"type":"string","format":"date-time","description":"유효종료일시"},"useYn":{"type":"string","description":"사용여부"},"mgrMemo":{"type":"string","description":"쿠폰관리메모"},"dataType":{"type":"string","description":"일괄등록 시 키값 유형 코드(CouponUploadMbrType. 10 : 회원번호, 20 : 로그인ID, 30 : 기간계회원번호)"}},"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":["프로모션 관리"],"summary":"회원 쿠폰 일괄발급 조회","description":"## 기능설명\n* 첨부한 양식에 있는 회원 정보를 불러오는 API입니다.\n---\n## 상세설명\n* 첨부한 양식에 입력된 회원 정보 중 유효한 정보에 해당하는 회원정보를 조회하여 그리드에 표시합니다.\n* 양식에서 사용할 수 있는 등록 방법은 아래와 같습니다.\n  * **등록구분**\n    * 10 : 회원번호\n    * 20 : 로그인ID\n","operationId":"couponIssuedMbrLoadByExcel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponIssuedMemberListRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CouponIssuedMemberResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 사은행사 등록/수정

> \## 기능설명\
> \* 입력된 사은행사 정보를 저장합니다.\
> \---\
> \## 상세설명\
> \* 입력한 사은행사의 상세 정보(기본정보, 지급 설정, 적용대상)를 저장합니다.\
> &#x20; \* \*\*사은행사 번호가 있는 경우\*\* : 기존 사은행사 정보를 수정합니다.\
> &#x20; \* \*\*사은행사 번호가 없는 경우\*\* : 신규 사은행사 정보를 등록합니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v1.06\_231218\`\`\` : 프로모션 사은행사 등록 시 사은품 코드 중복등록 체크 기능 추가<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":"사은행사 등록 Request","properties":{"aeNo":{"type":"string","description":"사은행사 번호"},"aeNm":{"type":"string","description":"사은행사 명"},"addEvtTypCd":{"type":"string","description":"사은행사 유형 코드","enum":["10","20"]},"aePrgsStatCd":{"type":"string","description":"사은행사 상태 코드","enum":["10","20"]},"aeDesc":{"type":"string","description":"사은행사 설명"},"entrNo":{"type":"string","description":"진행협력사번호"},"aeStrDtm":{"type":"string","format":"date-time","description":"사은행사 시작일시"},"aeEndDtm":{"type":"string","format":"date-time","description":"사은행사 종료일시"},"payStrDt":{"type":"string","description":"사은행사 지급 시작날짜"},"payEndDt":{"type":"string","description":"사은행사 지급 종료날짜"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"적용 매체 리스트"}},"mbrTypCd":{"type":"string","description":"사은행사 적용대상","enum":["01","02","03"]},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"적용 회원등급 리스트"}},"tmEvtYn":{"type":"string","description":"타임행사 여부"},"aplyStrTm":{"type":"string","description":"타임행사 시작 시간"},"aplyEndTm":{"type":"string","description":"타임행사 종료 시간"},"aeFvrInfo":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"행사 조건 정보"}},"aplySites":{"type":"array","items":{"type":"string","description":"적용 조건 - 사이트"}},"aplyGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 상품"}},"aplyStdGoods":{"type":"array","items":{"type":"string","description":"적용 조건 - 표준카테고리"}},"aplyCategory":{"type":"array","items":{"type":"string","description":"적용 조건 - 전시카테고리"}},"aplyBrand":{"type":"array","items":{"type":"string","description":"적용 조건 - 브랜드"}},"aplyEntr":{"type":"array","items":{"type":"string","description":"적용 조건 - 협력사"}},"aplyChannel":{"type":"array","items":{"type":"string","description":"적용 조건 - 채널"}},"exceptGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 상품"}},"exceptStdGoods":{"type":"array","items":{"type":"string","description":"제외 조건 - 표준카테고리"}},"exceptBrand":{"type":"array","items":{"type":"string","description":"제외 조건 - 브랜드"}},"exceptEntr":{"type":"array","items":{"type":"string","description":"제외 조건 - 협력사"}}},"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":["프로모션 관리"],"summary":"사은행사 등록/수정","description":"## 기능설명\n* 입력된 사은행사 정보를 저장합니다.\n---\n## 상세설명\n* 입력한 사은행사의 상세 정보(기본정보, 지급 설정, 적용대상)를 저장합니다.\n  * **사은행사 번호가 있는 경우** : 기존 사은행사 정보를 수정합니다.\n  * **사은행사 번호가 없는 경우** : 신규 사은행사 정보를 등록합니다.\n---\n## 수정번호\n* ```Release v1.06_231218``` : 프로모션 사은행사 등록 시 사은품 코드 중복등록 체크 기능 추가\n","operationId":"registAppreciation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppreciationCudRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## 할인/마일리지 목록 조회

> \## 기능설명\
> \* 등록된 할인/마일리지 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 검색조건에 맞는 할인/마일리지를 조회합니다. 검색조건은 아래와 같습니다.\
> &#x20; \* 할인/마일리지 기간\
> &#x20; \* 할인/마일리지 유형\
> &#x20; \* 할인/마일리지 상태\
> &#x20; \* 할인/마일리지 번호/명\
> &#x20; \* 등록자\
> \---\
> \## 수정번호\
> \* Release v2.00\_240530: 날짜조회 쿼리 변경<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":"프로모션번호"},"promoTypNm":{"type":"string","description":"프로모션명"},"promoTypCd":{"type":"string","description":"프로모션유형명"},"promoNm":{"type":"string","description":"프로모션유형","enum":["11","12","13","14","15","20","21","40"]},"promoStatNm":{"type":"string","description":"프로모션상태명"},"promoStatCd":{"type":"string","description":"프로모션상태","enum":["10","20"]},"fixamtFxrtGbNm":{"type":"string","description":"정액정율구분명"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구분","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"할인액(율)"},"promoStrDtm":{"type":"string","format":"date-time","description":"프로모션시작일자"},"promoEndDtm":{"type":"string","format":"date-time","description":"프로모션종료일자"}},"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":["프로모션 관리"],"summary":"할인/마일리지 목록 조회","description":"## 기능설명\n* 등록된 할인/마일리지 정보를 조회합니다.\n---\n## 상세설명\n* 검색조건에 맞는 할인/마일리지를 조회합니다. 검색조건은 아래와 같습니다.\n  * 할인/마일리지 기간\n  * 할인/마일리지 유형\n  * 할인/마일리지 상태\n  * 할인/마일리지 번호/명\n  * 등록자\n---\n## 수정번호\n* Release v2.00_240530: 날짜조회 쿼리 변경\n","operationId":"getPromotionManagingList","parameters":[{"name":"searchDateType","in":"query","description":"검색기간 유형 코드(0 : 적용시작일 , 1 : 등록일)","required":true,"schema":{"type":"string","description":"검색기간 유형 코드(0 : 적용시작일 , 1 : 등록일)"}},{"name":"startDate","in":"query","description":"시작일자","required":true,"schema":{"type":"string","format":"date","description":"시작일자"}},{"name":"endDate","in":"query","description":"종료일자","required":true,"schema":{"type":"string","format":"date","description":"종료일자"}},{"name":"userId","in":"query","description":"등록ID","required":false,"schema":{"type":"string","description":"등록ID"}},{"name":"promoTypCd","in":"query","description":"프로모션유형 코드[MK002](20 : 임직원할인, 21 : 상품즉시할인, 40 : 상품마일리지)","required":false,"schema":{"type":"string","description":"프로모션유형 코드[MK002](20 : 임직원할인, 21 : 상품즉시할인, 40 : 상품마일리지)"}},{"name":"promoStatCd","in":"query","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)","required":false,"schema":{"type":"string","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)"}},{"name":"promoNo","in":"query","description":"프로모션번호","required":false,"schema":{"type":"string","description":"프로모션번호"}},{"name":"promoNm","in":"query","description":"프로모션명","required":false,"schema":{"type":"string","description":"프로모션명"}},{"name":"entiretyPeriodYn","in":"query","description":"전체기간여부","required":false,"schema":{"type":"string","description":"전체기간여부"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePromotionResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 마일리지 기준정보 목록/건수 조회

> \## 기능설명\
> \* 마일리지 기준정보 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 선택한 적립구분코드에 맞는 마일리지 기준정보 목록을 조회합니다.\
> \---<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":" 마일리지기준정보순번"},"rsrvGbCd":{"type":"string","description":" 적립구분코드(CM016)"},"rsrvTgtCd":{"type":"string","description":" 적립대상코드(CM017)"},"milgTypNm":{"type":"string","description":" 마일리지유형명"},"baseRsrvRate":{"type":"number","format":"double","description":" 기본적립율"},"addRsrvAmt":{"type":"number","description":" 추가적립금액"},"mbrGradeCd":{"type":"string","description":" 회원등급코드(ME008)"},"rsrvStdAmt":{"type":"number","description":" 적립기준금액"},"rsrvStdDds":{"type":"integer","format":"int32","description":" 적립기준일수"},"valiTermDds":{"type":"integer","format":"int32","description":" 유효기간일수"},"mmMaxRsrvAmt":{"type":"number","description":" 월최대적립금액"},"yyMaxRsrvAmt":{"type":"number","description":" 년최대적립금액"},"chgCausDesc":{"type":"string","description":" 변경사유설명"},"rmkCont":{"type":"string","description":" 비고내용"}}},"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":["프로모션 관리"],"summary":"마일리지 기준정보 목록/건수 조회","description":"## 기능설명\n* 마일리지 기준정보 목록을 조회합니다.\n---\n## 상세설명\n* 선택한 적립구분코드에 맞는 마일리지 기준정보 목록을 조회합니다.\n---\n","operationId":"getMilgStdList","parameters":[{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}},{"name":"rsrvGbCd","in":"query","description":"적립구분코드(CM016)","required":true,"schema":{"type":"string","description":"적립구분코드(CM016)","enum":["100","110","120","130","200","210","220"]}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseMilgStdResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 마일리지 기준정보 변경이력 목록/건수 조회

> \## 기능설명\
> \* 마일리지 기준정보 변경이력 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 조건에 맞는 마일리지 기준정보 변경이력 목록을 조회합니다.\
> &#x20; \* 마일리지 기준정보 순번\
> &#x20; \* 적립구분코드\
> &#x20; \* 적립대상코드\
> \---<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":"마일리지기준정보순번"},"histStrDtm":{"type":"string","format":"date-time","description":"이력시작일시"},"histEndDtm":{"type":"string","format":"date-time","description":"이력종료일시"},"rsrvGbCd":{"type":"string","description":"적립구분코드(CM016)"},"rsrvTgtCd":{"type":"string","description":"적립대상코드(CM017)"},"milgTypNm":{"type":"string","description":"마일리지유형명"},"baseRsrvRate":{"type":"number","format":"double","description":"기본적립율"},"addRsrvAmt":{"type":"number","description":"추가적립금액"},"mbrGradeCd":{"type":"string","description":"회원등급코드(ME008)"},"rsrvStdAmt":{"type":"number","description":"적립기준금액"},"rsrvStdDds":{"type":"integer","format":"int32","description":"적립기준일수"},"valiTermDds":{"type":"integer","format":"int32","description":"유효기간일수"},"mmMaxRsrvAmt":{"type":"number","description":"월최대적립금액"},"yyMaxRsrvAmt":{"type":"number","description":"년최대적립금액"},"chgCausDesc":{"type":"string","description":"변경사유설명"},"rmkCont":{"type":"string","description":"비고내용"}}},"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":["프로모션 관리"],"summary":"마일리지 기준정보 변경이력 목록/건수 조회","description":"## 기능설명\n* 마일리지 기준정보 변경이력 목록을 조회합니다.\n---\n## 상세설명\n* 조건에 맞는 마일리지 기준정보 변경이력 목록을 조회합니다.\n  * 마일리지 기준정보 순번\n  * 적립구분코드\n  * 적립대상코드\n---\n","operationId":"getMilgStdChgHistList","parameters":[{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}},{"name":"milgStdInfoSeq","in":"query","description":"마일리지 기준정보 순번","required":true,"schema":{"type":"string","description":"마일리지 기준정보 순번"}},{"name":"rsrvGbCd","in":"query","description":"적립구분코드(CM016)","required":true,"schema":{"type":"string","description":"적립구분코드(CM016)","enum":["100","110","120","130","200","210","220"]}},{"name":"rsrvTgtCd","in":"query","description":"적립대상코드(CM017)","required":true,"schema":{"type":"string","description":"적립대상코드(CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseMilgStdChgHistResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰관리 목록/건수 조회

> \## 기능설명\
> \* 등록된 쿠폰 정보 및 건수를 조회합니다.\
> \---\
> \## 상세설명\
> \* 검색조건에 맞는 쿠폰 정보를 조회합니다. 검색조건은 아래와 같습니다.\
> &#x20; \* 기간(행사기간, 사용가능기간, 등록기간)\
> &#x20; \* 쿠폰유형\
> &#x20; \* 쿠폰상태\
> &#x20; \* 등록자\
> &#x20; \* 쿠폰번호/명\
> &#x20; \* 발급방식\
> \---\
> \## 수정번호\
> \* Release v2.00\_240530: 날짜조회 쿼리 변경<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":"쿠폰 관리 조회 Response","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoNm":{"type":"string","description":"쿠폰명"},"promoTypCd":{"type":"string","description":"쿠폰유형코드","enum":["11","12","13","14","15","20","21","40"]},"promoTypNm":{"type":"string","description":"쿠폰유형명"},"promoStatCd":{"type":"string","description":"쿠폰상태코드","enum":["10","20"]},"promoStatNm":{"type":"string","description":"쿠폰상태명"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구코드","enum":["01","02"]},"fixamtFxrtGbNm":{"type":"string","description":"정액정율구분명"},"dcRateAmt":{"type":"number","description":"할인액(율)"},"promoStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"},"usePsbStrDt":{"type":"string","description":"사용시작일자"},"usePsbEndDt":{"type":"string","description":"사용종료일자"},"issuMethCd":{"type":"string","description":"발급방식코드","enum":["01","02","03","04"]},"issuMethCdNm":{"type":"string","description":"발급방식코드명"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드","enum":["01","02","03","04"]},"issuSubCdNm":{"type":"string","description":"쿠폰발급주체코드명"},"autoIssuTypCd":{"type":"string","description":"발급유형코드(MK008)"},"autoIssuTypNm":{"type":"string","description":"발급유형명"},"autoIssuPotmCd":{"type":"string","description":"자동발급시점코드","enum":["01","02"]},"autoIssuPotmNm":{"type":"string","description":"자동발급시점명"},"anvyPreIsuDds":{"type":"string","description":"기념일선발행일수"}},"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":["프로모션 관리"],"summary":"쿠폰관리 목록/건수 조회","description":"## 기능설명\n* 등록된 쿠폰 정보 및 건수를 조회합니다.\n---\n## 상세설명\n* 검색조건에 맞는 쿠폰 정보를 조회합니다. 검색조건은 아래와 같습니다.\n  * 기간(행사기간, 사용가능기간, 등록기간)\n  * 쿠폰유형\n  * 쿠폰상태\n  * 등록자\n  * 쿠폰번호/명\n  * 발급방식\n---\n## 수정번호\n* Release v2.00_240530: 날짜조회 쿼리 변경\n","operationId":"getCouponList","parameters":[{"name":"searchDateType","in":"query","description":"검색기간 유형 코드(0 : 전시시작일자 , 1 : 사용시작일자, 2 : 등록일자)","required":true,"schema":{"type":"string","description":"검색기간 유형 코드(0 : 전시시작일자 , 1 : 사용시작일자, 2 : 등록일자)"}},{"name":"startDate","in":"query","description":"기간 시작일자","required":true,"schema":{"type":"string","format":"date","description":"기간 시작일자"}},{"name":"endDate","in":"query","description":"기간 종료일자","required":true,"schema":{"type":"string","format":"date","description":"기간 종료일자"}},{"name":"userId","in":"query","description":"등록자ID","required":false,"schema":{"type":"string","description":"등록자ID"}},{"name":"promoTypCd","in":"query","description":"쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)","required":false,"schema":{"type":"string","description":"쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)"}},{"name":"promoStatCd","in":"query","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)","required":false,"schema":{"type":"string","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)"}},{"name":"promoNo","in":"query","description":"쿠폰번호","required":false,"schema":{"type":"string","description":"쿠폰번호"}},{"name":"promoNm","in":"query","description":"쿠폰명","required":false,"schema":{"type":"string","description":"쿠폰명"}},{"name":"issuMethCd","in":"query","description":"발급방식코드[MK007](01 : 대상자지정발급, 02 : 조건부자동발급, 03 : 고객다운로드발급, 04 : 할인쿠폰코드발급)","required":false,"schema":{"type":"string","description":"발급방식코드[MK007](01 : 대상자지정발급, 02 : 조건부자동발급, 03 : 고객다운로드발급, 04 : 할인쿠폰코드발급)"}},{"name":"issuSubCd","in":"query","description":"쿠폰발급주체코드[MK006](01 : 고정판촉쿠폰, 02 : 이벤트쿠폰, 04 : 제휴사, 05 : 고객보상쿠폰)","required":false,"schema":{"type":"string","description":"쿠폰발급주체코드[MK006](01 : 고정판촉쿠폰, 02 : 이벤트쿠폰, 04 : 제휴사, 05 : 고객보상쿠폰)"}},{"name":"autoIssuTypCd","in":"query","description":"자동발급유형코드[MK008]","required":false,"schema":{"type":"string","description":"자동발급유형코드[MK008]"}},{"name":"entiretyPeriodYn","in":"query","description":"전체기간여부","required":false,"schema":{"type":"string","description":"전체기간여부"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰 발급회원 조회

> &#x20;        \## 기능설명\
> &#x20;        \* 해당 쿠폰을 발급받은 회원 정보를 조회합니다.\
> &#x20;        \---\
> &#x20;        \## 상세설명\
> &#x20;        \* 해당 쿠폰을 발급받은 회원 정보를 조회합니다.\
> &#x20;        \* 아래 내용들은 \*\*마스킹\*\*되어 노출되어집니다.\
> &#x20;          \* 회원ID\
> &#x20;          \* 회원명\
> &#x20;        \---\
> \## 수정번호\
> \* Release v2.00\_240829 : 마스킹 처리 현행화<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":"쿠폰발급번호"},"orgCpnIsuNo":{"type":"string","description":"원쿠폰발급번호"},"mbrNo":{"type":"string","description":"회원번호"},"mbrNm":{"type":"string","description":"회원명"},"loginId":{"type":"string","description":"회원ID"},"mbrGradeCd":{"type":"string","description":"회원등급코드"},"mbrGradeNm":{"type":"string","description":"회원등급코드명"},"cpnNo":{"type":"string","description":"쿠폰번호"},"cpnIsuDtm":{"type":"string","format":"date-time","description":"쿠폰발급일시"},"valiStrtDtm":{"type":"string","format":"date-time","description":"유효시작일시"},"valiEndDtm":{"type":"string","format":"date-time","description":"유효종료일시"},"useYn":{"type":"string","description":"사용여부"},"mgrMemo":{"type":"string","description":"쿠폰관리메모"},"dataType":{"type":"string","description":"일괄등록 시 키값 유형 코드(CouponUploadMbrType. 10 : 회원번호, 20 : 로그인ID, 30 : 기간계회원번호)"}},"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":["프로모션 관리"],"summary":"쿠폰 발급회원 조회","description":"         ## 기능설명\n         * 해당 쿠폰을 발급받은 회원 정보를 조회합니다.\n         ---\n         ## 상세설명\n         * 해당 쿠폰을 발급받은 회원 정보를 조회합니다.\n         * 아래 내용들은 **마스킹**되어 노출되어집니다.\n           * 회원ID\n           * 회원명\n         ---\n## 수정번호\n* Release v2.00_240829 : 마스킹 처리 현행화\n","operationId":"getCouponIssuedMemberList","parameters":[{"name":"cpnNo","in":"query","description":"쿠폰번호","required":true,"schema":{"type":"string","description":"쿠폰번호"}},{"name":"mbrNo","in":"query","description":"회원번호","required":false,"schema":{"type":"string","description":"회원번호"}},{"name":"useYn","in":"query","description":"사용여부","required":false,"schema":{"type":"string","description":"사용여부"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponIssuedMemberResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰 비용 관리 목록 및 건수 조회

> \## 기능설명\
> \* 쿠폰별로 발급, 사용에 관련된 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 쿠폰별로 해당 일자의 발급건수, 사용건수 등을 조회합니다.\
> \* 검색조건은 아래와 같습니다.\
> &#x20; \* 발급기간\
> &#x20; \* 쿠폰유형\
> &#x20; \* 쿠폰상태\
> &#x20; \* 쿠폰번호/명\
> &#x20; \* 등록자\
> \---\
> \## 수정번호\
> \* Release v2.00\_240530: 날짜조회 쿼리 변경<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":"쿠폰 비용관리 조회 Response","properties":{"cpnNo":{"type":"string","description":"쿠폰번호"},"promoTypCd":{"type":"string","description":"쿠폰유형 코드","enum":["11","12","13","14","15","20","21","40"]},"promoTypCdNm":{"type":"string","description":"쿠폰유형 코드명"},"promoStatCd":{"type":"string","description":"쿠폰상태 코드","enum":["10","20"]},"promoStatCdNm":{"type":"string","description":"쿠폰상태 코드명"},"promoNm":{"type":"string","description":"쿠폰명"},"isuCnt":{"type":"integer","format":"int32","description":"발급건수"},"useCnt":{"type":"integer","format":"int32","description":"사용건수"},"notUseCnt":{"type":"integer","format":"int32","description":"미사용건수"},"productAmt":{"type":"integer","format":"int32","description":"총상품금액"},"cpnAmt":{"type":"integer","format":"int32","description":"쿠폰비용"},"useRate":{"type":"number","format":"double","description":"사용율"},"fixamtFxrtGbCd":{"type":"string","description":"정액/정률구분 코드","enum":["01","02"]},"fixamtFxrtGbCdNm":{"type":"string","description":"정액/정률구분 코드명"},"dcRateAmt":{"type":"number","description":"할인금액"},"totalCount":{"type":"integer","format":"int32","description":"전체 건수"}},"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":["프로모션 관리"],"summary":"쿠폰 비용 관리 목록 및 건수 조회","description":"## 기능설명\n* 쿠폰별로 발급, 사용에 관련된 정보를 조회합니다.\n---\n## 상세설명\n* 쿠폰별로 해당 일자의 발급건수, 사용건수 등을 조회합니다.\n* 검색조건은 아래와 같습니다.\n  * 발급기간\n  * 쿠폰유형\n  * 쿠폰상태\n  * 쿠폰번호/명\n  * 등록자\n---\n## 수정번호\n* Release v2.00_240530: 날짜조회 쿼리 변경\n","operationId":"getCouponCostList","parameters":[{"name":"searchDateType","in":"query","description":"검색기간 유형 코드(0 : 발급시작일 , 1 : 등록일)","required":true,"schema":{"type":"string","description":"검색기간 유형 코드(0 : 발급시작일 , 1 : 등록일)"}},{"name":"startDate","in":"query","description":"기간 시작 일자","required":true,"schema":{"type":"string","format":"date","description":"기간 시작 일자"}},{"name":"endDate","in":"query","description":"기간 시작 일자","required":true,"schema":{"type":"string","format":"date","description":"기간 시작 일자"}},{"name":"promoTypCd","in":"query","description":"쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)","required":false,"schema":{"type":"string","description":"쿠폰유형 코드[MK002](11 : 상품할인쿠폰, 12 : 장바구니쿠폰, 13 : 중복할인쿠폰, 14 : 무료배송쿠폰, 15 : 무료반품쿠폰)"}},{"name":"promoStatCd","in":"query","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)","required":false,"schema":{"type":"string","description":"쿠폰상태 코드[MK003](10 : 정상, 20 : 중단)"}},{"name":"fixamtFxrtGbCd","in":"query","description":"할인 유형 코드[MK005]","required":false,"schema":{"type":"string","description":"할인 유형 코드[MK005]"}},{"name":"promoNo","in":"query","description":"쿠폰번호","required":false,"schema":{"type":"string","description":"쿠폰번호"}},{"name":"promoNm","in":"query","description":"쿠폰명","required":false,"schema":{"type":"string","description":"쿠폰명"}},{"name":"userId","in":"query","description":"등록자ID","required":false,"schema":{"type":"string","description":"등록자ID"}},{"name":"isEntiretyPeriod","in":"query","description":"전체기간여부","required":false,"schema":{"type":"boolean","description":"전체기간여부"}},{"name":"dateSelect","in":"query","description":"조회기간 선택","required":false,"schema":{"type":"string","description":"조회기간 선택"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponCostResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 사은행사 관리 목록 조회

> \## 기능설명\
> \* 등록된 사은행사 정보를 조회하는 API 입니다.\
> \---\
> \## 상세설명\
> \* 검색조건에 맞는 사은행사 정보를 조회합니다. 검색조건은 아래와 같습니다.\
> &#x20; \* 사은행사 기간\
> &#x20; \* 사은행사 유형\
> &#x20; \* 사은행사 상태\
> &#x20; \* 등록자\
> &#x20; \* 사은행사 번호/명\
> \---\
> \## 수정번호\
> \* Release v2.00\_240530: 날짜조회 쿼리 변경<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":"사은행사 관리 조회 Response","properties":{"aeGubun":{"type":"string","description":"사은행사대분류구분(10:프로모션사은행사, 20: 이벤트 사은행사)"},"aeNo":{"type":"string","description":"사은행사 번호"},"aeNm":{"type":"string","description":"사은행사 명"},"addEvtTypCd":{"type":"string","description":"사은행사 유형 코드","enum":["10","20"]},"addEvtTypNm":{"type":"string","description":"사은행사 유형 명"},"aePrgsStatCd":{"type":"string","description":"사은행사 상태 코드","enum":["10","20"]},"aePrgsStatNm":{"type":"string","description":"사은행사 상태 명"},"aeDesc":{"type":"string","description":"사은행사 설명"},"entrNo":{"type":"string","description":"진행협력사번호"},"entrNm":{"type":"string","description":"진행협력사명"},"aeStrDtm":{"type":"string","format":"date-time","description":"사은행사 시작 일시"},"aeEndDtm":{"type":"string","format":"date-time","description":"사은행사 종료 일시"},"payStrDt":{"type":"string","description":"사은행사 지급 시작일"},"payEndDt":{"type":"string","description":"사은행사 지급 종료일"},"mbrTypCd":{"type":"string","description":"적용대상(회원유형)","enum":["01","02","03"]},"mbrTypCdNm":{"type":"string","description":"적용대상명(회원유형)"},"tmEvtYn":{"type":"string","description":"타임행사 여부"},"aplyStrTm":{"type":"string","description":"타임행사 시작 시간"},"aplyEndTm":{"type":"string","description":"타임행사 종료 시간"}},"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":["프로모션 관리"],"summary":"사은행사 관리 목록 조회","description":"## 기능설명\n* 등록된 사은행사 정보를 조회하는 API 입니다.\n---\n## 상세설명\n* 검색조건에 맞는 사은행사 정보를 조회합니다. 검색조건은 아래와 같습니다.\n  * 사은행사 기간\n  * 사은행사 유형\n  * 사은행사 상태\n  * 등록자\n  * 사은행사 번호/명\n---\n## 수정번호\n* Release v2.00_240530: 날짜조회 쿼리 변경\n","operationId":"getAppreciationEventList","parameters":[{"name":"searchDateType","in":"query","description":"검색기간 유형 코드(0 : 행사시작일 , 1 : 지급일)","required":true,"schema":{"type":"string","description":"검색기간 유형 코드(0 : 행사시작일 , 1 : 지급일)"}},{"name":"startDate","in":"query","description":"사은행사기간 시작일자","required":true,"schema":{"type":"string","format":"date","description":"사은행사기간 시작일자"}},{"name":"endDate","in":"query","description":"사은행사기간 종료일자","required":true,"schema":{"type":"string","format":"date","description":"사은행사기간 종료일자"}},{"name":"userId","in":"query","description":"등록자ID","required":false,"schema":{"type":"string","description":"등록자ID"}},{"name":"addEvtTypCd","in":"query","description":"사은행사 유형 코드[MK012](10 : 구매금액사은행사, 20 : 상품사은행사","required":false,"schema":{"type":"string","description":"사은행사 유형 코드[MK012](10 : 구매금액사은행사, 20 : 상품사은행사"}},{"name":"aePrgsStatCd","in":"query","description":"사은행사 상태 코드[MK003](10 : 정상, 20 : 중단)","required":false,"schema":{"type":"string","description":"사은행사 상태 코드[MK003](10 : 정상, 20 : 중단)"}},{"name":"aeNo","in":"query","description":"사은행사 번호","required":false,"schema":{"type":"string","description":"사은행사 번호"}},{"name":"aeNm","in":"query","description":"사은행사 명","required":false,"schema":{"type":"string","description":"사은행사 명"}},{"name":"mbrTypCd","in":"query","description":"적용대상","required":false,"schema":{"type":"string","description":"적용대상"}},{"name":"entiretyPeriodYn","in":"query","description":"전체기간여부","required":false,"schema":{"type":"string","description":"전체기간여부"}},{"name":"entrNo","in":"query","description":"진행 협력사 코드","required":false,"schema":{"type":"string","description":"진행 협력사 코드"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseAppreciateResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 사은품 지급 고객 정보 조회

> \## 기능설명\
> \* 사은품을 선택한 주문 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 사은품을 선택한 주문 중 검색조건에 맞는 주문 정보를 조회합니다. 검색조건은 아래와 같습니다.\
> &#x20; \* 사은행사 기간\
> &#x20; \* 사은행사 유형\
> &#x20; \* 사은행사 상태\
> &#x20; \* 등록자\
> &#x20; \* 사은행사 번호/명\
> \* Response 중 아래 내용들은 \*\*마스킹\*\*되어 노출되어집니다.\
> &#x20; \* 회원ID\
> &#x20; \* 회원명\
> &#x20; \* 휴대폰번호\
> &#x20; \* 주문배송지<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":"사은품 지급 고객 관리 정보","properties":{"ordNo":{"type":"string","description":"주문 번호"},"loginId":{"type":"string","description":"회원 ID"},"mbrGbCdNm":{"type":"string","description":"회원 구분코드 명"},"mbrNm":{"type":"string","description":"회원명"},"mbrNo":{"type":"string","description":"회원번호"},"mbrGradeCdNm":{"type":"string","description":"회원 등급 코드 명"},"mbrJoinDtm":{"type":"string","format":"date-time","description":"회원가입일시"},"tellNo":{"type":"string","description":"휴대폰번호"},"ordAccpDtm":{"type":"string","format":"date-time","description":"주문 접수 일자"},"zipNo":{"type":"string","description":"우편번호"},"addr":{"type":"string","description":"주분매송지"},"aeNm":{"type":"string","description":"사은행사 명"},"aeNo":{"type":"string","description":"사은행사 번호"},"aeGoodsNo":{"type":"string","description":"사은품 번호"},"aeGoodsNm":{"type":"string","description":"사은품 명"},"realAmt":{"type":"integer","format":"int64","description":"실결제금액"},"ordCnt":{"type":"integer","format":"int32","description":"주문상품수량"},"aeStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"aeEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"}},"required":["addr","aeGoodsNm","aeGoodsNo","aeNm","aeNo","loginId","mbrGbCdNm","mbrGradeCdNm","mbrJoinDtm","mbrNm","mbrNo","ordAccpDtm","ordCnt","ordNo","realAmt","tellNo","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":["프로모션 관리"],"summary":"사은품 지급 고객 정보 조회","description":"## 기능설명\n* 사은품을 선택한 주문 목록을 조회합니다.\n---\n## 상세설명\n* 사은품을 선택한 주문 중 검색조건에 맞는 주문 정보를 조회합니다. 검색조건은 아래와 같습니다.\n  * 사은행사 기간\n  * 사은행사 유형\n  * 사은행사 상태\n  * 등록자\n  * 사은행사 번호/명\n* Response 중 아래 내용들은 **마스킹**되어 노출되어집니다.\n  * 회원ID\n  * 회원명\n  * 휴대폰번호\n  * 주문배송지\n","operationId":"getAeOrderList","parameters":[{"name":"startDate","in":"query","description":"주문 접수 시작 일자","required":true,"schema":{"type":"string","format":"date","description":"주문 접수 시작 일자"}},{"name":"endDate","in":"query","description":"주문 접수 종료 일자","required":true,"schema":{"type":"string","format":"date","description":"주문 접수 종료 일자"}},{"name":"ordNo","in":"query","description":"주문번호","required":false,"schema":{"type":"string","description":"주문번호"}},{"name":"mbrNo","in":"query","description":"회원번호","required":false,"schema":{"type":"string","description":"회원번호"}},{"name":"aeNo","in":"query","description":"사은행사 번호","required":false,"schema":{"type":"string","description":"사은행사 번호"}},{"name":"aeNm","in":"query","description":"사은행사 명","required":false,"schema":{"type":"string","description":"사은행사 명"}},{"name":"goodsNo","in":"query","description":"사은품 번호","required":false,"schema":{"type":"string","description":"사은품 번호"}},{"name":"dateSelect","in":"query","description":"조회기간 선택","required":false,"schema":{"type":"string","description":"조회기간 선택"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseAppreciateOrderItem"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 할인/마일리지 상세 화면 호출

> \## 기능설명\
> \* 선택한 할인/마일리지의 상세 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 선택한 할인/마일리지의 상세 정보를 조회합니다.\
> \* 조회내용\
> &#x20; \* 기본정보\
> &#x20; \* 할인/마일리지 혜택\
> &#x20; \* 적용대상, 제외대상<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":"쿠폰 상세 정보 조회 Response","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoGbCd":{"type":"string","description":"쿠폰/프로모션 구분 코드","enum":["10","20"]},"comGbCd":{"type":"string","description":"회사구분 코드(ME038)"},"promoNm":{"type":"string","description":"쿠폰명"},"promoTypCd":{"type":"string","description":"쿠폰유형코드","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"쿠폰상태코드","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"},"ourChrgRate":{"type":"integer","format":"int32","description":"자사 분담률"},"entrChrgRate":{"type":"integer","format":"int32","description":"협력사 분담률"},"promoDesc":{"type":"string","description":"쿠폰 설명"},"possibleUpdateYn":{"type":"string","description":"수정가능여부"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"회원당 발급 횟수 제한 여부"},"idIssuQty":{"type":"integer","format":"int32","description":"회원당 발급 제한 횟수"},"totCpnIssuLmtYn":{"type":"string","description":"총 발급 횟수 제한 여부"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"총 발급 제한 횟수"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"적용가능매체코드"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"회원등급코드"}},"issuMethCd":{"type":"string","description":"발급방식코드","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"발급유형코드(MK008)"},"aplyTermGbCd":{"type":"string","description":"적용기간구분코드","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"발급일기준쿠폰사용일수"},"usePsbStrDt":{"type":"string","description":"사용가능시작일자"},"usePsbEndDt":{"type":"string","description":"사용가능종료일자"},"useWdayCd":{"type":"array","items":{"type":"string","description":"사용요일코드"}},"tmCpnYn":{"type":"string","description":"타임쿠폰여부"},"usePsbStrTm":{"type":"string","description":"타임쿠폰 시작시간"},"usePsbEndTm":{"type":"string","description":"타임쿠폰 종료시간"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구코드","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"할인율금액"},"minBuyQty":{"type":"integer","format":"int32","description":"최소구매수량"},"minBuyAmt":{"type":"number","description":"최소구매금액"},"maxDcAmt":{"type":"number","description":"최대할인금액"},"dcCpnCd":{"type":"string","description":"할인쿠폰코드"},"autoIssuPotmCd":{"type":"string","description":"자동발급시점코드","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"기념일선발행일수"},"cpbookDispYn":{"type":"string","description":"쿠폰북전시여부"},"dcCpbookCd":{"type":"string","description":"할인쿠폰북코드(MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"자동발급수량"},"aplySites":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 사이트"}},"aplyGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 상품"}},"aplyStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 표준카테고리"}},"aplyCategory":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 전시카테고리"}},"aplyBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 브랜드"}},"aplyEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 협력사"}},"aplyChannel":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 채널"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 기획전"}},"exceptGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 상품"}},"exceptStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 표준카테고리"}},"exceptBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 브랜드"}},"exceptEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 협력사"}}},"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":["프로모션 관리"],"summary":"할인/마일리지 상세 화면 호출","description":"## 기능설명\n* 선택한 할인/마일리지의 상세 정보를 조회합니다.\n---\n## 상세설명\n* 선택한 할인/마일리지의 상세 정보를 조회합니다.\n* 조회내용\n  * 기본정보\n  * 할인/마일리지 혜택\n  * 적용대상, 제외대상\n","operationId":"getPromotion","parameters":[{"name":"promoNo","in":"query","description":"프로모션번호","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PromotionDetailResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 마일리지 기준정보 조회

> \## 기능설명\
> \* 마일리지 기준정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 선택한 적립대상코드에 맞는 마일리지 기준정보를 조회합니다.\
> \---\
> \## 수정번호\
> \* Release v1.03\_231106: 마일리지 기준정보 최초 개발<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":" 마일리지기준정보순번"},"rsrvGbCd":{"type":"string","description":" 적립구분코드(CM016)"},"rsrvTgtCd":{"type":"string","description":" 적립대상코드(CM017)"},"milgTypNm":{"type":"string","description":" 마일리지유형명"},"baseRsrvRate":{"type":"number","format":"double","description":" 기본적립율"},"addRsrvAmt":{"type":"number","description":" 추가적립금액"},"mbrGradeCd":{"type":"string","description":" 회원등급코드(ME008)"},"rsrvStdAmt":{"type":"number","description":" 적립기준금액"},"rsrvStdDds":{"type":"integer","format":"int32","description":" 적립기준일수"},"valiTermDds":{"type":"integer","format":"int32","description":" 유효기간일수"},"mmMaxRsrvAmt":{"type":"number","description":" 월최대적립금액"},"yyMaxRsrvAmt":{"type":"number","description":" 년최대적립금액"},"chgCausDesc":{"type":"string","description":" 변경사유설명"},"rmkCont":{"type":"string","description":" 비고내용"}}},"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":["프로모션 관리"],"summary":"마일리지 기준정보 조회","description":"## 기능설명\n* 마일리지 기준정보를 조회합니다.\n---\n## 상세설명\n* 선택한 적립대상코드에 맞는 마일리지 기준정보를 조회합니다.\n---\n## 수정번호\n* Release v1.03_231106: 마일리지 기준정보 최초 개발\n","operationId":"getMilgStdDetail","parameters":[{"name":"rsrvTgtCd","in":"query","description":"적립대상코드(CM017)","required":true,"schema":{"type":"string","description":"적립대상코드(CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MilgStdResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 마일리지 기준정보 등록을 위한 기본 정보 조회

> \## 기능설명\
> \* 마일리지 기준정보 등록을 위한 기본 정보 조회합니다.\
> \---\
> \## 상세설명\
> \* 마일리지 기준 정보 등록 시 참고를 위한 데이터를 조회 합니다.\
> \* 조회하는 데이터의 우선 순위는 아래와 같습니다.\
> &#x20;   \* 적립 대상 코드\
> &#x20;   \* 적립 구분 코드(적립 구분코드, 적립 대상코드가 가장 큰 값)\
> \---\
> \## 수정번호\
> \* Release v1.03\_231106: 마일리지 기준정보 최초 개발<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":" 마일리지기준정보순번"},"rsrvGbCd":{"type":"string","description":" 적립구분코드(CM016)"},"rsrvTgtCd":{"type":"string","description":" 적립대상코드(CM017)"},"milgTypNm":{"type":"string","description":" 마일리지유형명"},"baseRsrvRate":{"type":"number","format":"double","description":" 기본적립율"},"addRsrvAmt":{"type":"number","description":" 추가적립금액"},"mbrGradeCd":{"type":"string","description":" 회원등급코드(ME008)"},"rsrvStdAmt":{"type":"number","description":" 적립기준금액"},"rsrvStdDds":{"type":"integer","format":"int32","description":" 적립기준일수"},"valiTermDds":{"type":"integer","format":"int32","description":" 유효기간일수"},"mmMaxRsrvAmt":{"type":"number","description":" 월최대적립금액"},"yyMaxRsrvAmt":{"type":"number","description":" 년최대적립금액"},"chgCausDesc":{"type":"string","description":" 변경사유설명"},"rmkCont":{"type":"string","description":" 비고내용"}}},"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":["프로모션 관리"],"summary":"마일리지 기준정보 등록을 위한 기본 정보 조회","description":"## 기능설명\n* 마일리지 기준정보 등록을 위한 기본 정보 조회합니다.\n---\n## 상세설명\n* 마일리지 기준 정보 등록 시 참고를 위한 데이터를 조회 합니다.\n* 조회하는 데이터의 우선 순위는 아래와 같습니다.\n    * 적립 대상 코드\n    * 적립 구분 코드(적립 구분코드, 적립 대상코드가 가장 큰 값)\n---\n## 수정번호\n* Release v1.03_231106: 마일리지 기준정보 최초 개발\n","operationId":"getSaveBasedMilgStdDetail","parameters":[{"name":"rsrvGbCd","in":"query","description":"적립구분코드(CM016)","required":true,"schema":{"type":"string","description":"적립구분코드(CM016)","enum":["100","110","120","130","200","210","220"]}},{"name":"rsrvTgtCd","in":"query","description":"적립대상코드(CM017)","required":true,"schema":{"type":"string","description":"적립대상코드(CM017)","enum":["101","111","112","113","114","115","121","131","201","202","203","211","221"]}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MilgStdResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰 상세 정보 조회

> \## 기능설명\
> \* 선택한 쿠폰의 상세 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 선택한 쿠폰의 상세 정보를 조회합니다.\
> \* 조회내용\
> &#x20; \* 기본정보\
> &#x20; \* 쿠폰혜택\
> &#x20; \* 적용대상\
> \## 수정번호\
> \* Release v2.00\_240509: 적용대상 - 기획전 정보 조회 추가<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":"쿠폰 상세 정보 조회 Response","properties":{"promoNo":{"type":"string","description":"쿠폰번호"},"promoGbCd":{"type":"string","description":"쿠폰/프로모션 구분 코드","enum":["10","20"]},"comGbCd":{"type":"string","description":"회사구분 코드(ME038)"},"promoNm":{"type":"string","description":"쿠폰명"},"promoTypCd":{"type":"string","description":"쿠폰유형코드","enum":["11","12","13","14","15","20","21","40"]},"promoStatCd":{"type":"string","description":"쿠폰상태코드","enum":["10","20"]},"promoStrDtm":{"type":"string","format":"date-time","description":"행사시작일시"},"promoEndDtm":{"type":"string","format":"date-time","description":"행사종료일시"},"ourChrgRate":{"type":"integer","format":"int32","description":"자사 분담률"},"entrChrgRate":{"type":"integer","format":"int32","description":"협력사 분담률"},"promoDesc":{"type":"string","description":"쿠폰 설명"},"possibleUpdateYn":{"type":"string","description":"수정가능여부"},"issuSubCd":{"type":"string","description":"쿠폰발급주체코드","enum":["01","02","03","04"]},"idIssuLmtYn":{"type":"string","description":"회원당 발급 횟수 제한 여부"},"idIssuQty":{"type":"integer","format":"int32","description":"회원당 발급 제한 횟수"},"totCpnIssuLmtYn":{"type":"string","description":"총 발급 횟수 제한 여부"},"totCpnIssuQty":{"type":"integer","format":"int32","description":"총 발급 제한 횟수"},"aplyPsbMediaCd":{"type":"array","items":{"type":"string","description":"적용가능매체코드"}},"mbrGradeCd":{"type":"array","items":{"type":"string","description":"회원등급코드"}},"issuMethCd":{"type":"string","description":"발급방식코드","enum":["01","02","03","04"]},"autoIssuTypCd":{"type":"string","description":"발급유형코드(MK008)"},"aplyTermGbCd":{"type":"string","description":"적용기간구분코드","enum":["01","02"]},"issuDdStdCpnUseDds":{"type":"integer","format":"int32","description":"발급일기준쿠폰사용일수"},"usePsbStrDt":{"type":"string","description":"사용가능시작일자"},"usePsbEndDt":{"type":"string","description":"사용가능종료일자"},"useWdayCd":{"type":"array","items":{"type":"string","description":"사용요일코드"}},"tmCpnYn":{"type":"string","description":"타임쿠폰여부"},"usePsbStrTm":{"type":"string","description":"타임쿠폰 시작시간"},"usePsbEndTm":{"type":"string","description":"타임쿠폰 종료시간"},"fixamtFxrtGbCd":{"type":"string","description":"정액정율구코드","enum":["01","02"]},"dcRateAmt":{"type":"number","description":"할인율금액"},"minBuyQty":{"type":"integer","format":"int32","description":"최소구매수량"},"minBuyAmt":{"type":"number","description":"최소구매금액"},"maxDcAmt":{"type":"number","description":"최대할인금액"},"dcCpnCd":{"type":"string","description":"할인쿠폰코드"},"autoIssuPotmCd":{"type":"string","description":"자동발급시점코드","enum":["01","02"]},"anvyPreIsuDds":{"type":"integer","format":"int32","description":"기념일선발행일수"},"cpbookDispYn":{"type":"string","description":"쿠폰북전시여부"},"dcCpbookCd":{"type":"string","description":"할인쿠폰북코드(MK010)"},"autoIssuQty":{"type":"integer","format":"int32","description":"자동발급수량"},"aplySites":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 사이트"}},"aplyGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 상품"}},"aplyStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 표준카테고리"}},"aplyCategory":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 전시카테고리"}},"aplyBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 브랜드"}},"aplyEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 협력사"}},"aplyChannel":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 채널"}},"aplyMarketingDisplay":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"적용 조건 - 기획전"}},"exceptGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 상품"}},"exceptStdGoods":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 표준카테고리"}},"exceptBrand":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 브랜드"}},"exceptEntr":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"},"description":"제외 조건 - 협력사"}}},"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":["프로모션 관리"],"summary":"쿠폰 상세 정보 조회","description":"## 기능설명\n* 선택한 쿠폰의 상세 정보를 조회합니다.\n---\n## 상세설명\n* 선택한 쿠폰의 상세 정보를 조회합니다.\n* 조회내용\n  * 기본정보\n  * 쿠폰혜택\n  * 적용대상\n## 수정번호\n* Release v2.00_240509: 적용대상 - 기획전 정보 조회 추가\n","operationId":"getCouponData","parameters":[{"name":"promoNo","in":"query","description":"쿠폰번호","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PromotionDetailResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 진행중 사은행사 개수 조회

> \## 기능설명\
> \* 해당 사은품이 행사조건에 포함된 진행중인 사은행사의 개수를 조회합니다.\
> \---\
> \## 상세설명\
> \* 해당 사은품이 행사조건에 포함된 진행중인 사은행사의 개수를 조회합니다.<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":["프로모션 관리"],"summary":"진행중 사은행사 개수 조회","description":"## 기능설명\n* 해당 사은품이 행사조건에 포함된 진행중인 사은행사의 개수를 조회합니다.\n---\n## 상세설명\n* 해당 사은품이 행사조건에 포함된 진행중인 사은행사의 개수를 조회합니다.\n","operationId":"getProgressAeEvtCount","parameters":[{"name":"goodsNo","in":"query","description":"사은품번호","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://tech.x2bee.com/api/back-office-api/marketing-bo-api/undefined-3.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.