> 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/system-bo-api/undefined-22.md).

# 주문클레임 대시보드

## 대시보드 고객 여정별 구매전환율 조회

>   \## 기능설명\
>   \* BO(MD) 대시보드의 고객 여정별 구매전환율 정보를 조회합니다.\
>   \---\
>   \## 상세설명\
>   \* 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\
>   \* 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\
>   \* 구매전환율은 방문수 대비 주문완료 비율입니다.\
>   \---\
>   \## 수정번호\
> &#x20; \* 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":{"VisitToOrderDashBoardRequest":{"type":"object","properties":{"statusPeriod":{"type":"string","description":"조회기간구분","minLength":1},"siteNo":{"type":"string","description":"사이트번호"}},"required":["statusPeriod"]},"VisitToOrderDashBoardResponse":{"type":"object","properties":{"main":{"type":"number","format":"double","description":"메인 방문수의 구매전환율"},"mainRate":{"type":"number","format":"double","description":"메인 방문수의 구매전환율 증가율"},"goodsDetail":{"type":"number","format":"double","description":"상품상세 방문수의 구매전환율"},"goodsDetailRate":{"type":"number","format":"double","description":"상품상세 방문수의 구매전환율 증가율"},"basket":{"type":"number","format":"double","description":"장바구니 방문수의 구매전환율"},"basketRate":{"type":"number","format":"double","description":"장바구니 방문수의 구매전환율 증가율"},"orderSheet":{"type":"number","format":"double","description":"주문서 방문수의 구매전환율"},"orderSheetRate":{"type":"number","format":"double","description":"주문서 방문수의 구매전환율 증가율"},"recentWeeklyList":{"type":"array","items":{"$ref":"#/components/schemas/VisitInfo"}}},"required":["basket","basketRate","goodsDetail","goodsDetailRate","main","mainRate","orderSheet","orderSheetRate"]},"VisitInfo":{"type":"object","properties":{"agrtDt":{"type":"string","description":"일자"},"visitMain":{"type":"integer","format":"int32","description":"메인 방문자수"},"visitGoodsDetail":{"type":"integer","format":"int32","description":"상품상세 방문자수"},"visitBasket":{"type":"integer","format":"int32","description":"장바구니 방문자수"},"visitOrderSheet":{"type":"integer","format":"int32","description":"주문서 방문자수"}},"required":["agrtDt","visitBasket","visitGoodsDetail","visitMain","visitOrderSheet"]},"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/dashboard/order/getVisitToOrderDashBoard":{"post":{"tags":["주문클레임 대시보드"],"summary":"대시보드 고객 여정별 구매전환율 조회","description":"  ## 기능설명\n  * BO(MD) 대시보드의 고객 여정별 구매전환율 정보를 조회합니다.\n  ---\n  ## 상세설명\n  * 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\n  * 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\n  * 구매전환율은 방문수 대비 주문완료 비율입니다.\n  ---\n  ## 수정번호\n  * Release v2.00_240827: 대시보드 고객 여정별 구매전환율 생성\n","operationId":"getVisitToOrderDashBoard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitToOrderDashBoardRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VisitToOrderDashBoardResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 대시보드 overview 조회

> &#x20; \## 기능설명\
> &#x20; \* BO 대시보드의 overview 정보를 조회합니다.\
> &#x20; \---\
> &#x20; \## 상세설명\
> &#x20; \* 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\
> &#x20; \* 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\
> &#x20; \* 구매고객수는 주문한 사용자의 수 입니다.(반품,취소는 카운트하지 않습니다.)\
> &#x20; \* 방문수는 FO에 방문한 수 입니다.\
> &#x20; \* 구매전환율은 방문수 대비 주문완료 비율입니다.\
> &#x20; \* 가입전환율은 FO에 방문한 방문객 대비 회원가입 비율입니다.\
> &#x20; \* 주문평균은 조회기간 동안 발생한 모든 고객 주문의 평균 금액입니다.\
> &#x20; \---\
> &#x20; \## 수정번호\
> &#x20; \* Release v2.00\_240827: 대시보드 overview 생성<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":{"OverviewDashBoardRequest":{"type":"object","properties":{"statusPeriod":{"type":"string","description":"조회기간구분","minLength":1},"siteNo":{"type":"string","description":"사이트번호"}},"required":["statusPeriod"]},"OverviewDashBoardResponse":{"type":"object","description":"대시보드 overview영역 조회 응답 DTO","properties":{"ordManCnt":{"type":"integer","format":"int32","description":"구매구객수"},"ordManCntRate":{"type":"number","format":"double","description":"전일대비 구매구객수 증가율"},"visitManCnt":{"type":"integer","format":"int32","description":"방문수"},"visitManCntRate":{"type":"number","format":"double","description":"전일대비 방문수 증가율"},"visitToOrder":{"type":"number","format":"double","description":"방문대비 구매전환율"},"visitToOrderRate":{"type":"number","format":"double","description":"전일대비 방문대비 구매전환율 증가율"},"visitToJoin":{"type":"number","format":"double","description":"방문대비 가입전환율"},"visitToJoinRate":{"type":"number","format":"double","description":"전일대비 가입전환율 증가율"},"orderAverage":{"type":"number","format":"double","description":"주문금액평균"},"orderAverageRate":{"type":"number","format":"double","description":"전일대비 주문금액평균 증가율"}},"required":["ordManCnt","ordManCntRate","orderAverage","orderAverageRate","visitManCnt","visitManCntRate","visitToJoin","visitToJoinRate","visitToOrder","visitToOrderRate"]},"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/dashboard/order/getOverviewDashBoard":{"post":{"tags":["주문클레임 대시보드"],"summary":"대시보드 overview 조회","description":"  ## 기능설명\n  * BO 대시보드의 overview 정보를 조회합니다.\n  ---\n  ## 상세설명\n  * 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\n  * 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\n  * 구매고객수는 주문한 사용자의 수 입니다.(반품,취소는 카운트하지 않습니다.)\n  * 방문수는 FO에 방문한 수 입니다.\n  * 구매전환율은 방문수 대비 주문완료 비율입니다.\n  * 가입전환율은 FO에 방문한 방문객 대비 회원가입 비율입니다.\n  * 주문평균은 조회기간 동안 발생한 모든 고객 주문의 평균 금액입니다.\n  ---\n  ## 수정번호\n  * Release v2.00_240827: 대시보드 overview 생성\n","operationId":"getOverviewDashBoard","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverviewDashBoardRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OverviewDashBoardResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 주문매출현황

> &#x20; \## 기능설명\
> &#x20; \* 주문매출현황 정보를 조회합니다.\
> &#x20; \---\
> &#x20; \## 상세설명\
> &#x20; \* \*\*집계구분코드(agrtGb)\*\*는 필수 파라미터 입니다.\
> &#x20; \* 요청 집계구분코드가 '01'일 경우, 주문 현황 정보를 제공합니다.\
> &#x20; \* 요청 집계구분코드가 '02'일 경우, 매출 현황 정보를 제공합니다.\
> &#x20; \* 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\
> &#x20; \* 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\
> &#x20; \* PO 진입 시 해당 협력사에 해당하는 정보만 제공합니다.\
> &#x20; \---\
> &#x20; \## 수정번호\
> &#x20; \* Release v2.00\_240827: 대시보드 전체 리뉴얼에 따른 수정\
> &#x20; \---\
> &#x20; \## 코드정리\
> &#x20; \* \`\`\`집계구분코드(agrtGb)\`\`\` : 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":{"OrderSalesDashBoardRequest":{"type":"object","properties":{"agrtGb":{"type":"string","description":"집계구분","minLength":1},"statusPeriod":{"type":"string","description":"조회기간구분","minLength":1},"entrNo":{"type":"string","description":"협력사번호"},"siteNo":{"type":"string","description":"사이트번호"}},"required":["agrtGb","statusPeriod"]},"OrderSalesDashBoardResponse":{"type":"object","properties":{"ordSaleAmt":{"type":"integer","format":"int64","description":"당일 주문/매출 금액"},"ordSaleAmtRate":{"type":"number","format":"double","description":"전일대비 주문/매출 증가율"},"ordSaleCnt":{"type":"integer","format":"int64","description":"당일 주문/매출 건수"},"ordSaleCntRate":{"type":"number","format":"double","description":"전일대비 주문/매출 건수 증가율"},"cnclRtnAmt":{"type":"number","description":"당일 취소/반품 금액"},"cnclRtnAmtRate":{"type":"number","format":"double","description":"전일대비 취소/반품 금액 증가율"},"cnclRtnCnt":{"type":"integer","format":"int64","description":"전일대비 취소/반품 건수"},"cnclRtnCntRate":{"type":"number","format":"double","description":"전일대비 취소/반품 건수 증가율"},"recentWeeklyList":{"type":"array","items":{"$ref":"#/components/schemas/OrderSalesInfo"}}},"required":["cnclRtnAmt","cnclRtnAmtRate","cnclRtnCnt","cnclRtnCntRate","ordSaleAmt","ordSaleAmtRate","ordSaleCnt","ordSaleCntRate"]},"OrderSalesInfo":{"type":"object","properties":{"agrtDt":{"type":"string","description":"일자"},"ordSaleAmt":{"type":"integer","format":"int64","description":"주문/매출 금액"},"cnclRtnAmt":{"type":"number","description":"취소/반품 금액"}},"required":["agrtDt","cnclRtnAmt","ordSaleAmt"]},"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/dashboard/order/getOrderSalesDashBoard":{"post":{"tags":["주문클레임 대시보드"],"summary":"주문매출현황","description":"  ## 기능설명\n  * 주문매출현황 정보를 조회합니다.\n  ---\n  ## 상세설명\n  * **집계구분코드(agrtGb)**는 필수 파라미터 입니다.\n  * 요청 집계구분코드가 '01'일 경우, 주문 현황 정보를 제공합니다.\n  * 요청 집계구분코드가 '02'일 경우, 매출 현황 정보를 제공합니다.\n  * 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\n  * 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\n  * PO 진입 시 해당 협력사에 해당하는 정보만 제공합니다.\n  ---\n  ## 수정번호\n  * Release v2.00_240827: 대시보드 전체 리뉴얼에 따른 수정\n  ---\n  ## 코드정리\n  * ```집계구분코드(agrtGb)``` : 01 : 주문현황집계코드, 02 : 매출현황집계코드\n","operationId":"getOrderSalesDashBoardResponse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSalesDashBoardRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderSalesDashBoardResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## 주문/클레임현황

