# 주문클레임 대시보드 ## 대시보드 고객 여정별 구매전환율 조회 > \## 기능설명\ > \* BO(MD) 대시보드의 고객 여정별 구매전환율 정보를 조회합니다.\ > \---\ > \## 상세설명\ > \* 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\ > \* 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\ > \* 구매전환율은 방문수 대비 주문완료 비율입니다.\ > \---\ > \## 수정번호\ > \* Release v2.00\_240827: 대시보드 고객 여정별 구매전환율 생성
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/dashboard/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","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"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"}}}}}}}},"components":{"schemas":{"VisitToOrderDashBoardRequest":{"required":["statusPeriod"],"type":"object","properties":{"statusPeriod":{"type":"string","description":"조회기간구분"},"siteNo":{"type":"string","description":"사이트번호"}},"description":"대시보드 고객 여정별 구매전환율 영역 조회 요청 DTO"},"VisitToOrderDashBoardResponse":{"required":["basket","basketRate","goodsDetail","goodsDetailRate","main","mainRate","orderSheet","orderSheetRate"],"type":"object","properties":{"main":{"type":"number","description":"메인 방문수의 구매전환율","format":"double"},"mainRate":{"type":"number","description":"메인 방문수의 구매전환율 증가율","format":"double"},"goodsDetail":{"type":"number","description":"상품상세 방문수의 구매전환율","format":"double"},"goodsDetailRate":{"type":"number","description":"상품상세 방문수의 구매전환율 증가율","format":"double"},"basket":{"type":"number","description":"장바구니 방문수의 구매전환율","format":"double"},"basketRate":{"type":"number","description":"장바구니 방문수의 구매전환율 증가율","format":"double"},"orderSheet":{"type":"number","description":"주문서 방문수의 구매전환율","format":"double"},"orderSheetRate":{"type":"number","description":"주문서 방문수의 구매전환율 증가율","format":"double"},"recentWeeklyList":{"type":"array","items":{"$ref":"#/components/schemas/VisitInfo"}}},"description":"대시보드 고객 여정별 구매전환율 영역 조회 응답 DTO"},"VisitInfo":{"required":["agrtDt","visitBasket","visitGoodsDetail","visitMain","visitOrderSheet"],"type":"object","properties":{"agrtDt":{"type":"string","description":"일자"},"visitMain":{"type":"integer","description":"메인 방문자수","format":"int32"},"visitGoodsDetail":{"type":"integer","description":"상품상세 방문자수","format":"int32"},"visitBasket":{"type":"integer","description":"장바구니 방문자수","format":"int32"},"visitOrderSheet":{"type":"integer","description":"주문서 방문자수","format":"int32"}},"description":"방문자수 현황"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}} ``` ## 대시보드 overview 조회 > \## 기능설명\ > \* BO 대시보드의 overview 정보를 조회합니다.\ > \---\ > \## 상세설명\ > \* 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\ > \* 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\ > \* 구매고객수는 주문한 사용자의 수 입니다.(반품,취소는 카운트하지 않습니다.)\ > \* 방문수는 FO에 방문한 방문자수 입니다.\ > \* 구매전환율은 방문수 대비 주문완료 비율입니다.\ > \* 가입전환율은 방문수 대비 회원가입 비율입니다.\ > \* 주문평균은 조회기간 동안 발생한 모든 고객 주문의 평균 금액입니다.\ > \---\ > \## 수정번호\ > \* Release v2.00\_240827: 대시보드 overview 생성
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/dashboard/getOverviewDashBoard":{"post":{"tags":["주문클레임 대시보드"],"summary":"대시보드 overview 조회","description":" ## 기능설명\n * BO 대시보드의 overview 정보를 조회합니다.\n ---\n ## 상세설명\n * 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\n * 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\n * 구매고객수는 주문한 사용자의 수 입니다.(반품,취소는 카운트하지 않습니다.)\n * 방문수는 FO에 방문한 방문자수 입니다.\n * 구매전환율은 방문수 대비 주문완료 비율입니다.\n * 가입전환율은 방문수 대비 회원가입 비율입니다.\n * 주문평균은 조회기간 동안 발생한 모든 고객 주문의 평균 금액입니다.\n ---\n ## 수정번호\n * Release v2.00_240827: 대시보드 overview 생성\n","operationId":"getOverviewDashBoard","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"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"}}}}}}}},"components":{"schemas":{"OverviewDashBoardRequest":{"required":["statusPeriod"],"type":"object","properties":{"statusPeriod":{"type":"string","description":"조회기간구분"},"siteNo":{"type":"string","description":"사이트번호"}},"description":"대시보드 overview영역 조회 요청 DTO"},"OverviewDashBoardResponse":{"required":["ordManCnt","ordManCntRate","orderAverage","orderAverageRate","visitManCnt","visitManCntRate","visitToJoin","visitToJoinRate","visitToOrder","visitToOrderRate"],"type":"object","properties":{"ordManCnt":{"type":"integer","description":"구매구객수","format":"int32"},"ordManCntRate":{"type":"number","description":"전일대비 구매구객수 증가율","format":"double"},"visitManCnt":{"type":"integer","description":"방문수","format":"int32"},"visitManCntRate":{"type":"number","description":"전일대비 방문수 증가율","format":"double"},"visitToOrder":{"type":"number","description":"방문대비 구매전환율","format":"double"},"visitToOrderRate":{"type":"number","description":"전일대비 방문대비 구매전환율 증가율","format":"double"},"visitToJoin":{"type":"number","description":"방문대비 가입전환율","format":"double"},"visitToJoinRate":{"type":"number","description":"전일대비 가입전환율 증가율","format":"double"},"orderAverage":{"type":"number","description":"주문금액평균","format":"double"},"orderAverageRate":{"type":"number","description":"전일대비 주문금액평균 증가율","format":"double"}},"description":"대시보드 overview영역 조회 응답 DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}} ``` ## 주문매출현황 > \## 기능설명\ > \* 주문매출현황 정보를 조회합니다.\ > \---\ > \## 상세설명\ > \* \*\*집계구분코드(agrtGb)\*\*는 필수 파라미터 입니다.\ > \* 요청 집계구분코드가 '01'일 경우, 주문 현황 정보를 제공합니다.\ > \* 요청 집계구분코드가 '02'일 경우, 매출 현황 정보를 제공합니다.\ > \* 당일 기준 / 최근 7일 / 최근 30일 간 주문 매출 현황 정보를 제공합니다.\ > \* 사이트 파라미터가 전체가 아닌 경우 해당 사이트에 해당하는 정보만 제공합니다.\ > \* PO 진입 시 해당 협력사에 해당하는 정보만 제공합니다.\ > \---\ > \## 수정번호\ > \* Release v2.00\_240711: 주문/취소금액을 표시할 때 기본 주문/취소금액에 건수를 곱하지 않도록 수정\ > \* Release v2.00\_240827: 대시보드 전체 리뉴얼에 따른 수정\ > \---\ > \## 코드정리\ > \* \`\`\`집계구분코드(agrtGb)\`\`\` : 01 : 주문현황집계코드, 02 : 매출현황집계코드
````json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/dashboard/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_240711: 주문/취소금액을 표시할 때 기본 주문/취소금액에 건수를 곱하지 않도록 수정\n * Release v2.00_240827: 대시보드 전체 리뉴얼에 따른 수정\n ---\n ## 코드정리\n * ```집계구분코드(agrtGb)``` : 01 : 주문현황집계코드, 02 : 매출현황집계코드\n","operationId":"getOrderSalesDashBoard","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"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"}}}}}}}},"components":{"schemas":{"OrderSalesDashBoardRequest":{"required":["agrtGb","statusPeriod"],"type":"object","properties":{"agrtGb":{"type":"string","description":"집계구분"},"statusPeriod":{"type":"string","description":"조회기간구분"},"entrNo":{"type":"string","description":"협력사번호"},"siteNo":{"type":"string","description":"사이트번호"}},"description":"주문매출현황 조회 요청 DTO"},"OrderSalesDashBoardResponse":{"required":["cnclRtnAmt","cnclRtnAmtRate","cnclRtnCnt","cnclRtnCntRate","ordSaleAmt","ordSaleAmtRate","ordSaleCnt","ordSaleCntRate"],"type":"object","properties":{"ordSaleAmt":{"type":"integer","description":"당일 주문/매출 금액","format":"int64"},"ordSaleAmtRate":{"type":"number","description":"전일대비 주문/매출 증가율","format":"double"},"ordSaleCnt":{"type":"integer","description":"당일 주문/매출 건수","format":"int64"},"ordSaleCntRate":{"type":"number","description":"전일대비 주문/매출 건수 증가율","format":"double"},"cnclRtnAmt":{"type":"integer","description":"당일 취소/반품 금액","format":"int64"},"cnclRtnAmtRate":{"type":"number","description":"전일대비 취소/반품 금액 증가율","format":"double"},"cnclRtnCnt":{"type":"integer","description":"전일대비 취소/반품 건수","format":"int64"},"cnclRtnCntRate":{"type":"number","description":"전일대비 취소/반품 건수 증가율","format":"double"},"recentWeeklyList":{"type":"array","items":{"$ref":"#/components/schemas/OrderSalesInfo"}}},"description":"주문매출현황 조회 응답 DTO"},"OrderSalesInfo":{"required":["agrtDt","cnclRtnAmt","ordSaleAmt"],"type":"object","properties":{"agrtDt":{"type":"string","description":"일자"},"ordSaleAmt":{"type":"integer","description":"주문/매출 금액","format":"int64"},"cnclRtnAmt":{"type":"integer","description":"취소/반품 금액","format":"int64"}},"description":"최근 7일간 주문/매출, 취소/반품 금액 현황"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}} ```` ## 주문/클레임현황 > \## 기능 설명\ > \* PO에서 주문현황/클레임현황 정보를 제공합니다.\ > \---\ > \## 상세 설명\ > \* \*\*주문/클레임구분(ordCntGb)\*\*, \*\*협력사명(entrNo)\*\*은 필수 파라미터 입니다.\ > \* \*\*주문/클레임구분(ordCntGb)\*\*이 \*\*주문(O)\*\* 일경우 다음의 \*\*주문내역상태코드(OM005)\*\*의 건 수를 노출한다.\ > \* \*\*주문완료(12)\*\*, \*\*배송지시(21)\*\*, \*\*출고지시(22)\*\*, \*\*출고대기(23)\*\*, \*\*출고완료(26)\*\*\ > \* \*\*주문/클레임구분(ordCntGb)\*\*이 \*\*클레임(C)\*\* 일경우 다음의 \*\*주문내역상태코드(OM005)\*\*의 건 수를 노출한다.\ > \* \*\*클레임접수(32)\*\*, \*\*회수지시(34)\*\*, \*\*회수확인(35)\*\*\ > \---\ > \## 특이 사항\ > \* \*\*주문/클레임구분(ordCntGb)\*\*이 \*\*주문(O)\*\*이거나 \*\*클레임(C)\*\*일 경우에만 해당 현황정보를 조회합니다.\ > \---\ > \## 수정 번호\ > \* Release v2.00\_240827 : 주문접수일시 최근 30일 기준 조건 추가
```json {"openapi":"3.0.1","info":{"title":"X2BEE Order API","version":"v1"},"servers":[{"url":"https://api-order.x2bee.com/api/order/","description":"prd"}],"paths":{"/v1/dashboard/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 ---\n ## 수정 번호\n * Release v2.00_240827 : 주문접수일시 최근 30일 기준 조건 추가\n","operationId":"getDashBoardOrderClaimCount","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"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"}}}}}}}},"components":{"schemas":{"OrderClaimDashBoardRequest":{"required":["ordCntGb"],"type":"object","properties":{"ordCntGb":{"type":"string","description":"주문/클레임구분 O:주문, C:클레임","default":"O"},"entrNo":{"type":"string","description":"협력사번호"}},"description":"주문현황/클레임현황 요청 DTO"},"OrderClaimDashBoardResponse":{"type":"object","properties":{"ordDtlStatNm":{"type":"string","description":"주문클레임상태명"},"ordDtlStatCd":{"type":"string","description":"OM005(주문내역상태코드)\n 10: REPAY_REQ(재결제요청)\n,11: ORDER_ACCEPT(주문접수)\n,12: ORDER_COMPLETE(주문완료)\n,13: ORDER_CANCEL(주문취소)\n,21: DELIVERY_ORDER(배송지시)\n,22: SHIPPING_ORDER(출고지시)\n,23: SHIPPING_WAIT(출고대기)\n,25: SHIPPING_CONFIRM(출고확정)\n,26: SHIPPING_FINISH(출고완료)\n,27: DELIVERY_FINISH(배송완료)\n,31: RETURN_APPLY(결제대기)\n,32: RETURN_ACCEPT(반품접수)\n,33: RETURN_CANCEL(반품취소)\n,34: WITHDRAWAL_ORDER(회수지시)\n,35: WITHDRAWAL_CONFIRM(회수확인)\n,36: WITHDRAWAL_FINISH(회수완료)\n,37: RETURN_FINISH(반품완료)\n","enum":["REPAY_REQ","ORDER_ACCEPT","ORDER_COMPLETE","ORDER_CANCEL","DELIVERY_ORDER","SHIPPING_ORDER","SHIPPING_WAIT","SHIPPING_CONFIRM","SHIPPING_FINISH","DELIVERY_FINISH","PARTIAL_SHIPPING","RETURN_APPLY","RETURN_ACCEPT","RETURN_CANCEL","WITHDRAWAL_ORDER","WITHDRAWAL_CONFIRM","WITHDRAWAL_FINISH","RETURN_FINISH"]},"cnt":{"type":"integer","description":"주문클레임상태별 수량","format":"int32"}},"description":"주문현황/클레임현황 응답 DTO"},"Response":{"type":"object","properties":{"timestamp":{"type":"string","description":"result time","format":"date-time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"object","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"}},"description":"validation error list"}}}} ``` --- # 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/store-front-api/order-api/undefined-20.md?ask= ``` 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.