> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/back-office-api/statistics-bo-api/undefined-6.md).

# 쿠폰별 매출/주문 현황

## 쿠폰별 주문/매출 현황 목록 조회

> \## 기능설명\
> \* 쿠폰별 주문/매출 현황 목록 조회하는 기능 입니다.\
> \---\
> \## 상세설명\
> \* \[BO] 통계 > 마케팅분석 > 쿠폰별 주문/매출 현황 페이지에서 조회 버튼 클릭시 호출됩니다.\
> \* \*\*집계구분코드, 조회기간(시작일자, 종료일자)\*\*는 필수 조회 조건입니다.\
> \* - 집계구분코드 01: 주문, 02: 매출\
> \* \*\*사이트번호, 쿠폰번호, 협력사번호\*\*는 선택 조회 조건입니다.\
> \---<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":{"CouponStatusRequest":{"type":"object","description":"브랜드별 매출/주문 현황 DTO","properties":{"startDate":{"type":"string","format":"date","description":"조회기간(시작일)"},"endDate":{"type":"string","format":"date","description":"조회기간(종료일)"},"cpnNo":{"type":"string","description":"쿠폰번호"},"entrNo":{"type":"string","description":"협력사번호"},"agrtGb":{"type":"string","description":"집계구분"}}},"RealGridListResponseCouponStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CouponStatusResponse"}}}},"CouponStatusResponse":{"type":"object","description":"쿠폰별 주문/매출 현황 DTO","properties":{"cpnNo":{"type":"string","description":"쿠폰번호"},"cpnNm":{"type":"string","description":"쿠폰명"},"agrtGb":{"type":"string","description":"집계구분"},"issuCnt":{"type":"string","description":"발급건수"},"useCnt":{"type":"string","description":"적용건수"},"purchaseRate":{"type":"number","format":"float","description":"구매전환율"},"entrNm":{"type":"string","description":"협력사명"},"siteNm":{"type":"string","description":"사이트"},"ordAmt":{"type":"number","description":"주문금액"},"cnclAmt":{"type":"number","description":"취소금액"},"netOrdAmt":{"type":"integer","format":"int64","description":"순주문 금액"},"ordQty":{"type":"integer","format":"int32","description":"주문수량"},"cnclQty":{"type":"integer","format":"int32","description":"취소수량"},"netOrdQty":{"type":"integer","format":"int32","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/statistics/couponStatus/getCouponStatusList":{"get":{"tags":["쿠폰별 매출/주문 현황"],"summary":"쿠폰별 주문/매출 현황 목록 조회","description":"## 기능설명\n* 쿠폰별 주문/매출 현황 목록 조회하는 기능 입니다.\n---\n## 상세설명\n* [BO] 통계 > 마케팅분석 > 쿠폰별 주문/매출 현황 페이지에서 조회 버튼 클릭시 호출됩니다.\n* **집계구분코드, 조회기간(시작일자, 종료일자)**는 필수 조회 조건입니다.\n* - 집계구분코드 01: 주문, 02: 매출\n* **사이트번호, 쿠폰번호, 협력사번호**는 선택 조회 조건입니다.\n---\n","operationId":"getCouponStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CouponStatusRequest"}},{"name":"startDate","in":"query","description":"조회 시작일","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"조회 종료일","required":true,"schema":{"type":"LocalDate"}},{"name":"siteNo","in":"query","description":"사이트번호","schema":{"type":"String"}},{"name":"cpnNo","in":"query","description":"쿠폰번호","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"협력사번호","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"집계구분","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"브랜드별 매출/주문 현황 목록 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCouponStatusResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 쿠폰별 주문/매출 현황 엑셀 일괄 다운로드

> \## 기능설명\
> \* 쿠폰별 주문/매출 현황 목록을 엑셀파일로 생성하여 다운로드 합니다.\
> \---\
> \## 상세설명\
> \* 노출 항목은 그리드 목록과 동일 합니다.\
> \* 페이징 처리 없이, 검색 조건에 해당하는 모든 데이터를 조회합니다.\
> \---\
> \## 수정 번호\
> \* Release v2.00\_240827 : 최초 생성<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":{"CouponStatusRequest":{"type":"object","description":"브랜드별 매출/주문 현황 DTO","properties":{"startDate":{"type":"string","format":"date","description":"조회기간(시작일)"},"endDate":{"type":"string","format":"date","description":"조회기간(종료일)"},"cpnNo":{"type":"string","description":"쿠폰번호"},"entrNo":{"type":"string","description":"협력사번호"},"agrtGb":{"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/statistics/couponStatus/downloadCouponStatusExcel":{"get":{"tags":["쿠폰별 매출/주문 현황"],"summary":"쿠폰별 주문/매출 현황 엑셀 일괄 다운로드","description":"## 기능설명\n* 쿠폰별 주문/매출 현황 목록을 엑셀파일로 생성하여 다운로드 합니다.\n---\n## 상세설명\n* 노출 항목은 그리드 목록과 동일 합니다.\n* 페이징 처리 없이, 검색 조건에 해당하는 모든 데이터를 조회합니다.\n---\n## 수정 번호\n* Release v2.00_240827 : 최초 생성\n","operationId":"downloadCouponStatusExcel","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CouponStatusRequest"}},{"name":"startDate","in":"query","description":"조회 시작일","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"조회 종료일","required":true,"schema":{"type":"LocalDate"}},{"name":"siteNo","in":"query","description":"사이트번호","schema":{"type":"String"}},{"name":"cpnNo","in":"query","description":"쿠폰번호","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"협력사번호","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"집계구분","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"엑셀 다운로드 성공"},"900":{"description":"엑셀 다운로드 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```