> &#x20; \## 기능 설명\
> &#x20; \* PO에서 주문현황/클레임현황 정보를 제공합니다.\
> &#x20; \---\
> &#x20; \## 상세 설명\
> &#x20; \* \*\*주문/클레임구분(ordCntGb)\*\*, \*\*협력사명(entrNo)\*\*은 필수 파라미터 입니다.\
> &#x20; \* \*\*주문/클레임구분(ordCntGb)\*\*이 \*\*주문(O)\*\* 일경우 다음의 \*\*주문내역상태코드(OM005)\*\*의 건 수를 노출한다.\
> &#x20;     \* \*\*주문완료(12)\*\*, \*\*배송지시(21)\*\*, \*\*출고지시(22)\*\*, \*\*출고대기(23)\*\*, \*\*출고완료(26)\*\*\
> &#x20; \* \*\*주문/클레임구분(ordCntGb)\*\*이 \*\*클레임(C)\*\* 일경우 다음의 \*\*주문내역상태코드(OM005)\*\*의 건 수를 노출한다.\
> &#x20;     \* \*\*클레임접수(32)\*\*, \*\*회수지시(34)\*\*, \*\*회수확인(35)\*\*\
> &#x20; \---\
> &#x20; \## 특이 사항\
> &#x20; \* \*\*주문/클레임구분(ordCntGb)\*\*이 \*\*주문(O)\*\*이거나 \*\*클레임(C)\*\*일 경우에만 해당 현황정보를 조회합니다.<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":{"OrderClaimDashBoardRequest":{"type":"object","description":"주문현황/클레임현황 요청 DTO","properties":{"ordCntGb":{"type":"string","description":"주문/클레임구분","minLength":1},"entrNo":{"type":"string","description":"협력사번호"}},"required":["entrNo","ordCntGb"]},"OrderClaimDashBoardResponse":{"type":"object","description":"주문현황/클레임현황 응답 DTO","properties":{"ordDtlStatNm":{"type":"string","description":"주문클레임상태명"},"ordDtlStatCd":{"type":"string","description":"주문클레임상태코드"},"cnt":{"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/dashboard/order/getDashBoardOrderClaimCount":{"post":{"tags":["주문클레임 대시보드"],"summary":"주문/클레임현황","description":"  ## 기능 설명\n  * PO에서 주문현황/클레임현황 정보를 제공합니다.\n  ---\n  ## 상세 설명\n  * **주문/클레임구분(ordCntGb)**, **협력사명(entrNo)**은 필수 파라미터 입니다.\n  * **주문/클레임구분(ordCntGb)**이 **주문(O)** 일경우 다음의 **주문내역상태코드(OM005)**의 건 수를 노출한다.\n      * **주문완료(12)**, **배송지시(21)**, **출고지시(22)**, **출고대기(23)**, **출고완료(26)**\n  * **주문/클레임구분(ordCntGb)**이 **클레임(C)** 일경우 다음의 **주문내역상태코드(OM005)**의 건 수를 노출한다.\n      * **클레임접수(32)**, **회수지시(34)**, **회수확인(35)**\n  ---\n  ## 특이 사항\n  * **주문/클레임구분(ordCntGb)**이 **주문(O)**이거나 **클레임(C)**일 경우에만 해당 현황정보를 조회합니다.\n","operationId":"getDashBoardOrderClaimCount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderClaimDashBoardRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimDashBoardResponse"}}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```