> 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/store-front-api-reference/order-api/order-claim-dashboard.md). # Order Claim Dashboard ## 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.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":["Order Claim Dashboard"],"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","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitToOrderDashBoardRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VisitToOrderDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"VisitToOrderDashBoardRequest":{"required":["statusPeriod"],"type":"object","properties":{"statusPeriod":{"type":"string","description":"Search Period Type"},"siteNo":{"type":"string","description":"Site No."}},"description":"Search Dashboard Customer Journey Purchase Conversion Rate Section Request DTO"},"VisitToOrderDashBoardResponse":{"required":["basket","basketRate","goodsDetail","goodsDetailRate","main","mainRate","orderSheet","orderSheetRate"],"type":"object","properties":{"main":{"type":"number","description":"Purchase Conversion Rate of Main Page Visits","format":"double"},"mainRate":{"type":"number","description":"Increase Rate of Purchase Conversion Rate of Main Page Visits","format":"double"},"goodsDetail":{"type":"number","description":"Purchase Conversion Rate of Product Detail Page Visits","format":"double"},"goodsDetailRate":{"type":"number","description":"Increase Rate of Purchase Conversion Rate of Product Detail Page Visits","format":"double"},"basket":{"type":"number","description":"Purchase Conversion Rate of Cart Page Visits","format":"double"},"basketRate":{"type":"number","description":"Increase Rate of Purchase Conversion Rate of Cart Page Visits","format":"double"},"orderSheet":{"type":"number","description":"Purchase Conversion Rate of Order Page Visits","format":"double"},"orderSheetRate":{"type":"number","description":"Increase Rate of Purchase Conversion Rate of Order Page Visits","format":"double"},"recentWeeklyList":{"type":"array","items":{"$ref":"#/components/schemas/VisitInfo"}}},"description":"Search Dashboard Customer Journey Purchase Conversion Rate Section Response DTO"},"VisitInfo":{"required":["agrtDt","visitBasket","visitGoodsDetail","visitMain","visitOrderSheet"],"type":"object","properties":{"agrtDt":{"type":"string","description":"Date"},"visitMain":{"type":"integer","description":"Main Page Visitor Count","format":"int32"},"visitGoodsDetail":{"type":"integer","description":"Product Detail Page Visitor Count","format":"int32"},"visitBasket":{"type":"integer","description":"Cart Page Visitor Count","format":"int32"},"visitOrderSheet":{"type":"integer","description":"Order Page Visitor Count","format":"int32"}},"description":"Visitor Count Status"},"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"}}}} ``` ## Retrieve Dashboard Overview > \## Function Description\ > \* Looks up the BO dashboard overview information.\ > \---\ > \## 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 information only for the corresponding site.\ > \* Number of purchasing customers is the number of users who placed orders. (Returns and cancellations are not counted.)\ > \* Number of visits is the number of visitors to FO.\ > \* Purchase conversion rate is the ratio of order completions to visits.\ > \* Sign-up conversion rate is the ratio of sign-ups to visits.\ > \* Average order is the average amount of all customer orders during the lookup period.\ > \---\ > \## Revision History\ > \* Release v2.00\_240827: Created dashboard 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":["Order Claim Dashboard"],"summary":"Retrieve Dashboard Overview","description":" ## Function Description\n * Looks up the BO dashboard overview information.\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 information only for the corresponding site.\n * Number of purchasing customers is the number of users who placed orders. (Returns and cancellations are not counted.)\n * Number of visits is the number of visitors to FO.\n * Purchase conversion rate is the ratio of order completions to visits.\n * Sign-up conversion rate is the ratio of sign-ups to visits.\n * Average order is the average amount of all customer orders during the lookup period.\n ---\n ## Revision History\n * Release v2.00_240827: Created dashboard 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":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OverviewDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OverviewDashBoardRequest":{"required":["statusPeriod"],"type":"object","properties":{"statusPeriod":{"type":"string","description":"Search Period Type"},"siteNo":{"type":"string","description":"Site No."}},"description":"Search Dashboard Overview Section Request DTO"},"OverviewDashBoardResponse":{"required":["ordManCnt","ordManCntRate","orderAverage","orderAverageRate","visitManCnt","visitManCntRate","visitToJoin","visitToJoinRate","visitToOrder","visitToOrderRate"],"type":"object","properties":{"ordManCnt":{"type":"integer","description":"Number of Purchasing Customers","format":"int32"},"ordManCntRate":{"type":"number","description":"Increase Rate of Purchasing Customers vs. Previous Day","format":"double"},"visitManCnt":{"type":"integer","description":"Number of Visits","format":"int32"},"visitManCntRate":{"type":"number","description":"Increase Rate of Visits vs. Previous Day","format":"double"},"visitToOrder":{"type":"number","description":"Purchase Conversion Rate per Visit","format":"double"},"visitToOrderRate":{"type":"number","description":"Increase Rate of Purchase Conversion Rate per Visit vs. Previous Day","format":"double"},"visitToJoin":{"type":"number","description":"Registration Conversion Rate per Visit","format":"double"},"visitToJoinRate":{"type":"number","description":"Increase Rate of Registration Conversion Rate vs. Previous Day","format":"double"},"orderAverage":{"type":"number","description":"Average Order Amount","format":"double"},"orderAverageRate":{"type":"number","description":"Increase Rate of Average Order Amount vs. Previous Day","format":"double"}},"description":"Dashboard Overview Section Retrieval Response 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"}}}} ``` ## Order Sales Status > \## Function Description\ > \* Looks up 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 information only for the corresponding site.\ > \* When entering via PO, provides information only for the corresponding vendor.\ > \---\ > \## Revision History\ > \* Release v2.00\_240711: Fixed so that the number-of-orders count is no longer multiplied into the base order/cancellation amount displayed\ > \* Release v2.00\_240827: Modified due to full dashboard renewal\ > \---\ > \## Code Reference\ > \* \`\`\`Aggregation type code (agrtGb)\`\`\` : 01: Order status aggregation code, 02: Sales status aggregation code
````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":["Order Claim Dashboard"],"summary":"Order Sales Status","description":" ## Function Description\n * Looks up 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 information only for the corresponding site.\n * When entering via PO, provides information only for the corresponding vendor.\n ---\n ## Revision History\n * Release v2.00_240711: Fixed so that the number-of-orders count is no longer multiplied into the base order/cancellation amount displayed\n * Release v2.00_240827: Modified due to full dashboard renewal\n ---\n ## Code Reference\n * ```Aggregation type code (agrtGb)``` : 01: Order status aggregation code, 02: Sales status aggregation code\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":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderSalesDashBoardResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderSalesDashBoardRequest":{"required":["agrtGb","statusPeriod"],"type":"object","properties":{"agrtGb":{"type":"string","description":"Aggregation Type"},"statusPeriod":{"type":"string","description":"Search Period Type"},"entrNo":{"type":"string","description":"Vendor No."},"siteNo":{"type":"string","description":"Site No."}},"description":"Search Order/Sales Status Request DTO"},"OrderSalesDashBoardResponse":{"required":["cnclRtnAmt","cnclRtnAmtRate","cnclRtnCnt","cnclRtnCntRate","ordSaleAmt","ordSaleAmtRate","ordSaleCnt","ordSaleCntRate"],"type":"object","properties":{"ordSaleAmt":{"type":"integer","description":"Today's Order/Sales Amount","format":"int64"},"ordSaleAmtRate":{"type":"number","description":"Increase Rate of Order/Sales vs. Previous Day","format":"double"},"ordSaleCnt":{"type":"integer","description":"Today's Order/Sales Count","format":"int64"},"ordSaleCntRate":{"type":"number","description":"Increase Rate of Order/Sales Count vs. Previous Day","format":"double"},"cnclRtnAmt":{"type":"integer","description":"Today's Cancellation/Return Amount","format":"int64"},"cnclRtnAmtRate":{"type":"number","description":"Increase Rate of Cancellation/Return Amount vs. Previous Day","format":"double"},"cnclRtnCnt":{"type":"integer","description":"Cancellation/Return Count vs. Previous Day","format":"int64"},"cnclRtnCntRate":{"type":"number","description":"Increase Rate of Cancellation/Return Count vs. Previous Day","format":"double"},"recentWeeklyList":{"type":"array","items":{"$ref":"#/components/schemas/OrderSalesInfo"}}},"description":"Search Order/Sales Status Response DTO"},"OrderSalesInfo":{"required":["agrtDt","cnclRtnAmt","ordSaleAmt"],"type":"object","properties":{"agrtDt":{"type":"string","description":"Date"},"ordSaleAmt":{"type":"integer","description":"Order/Sales Amount","format":"int64"},"cnclRtnAmt":{"type":"integer","description":"Cancellation/Return Amount","format":"int64"}},"description":"Order/Sales and Cancellation/Return Amount Status for the Last 7 Days"},"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"}}}} ```` ## Order/Claim Status > \## Function Description\ > \* Provides order status/claim status information in PO.\ > \---\ > \## Detailed Description\ > \* \*\*Order/claim classification (ordCntGb)\*\* and \*\*vendor name (entrNo)\*\* are required parameters.\ > \* If \*\*order/claim classification (ordCntGb)\*\* is \*\*order (O)\*\*, displays the count for the following \*\*order history status codes (OM005)\*\*.\ > \* \*\*Order Completed (12)\*\*, \*\*Delivery Instructed (21)\*\*, \*\*Shipment Instructed (22)\*\*, \*\*Awaiting Shipment (23)\*\*, \*\*Shipment Completed (26)\*\*\ > \* If \*\*order/claim classification (ordCntGb)\*\* is \*\*claim (C)\*\*, displays the count for the following \*\*order history status codes (OM005)\*\*.\ > \* \*\*Claim Received (32)\*\*, \*\*Collection Instructed (34)\*\*, \*\*Collection Confirmed (35)\*\*\ > \---\ > \## Notes\ > \* Looks up the corresponding status information only when \*\*order/claim classification (ordCntGb)\*\* is \*\*order (O)\*\* or \*\*claim (C)\*\*.\ > \---\ > \## Revision History\ > \* Release v2.00\_240827 : Added condition based on order received datetime within the most recent 30 days
```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":["Order Claim Dashboard"],"summary":"Order/Claim Status","description":" ## Function Description\n * Provides order status/claim status information in PO.\n ---\n ## Detailed Description\n * **Order/claim classification (ordCntGb)** and **vendor name (entrNo)** are required parameters.\n * If **order/claim classification (ordCntGb)** is **order (O)**, displays the count for the following **order history status codes (OM005)**.\n * **Order Completed (12)**, **Delivery Instructed (21)**, **Shipment Instructed (22)**, **Awaiting Shipment (23)**, **Shipment Completed (26)**\n * If **order/claim classification (ordCntGb)** is **claim (C)**, displays the count for the following **order history status codes (OM005)**.\n * **Claim Received (32)**, **Collection Instructed (34)**, **Collection Confirmed (35)**\n ---\n ## Notes\n * Looks up the corresponding status information only when **order/claim classification (ordCntGb)** is **order (O)** or **claim (C)**.\n ---\n ## Revision History\n * Release v2.00_240827 : Added condition based on order received datetime within the most recent 30 days\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":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderClaimDashBoardResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}},"components":{"schemas":{"OrderClaimDashBoardRequest":{"required":["ordCntGb"],"type":"object","properties":{"ordCntGb":{"type":"string","description":"Order/Claim Type O: Order, C: Claim","default":"O"},"entrNo":{"type":"string","description":"Vendor No."}},"description":"Order Status/Claim Status Request DTO"},"OrderClaimDashBoardResponse":{"type":"object","properties":{"ordDtlStatNm":{"type":"string","description":"Order Claim Status Name"},"ordDtlStatCd":{"type":"string","description":"OM005 (Order Detail Status Code)\n 10: REPAY_REQ(Repayment Requested)\n,11: ORDER_ACCEPT(Order Accepted)\n,12: ORDER_COMPLETE(Order Completed)\n,13: ORDER_CANCEL(Order Cancelled)\n,21: DELIVERY_ORDER(Delivery Instructed)\n,22: SHIPPING_ORDER(Shipment Instructed)\n,23: SHIPPING_WAIT(Awaiting Shipment)\n,25: SHIPPING_CONFIRM(Shipment Confirmed)\n,26: SHIPPING_FINISH(Shipment Completed)\n,27: DELIVERY_FINISH(Delivery Completed)\n,31: RETURN_APPLY(Payment Pending)\n,32: RETURN_ACCEPT(Return Accepted)\n,33: RETURN_CANCEL(Return Cancelled)\n,34: WITHDRAWAL_ORDER(Collection Instructed)\n,35: WITHDRAWAL_CONFIRM(Collection Confirmed)\n,36: WITHDRAWAL_FINISH(Collection Completed)\n,37: RETURN_FINISH(Return Completed)\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":"Quantity by Order Claim Status","format":"int32"}},"description":"Order Status/Claim Status Response 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"}}}} ```