> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/dashboard-orders-sales-claims.md). # Dashboard Orders, Sales, Claims ## Order/Claim Status > \## Function Description\ > \* Provides order status/claim status information in the PO.\ > \---\ > \## Detailed Description\ > \* \*\*Order/Claim type (ordCntGb)\*\* and \*\*Vendor Name (entrNo)\*\* are required parameters.\ > \* When \*\*Order/Claim type (ordCntGb)\*\* is \*\*Order (O)\*\*, the count of the following \*\*Order status code (OM005)\*\* values is displayed.\ > \* \*\*Order Complete (12)\*\*, \*\*Delivery Instruction (21)\*\*, \*\*Shipment Instruction (22)\*\*, \*\*Awaiting Shipment (23)\*\*, \*\*Shipment Complete (26)\*\*\ > \* When \*\*Order/Claim type (ordCntGb)\*\* is \*\*Claim (C)\*\*, the count of the following \*\*Order status code (OM005)\*\* values is displayed.\ > \* \*\*Claim Received (32)\*\*, \*\*Collection Instruction (34)\*\*, \*\*Collection Confirmed (35)\*\*\ > \---\ > \## Notes\ > \* The corresponding status information is retrieved only when \*\*Order/Claim type (ordCntGb)\*\* is \*\*Order (O)\*\* or \*\*Claim (C)\*\*.
```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":"Order Status/Claim Status Request DTO","properties":{"ordCntGb":{"type":"string","description":"Order/Claim Type","minLength":1},"entrNo":{"type":"string","description":"Vendor No."}},"required":["entrNo","ordCntGb"]},"OrderClaimDashBoardResponse":{"type":"object","description":"Order Status/Claim Status Response DTO","properties":{"ordDtlStatNm":{"type":"string","description":"Order Claim Status Name"},"ordDtlStatCd":{"type":"string","description":"Order Claim Status Code"},"cnt":{"type":"integer","format":"int32","description":"Quantity by Order Claim Status"}}},"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/dashboard/order/payment-return-status":{"get":{"tags":["Dashboard - Orders, Sales, Claims"],"summary":"Order/Claim Status","description":" ## Function Description\n * Provides order status/claim status information in the PO.\n ---\n ## Detailed Description\n * **Order/Claim type (ordCntGb)** and **Vendor Name (entrNo)** are required parameters.\n * When **Order/Claim type (ordCntGb)** is **Order (O)**, the count of the following **Order status code (OM005)** values is displayed.\n * **Order Complete (12)**, **Delivery Instruction (21)**, **Shipment Instruction (22)**, **Awaiting Shipment (23)**, **Shipment Complete (26)**\n * When **Order/Claim type (ordCntGb)** is **Claim (C)**, the count of the following **Order status code (OM005)** values is displayed.\n * **Claim Received (32)**, **Collection Instruction (34)**, **Collection Confirmed (35)**\n ---\n ## Notes\n * The corresponding status information is retrieved only when **Order/Claim type (ordCntGb)** is **Order (O)** or **Claim (C)**.\n","operationId":"getDashBoardOrderClaimCount_1","parameters":[{"name":"orderClaimDashBoardRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderClaimDashBoardRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimDashBoardResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Dashboard Overview > \## Function Description\ > \* Retrieves the overview information of the BO dashboard.\ > \---\ > \## Detailed Description\ > \* Provides order/sales status information for today / the last 7 days / the last 30 days.\ > \* If the site parameter is not 'All', provides only the information for that site.\ > \* The number of purchasing customers is the number of users who placed orders (returns and cancellations are not counted).\ > \* The number of visits is the number of visits to the FO.\ > \* The purchase conversion rate is the ratio of completed orders to visits.\ > \* The registration conversion rate is the ratio of member registrations to visitors who visited the FO.\ > \* The average order is the average amount of all customer orders that occurred during the search period.\ > \---\ > \## Revision History\ > \* Release v2.00\_240827: Created dashboard overview
```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":"Search Period Type","minLength":1},"siteNo":{"type":"string","description":"Site No."}},"required":["statusPeriod"]},"OverviewDashBoardResponse":{"type":"object","description":"Dashboard Overview Section Retrieval Response DTO","properties":{"ordManCnt":{"type":"integer","format":"int32","description":"Number of Purchasing Customers"},"ordManCntRate":{"type":"number","format":"double","description":"Increase Rate of Purchasing Customers vs. Previous Day"},"visitManCnt":{"type":"integer","format":"int32","description":"Number of Visits"},"visitManCntRate":{"type":"number","format":"double","description":"Increase Rate of Visits vs. Previous Day"},"visitToOrder":{"type":"number","format":"double","description":"Purchase Conversion Rate per Visit"},"visitToOrderRate":{"type":"number","format":"double","description":"Increase Rate of Purchase Conversion Rate per Visit vs. Previous Day"},"visitToJoin":{"type":"number","format":"double","description":"Registration Conversion Rate per Visit"},"visitToJoinRate":{"type":"number","format":"double","description":"Increase Rate of Registration Conversion Rate vs. Previous Day"},"orderAverage":{"type":"number","format":"double","description":"Average Order Amount"},"orderAverageRate":{"type":"number","format":"double","description":"Increase Rate of Average Order Amount vs. Previous Day"}},"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":{"/v2/dashboard/order/overview":{"get":{"tags":["Dashboard - Orders, Sales, Claims"],"summary":"Retrieve Dashboard Overview","description":" ## Function Description\n * Retrieves the overview information of the BO dashboard.\n ---\n ## Detailed Description\n * Provides order/sales status information for today / the last 7 days / the last 30 days.\n * If the site parameter is not 'All', provides only the information for that site.\n * The number of purchasing customers is the number of users who placed orders (returns and cancellations are not counted).\n * The number of visits is the number of visits to the FO.\n * The purchase conversion rate is the ratio of completed orders to visits.\n * The registration conversion rate is the ratio of member registrations to visitors who visited the FO.\n * The average order is the average amount of all customer orders that occurred during the search period.\n ---\n ## Revision History\n * Release v2.00_240827: Created dashboard overview\n","operationId":"getOverviewDashBoard_1","parameters":[{"name":"overviewDashBoardRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OverviewDashBoardRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OverviewDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order Sales Status > \## Function Description\ > \* Retrieves order/sales status information.\ > \---\ > \## Detailed Description\ > \* \*\*Aggregation type code (agrtGb)\*\* is a required parameter.\ > \* If the requested aggregation type code is '01', provides order status information.\ > \* If the requested aggregation type code is '02', provides sales status information.\ > \* Provides order/sales status information for today / the last 7 days / the last 30 days.\ > \* If the site parameter is not 'All', provides only the information for that site.\ > \* When accessed via PO, provides only the information for the corresponding vendor.\ > \---\ > \## Revision History\ > \* Release v2.00\_240827: Modified for full dashboard renewal\ > \---\ > \## Code Reference\ > \* \`\`\`Aggregation type code (agrtGb)\`\`\` : 01 : Order status aggregation code, 02 : Sales status aggregation code
````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":"Aggregation Type","minLength":1},"statusPeriod":{"type":"string","description":"Search Period Type","minLength":1},"entrNo":{"type":"string","description":"Vendor No."},"siteNo":{"type":"string","description":"Site No."}},"required":["agrtGb","statusPeriod"]},"OrderSalesDashBoardResponse":{"type":"object","properties":{"ordSaleAmt":{"type":"integer","format":"int64","description":"Today's Order/Sales Amount"},"ordSaleAmtRate":{"type":"number","format":"double","description":"Increase Rate of Order/Sales vs. Previous Day"},"ordSaleCnt":{"type":"integer","format":"int64","description":"Today's Order/Sales Count"},"ordSaleCntRate":{"type":"number","format":"double","description":"Increase Rate of Order/Sales Count vs. Previous Day"},"cnclRtnAmt":{"type":"number","description":"Today's Cancellation/Return Amount"},"cnclRtnAmtRate":{"type":"number","format":"double","description":"Increase Rate of Cancellation/Return Amount vs. Previous Day"},"cnclRtnCnt":{"type":"integer","format":"int64","description":"Cancellation/Return Count vs. Previous Day"},"cnclRtnCntRate":{"type":"number","format":"double","description":"Increase Rate of Cancellation/Return Count vs. Previous Day"},"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":"Date"},"ordSaleAmt":{"type":"integer","format":"int64","description":"Order/Sales Amount"},"cnclRtnAmt":{"type":"number","description":"Cancellation/Return Amount"}},"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":{"/v2/dashboard/order/order-sales-status":{"get":{"tags":["Dashboard - Orders, Sales, Claims"],"summary":"Order Sales Status","description":" ## Function Description\n * Retrieves order/sales status information.\n ---\n ## Detailed Description\n * **Aggregation type code (agrtGb)** is a required parameter.\n * If the requested aggregation type code is '01', provides order status information.\n * If the requested aggregation type code is '02', provides sales status information.\n * Provides order/sales status information for today / the last 7 days / the last 30 days.\n * If the site parameter is not 'All', provides only the information for that site.\n * When accessed via PO, provides only the information for the corresponding vendor.\n ---\n ## Revision History\n * Release v2.00_240827: Modified for full dashboard renewal\n ---\n ## Code Reference\n * ```Aggregation type code (agrtGb)``` : 01 : Order status aggregation code, 02 : Sales status aggregation code\n","operationId":"getOrderSalesDashBoardResponse_1","parameters":[{"name":"orderSalesDashBoardRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderSalesDashBoardRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderSalesDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ```` ## Retrieve Purchase Conversion Rate by Customer Journey (Dashboard) > \## Function Description\ > \* Retrieves purchase conversion rate information by customer journey for the BO(MD) dashboard.\ > \---\ > \## Detailed Description\ > \* Provides order sales status information based on the current day / last 7 days / last 30 days.\ > \* If the site parameter is not set to "All", only information for the corresponding site is provided.\ > \* The purchase conversion rate is the ratio of completed orders to visits.\ > \---\ > \## Revision History\ > \* Release v2.00\_240827: Created purchase conversion rate by customer journey for dashboard
```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":"Search Period Type","minLength":1},"siteNo":{"type":"string","description":"Site No."}},"required":["statusPeriod"]},"VisitToOrderDashBoardResponse":{"type":"object","properties":{"main":{"type":"number","format":"double","description":"Purchase Conversion Rate of Main Page Visits"},"mainRate":{"type":"number","format":"double","description":"Increase Rate of Purchase Conversion Rate of Main Page Visits"},"goodsDetail":{"type":"number","format":"double","description":"Purchase Conversion Rate of Product Detail Page Visits"},"goodsDetailRate":{"type":"number","format":"double","description":"Increase Rate of Purchase Conversion Rate of Product Detail Page Visits"},"basket":{"type":"number","format":"double","description":"Purchase Conversion Rate of Cart Page Visits"},"basketRate":{"type":"number","format":"double","description":"Increase Rate of Purchase Conversion Rate of Cart Page Visits"},"orderSheet":{"type":"number","format":"double","description":"Purchase Conversion Rate of Order Page Visits"},"orderSheetRate":{"type":"number","format":"double","description":"Increase Rate of Purchase Conversion Rate of Order Page Visits"},"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":"Date"},"visitMain":{"type":"integer","format":"int32","description":"Main Page Visitor Count"},"visitGoodsDetail":{"type":"integer","format":"int32","description":"Product Detail Page Visitor Count"},"visitBasket":{"type":"integer","format":"int32","description":"Cart Page Visitor Count"},"visitOrderSheet":{"type":"integer","format":"int32","description":"Order Page Visitor Count"}},"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":{"/v2/dashboard/order/customer-journey-conversion-rate":{"get":{"tags":["Dashboard - Orders, Sales, Claims"],"summary":"Retrieve Purchase Conversion Rate by Customer Journey (Dashboard)","description":" ## Function Description\n * Retrieves purchase conversion rate information by customer journey for the BO(MD) dashboard.\n ---\n ## Detailed Description\n * Provides order sales status information based on the current day / last 7 days / last 30 days.\n * If the site parameter is not set to \"All\", only information for the corresponding site is provided.\n * The purchase conversion rate is the ratio of completed orders to visits.\n ---\n ## Revision History\n * Release v2.00_240827: Created purchase conversion rate by customer journey for dashboard\n","operationId":"getVisitToOrderDashBoard_1","parameters":[{"name":"visitToOrderDashBoardRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/VisitToOrderDashBoardRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VisitToOrderDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ```