> 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/statistics-bo-api/order-statistics.md). # Order Statistics ## Order (Sales) Status Compared to Previous Week > \## Function Description\ > \* Retrieves order (sales) status data compared to the previous week.\ > \---\ > \## Detailed Description\ > \* Called when the "Compared to Previous Week" button is clicked on the graph at the top of the \[BO] Statistics > Order Statistics > Order Status (Sales Status) page.\ > \* \*\*Aggregation Type Code (agrtGb)\*\* is a required search condition.\ > \
\
\ > \* The two search results are displayed as a line graph.\ > \* Data for the 7 days based on the search date (Order Status: Net Order Amount / Sales Status: Sales Amount)\ > \* Data for the 7 days based on 7 days prior to the search date (Order Status: Net Order Amount Compared to Period / Sales Status: Sales Amount Compared to Period)\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"OrderStatusRequest":{"type":"object","description":"Order/Sales Status DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"calendarType":{"type":"string","description":"Daily or Monthly"},"startMonth":{"type":"string","description":"Search Period (Start Month)"},"endMonth":{"type":"string","description":"Search Period (End Month)"},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"mdId":{"type":"string","description":"MD in Charge"},"entrNo":{"type":"string","description":"Vendor No."},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"}}},"OrderStatusResponse":{"type":"object","description":"Order Status / Sales Status DTO","properties":{"agrtDt":{"type":"string","description":"Search Date"},"imgPath":{"type":"string","description":"Image Path"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site Name"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"mdId":{"type":"string","description":"MD in Charge"},"mdNm":{"type":"string","description":"MD in Charge Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"brandNm":{"type":"string","description":"Brand Name"},"dcAmt2nd":{"type":"number","description":"Secondary Discount Amount"},"dcAmt3rd":{"type":"number","description":"Tertiary Discount Amount"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"finalOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"finalOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}},"realOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"currRealOrdAmt":{"type":"integer","format":"int64","description":"Current Net Order Amount"}}},"OrderSalesStatusInfo":{"type":"object","description":"Order (Sales) Status Graph DTO","properties":{"agrtDt":{"type":"string","description":"Base Date (Base Time)"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount (Net Sales Amount)"},"pwRealOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount Compared to Period (Net Sales Amount Compared to Period)"},"realOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity (Net Sales Quantity)"},"pwRealOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity Compared to Period (Net Sales Quantity Compared to Period)"}}},"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/orderStatus/getOrderSalesStatusWeekGraph":{"post":{"tags":["Order Statistics"],"summary":"Order (Sales) Status Compared to Previous Week","description":"## Function Description\n* Retrieves order (sales) status data compared to the previous week.\n---\n## Detailed Description\n* Called when the \"Compared to Previous Week\" button is clicked on the graph at the top of the [BO] Statistics > Order Statistics > Order Status (Sales Status) page.\n* **Aggregation Type Code (agrtGb)** is a required search condition.\n

\n* The two search results are displayed as a line graph.\n * Data for the 7 days based on the search date (Order Status: Net Order Amount / Sales Status: Sales Amount)\n * Data for the 7 days based on 7 days prior to the search date (Order Status: Net Order Amount Compared to Period / Sales Status: Sales Amount Compared to Period)\n---\n## Revision History\n* Release v2.00_240613: Improved period search condition\n","operationId":"getOrderSalesStatusWeekGraph","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusRequest"}}},"required":true},"responses":{"200":{"description":"Retrieve Data Compared to Previous Week Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order (Sales) Status Compared to Previous Month > \## Function Description\ > \* Retrieves order (sales) status data compared to the previous month.\ > \---\ > \## Detailed Description\ > \* Called when the "Compared to Previous Month" button is clicked on the graph at the top of the \[BO] Statistics > Order Statistics > Order Status (Sales Status) page.\ > \* \*\*Aggregation Type Code (agrtGb)\*\* is a required search condition.\ > \
\
\ > \* The two search results are displayed as a line graph.\ > \* Data for the 30 days based on the search date (Order Status: Net Order Amount / Sales Status: Sales Amount)\ > \* Data for the 30 days based on 30 days prior to the search date (Order Status: Net Order Amount Compared to Period / Sales Status: Sales Amount Compared to Period)\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"OrderStatusRequest":{"type":"object","description":"Order/Sales Status DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"calendarType":{"type":"string","description":"Daily or Monthly"},"startMonth":{"type":"string","description":"Search Period (Start Month)"},"endMonth":{"type":"string","description":"Search Period (End Month)"},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"mdId":{"type":"string","description":"MD in Charge"},"entrNo":{"type":"string","description":"Vendor No."},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"}}},"OrderStatusResponse":{"type":"object","description":"Order Status / Sales Status DTO","properties":{"agrtDt":{"type":"string","description":"Search Date"},"imgPath":{"type":"string","description":"Image Path"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site Name"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"mdId":{"type":"string","description":"MD in Charge"},"mdNm":{"type":"string","description":"MD in Charge Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"brandNm":{"type":"string","description":"Brand Name"},"dcAmt2nd":{"type":"number","description":"Secondary Discount Amount"},"dcAmt3rd":{"type":"number","description":"Tertiary Discount Amount"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"finalOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"finalOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}},"realOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"currRealOrdAmt":{"type":"integer","format":"int64","description":"Current Net Order Amount"}}},"OrderSalesStatusInfo":{"type":"object","description":"Order (Sales) Status Graph DTO","properties":{"agrtDt":{"type":"string","description":"Base Date (Base Time)"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount (Net Sales Amount)"},"pwRealOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount Compared to Period (Net Sales Amount Compared to Period)"},"realOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity (Net Sales Quantity)"},"pwRealOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity Compared to Period (Net Sales Quantity Compared to Period)"}}},"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/orderStatus/getOrderSalesStatusMonthGraph":{"post":{"tags":["Order Statistics"],"summary":"Order (Sales) Status Compared to Previous Month","description":"## Function Description\n* Retrieves order (sales) status data compared to the previous month.\n---\n## Detailed Description\n* Called when the \"Compared to Previous Month\" button is clicked on the graph at the top of the [BO] Statistics > Order Statistics > Order Status (Sales Status) page.\n* **Aggregation Type Code (agrtGb)** is a required search condition.\n

\n* The two search results are displayed as a line graph.\n * Data for the 30 days based on the search date (Order Status: Net Order Amount / Sales Status: Sales Amount)\n * Data for the 30 days based on 30 days prior to the search date (Order Status: Net Order Amount Compared to Period / Sales Status: Sales Amount Compared to Period)\n---\n## Revision History\n* Release v2.00_240613: Improved period search condition\n","operationId":"getOrderSalesStatusMonthGraph","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusRequest"}}},"required":true},"responses":{"200":{"description":"Retrieve Data Compared to Previous Month Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order (Sales) Status Compared to Previous Day > \## Function Description\ > \* Retrieves order (sales) status data compared to the previous day.\ > \---\ > \## Detailed Description\ > \* Called when the "Compared to Previous Day" button is clicked on the graph at the top of the \[BO] Statistics > Order Statistics > Order Status (Sales Status) page.\ > \* \*\*Aggregation Type Code (agrtGb)\*\* is a required search condition.\ > \
\
\ > \* The two search results are displayed as a line graph.\ > \* Data for the 24 hours based on the search time (Order Status: Net Order Amount / Sales Status: Sales Amount)\ > \* Data for the 24 hours based on 24 hours prior to the search time (Order Status: Net Order Amount Compared to Period / Sales Status: Sales Amount Compared to Period)\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"OrderStatusRequest":{"type":"object","description":"Order/Sales Status DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"calendarType":{"type":"string","description":"Daily or Monthly"},"startMonth":{"type":"string","description":"Search Period (Start Month)"},"endMonth":{"type":"string","description":"Search Period (End Month)"},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"mdId":{"type":"string","description":"MD in Charge"},"entrNo":{"type":"string","description":"Vendor No."},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"}}},"OrderStatusResponse":{"type":"object","description":"Order Status / Sales Status DTO","properties":{"agrtDt":{"type":"string","description":"Search Date"},"imgPath":{"type":"string","description":"Image Path"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site Name"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"mdId":{"type":"string","description":"MD in Charge"},"mdNm":{"type":"string","description":"MD in Charge Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"brandNm":{"type":"string","description":"Brand Name"},"dcAmt2nd":{"type":"number","description":"Secondary Discount Amount"},"dcAmt3rd":{"type":"number","description":"Tertiary Discount Amount"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"finalOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"finalOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}},"realOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"currRealOrdAmt":{"type":"integer","format":"int64","description":"Current Net Order Amount"}}},"OrderSalesStatusInfo":{"type":"object","description":"Order (Sales) Status Graph DTO","properties":{"agrtDt":{"type":"string","description":"Base Date (Base Time)"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount (Net Sales Amount)"},"pwRealOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount Compared to Period (Net Sales Amount Compared to Period)"},"realOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity (Net Sales Quantity)"},"pwRealOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity Compared to Period (Net Sales Quantity Compared to Period)"}}},"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/orderStatus/getOrderSalesStatusDayGraph":{"post":{"tags":["Order Statistics"],"summary":"Order (Sales) Status Compared to Previous Day","description":"## Function Description\n* Retrieves order (sales) status data compared to the previous day.\n---\n## Detailed Description\n* Called when the \"Compared to Previous Day\" button is clicked on the graph at the top of the [BO] Statistics > Order Statistics > Order Status (Sales Status) page.\n* **Aggregation Type Code (agrtGb)** is a required search condition.\n

\n* The two search results are displayed as a line graph.\n * Data for the 24 hours based on the search time (Order Status: Net Order Amount / Sales Status: Sales Amount)\n * Data for the 24 hours based on 24 hours prior to the search time (Order Status: Net Order Amount Compared to Period / Sales Status: Sales Amount Compared to Period)\n---\n## Revision History\n* Release v2.00_240613: Improved period search condition\n","operationId":"getOrderSalesStatusDayGraph","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStatusRequest"}}},"required":true},"responses":{"200":{"description":"Retrieve Data Compared to Previous Day Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrderStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order Statistics > Retrieve Order/Sales Status by Age Group and Gender (Grid) > \## Function Description\ > \* Order Statistics > Retrieves order/sales status by age group and gender. (For grid)\ > \---\ > \## Detailed Description\ > \* This is data retrieved to match the grid columns.\ > \* Sorted in the order of 20s to 60s, then unentered.\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"SalesStatusByGenderAgeRequest":{"type":"object","properties":{"agrtGb":{"type":"string"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"stdCtgNo":{"type":"string"}}},"RealGridListResponseSalesStatusByGenderAgeResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SalesStatusByGenderAgeResponse"}}}},"SalesStatusByGenderAgeResponse":{"type":"object","properties":{"ageGroup":{"type":"string","description":"Age Group"},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"salesFnshQtyFemale":{"type":"integer","format":"int64","description":"Female Order/Sales Quantity"},"salesFnshAmtFemale":{"type":"integer","format":"int64","description":"Female Order/Sales Amount"},"dcAmtFemale":{"type":"integer","format":"int64","description":"Female Discount Amount"},"salesFnshQtyMale":{"type":"integer","format":"int64","description":"Male Order/Sales Quantity"},"salesFnshAmtMale":{"type":"integer","format":"int64","description":"Male Order/Sales Amount"},"dcAmtMale":{"type":"integer","format":"int64","description":"Male Discount Amount"},"salesFnshQtyNotEntered":{"type":"integer","format":"int64","description":"Unentered Order/Sales Quantity"},"salesFnshAmtNotEntered":{"type":"integer","format":"int64","description":"Unentered Order/Sales Amount"},"dcAmtNotEntered":{"type":"integer","format":"int64","description":"Unentered Discount Amount"}}},"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/orderStatus/getSalesStatusByGenderAgeGrid":{"get":{"tags":["Order Statistics"],"summary":"Order Statistics > Retrieve Order/Sales Status by Age Group and Gender (Grid)","description":" ## Function Description\n * Order Statistics > Retrieves order/sales status by age group and gender. (For grid)\n ---\n ## Detailed Description\n * This is data retrieved to match the grid columns.\n * Sorted in the order of 20s to 60s, then unentered.\n ---\n ## Revision History\n * Release v2.00_240613: Improved period search condition\n","operationId":"getSalesStatusByGenderAgeGroupGrid","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SalesStatusByGenderAgeRequest"}},{"name":"agrtGb","in":"query","description":"Aggregation Type Code","required":true,"schema":{"type":"String"}},{"name":"startDate","in":"query","description":"Search Period (Start Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search Period (End Date)","schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Category No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSalesStatusByGenderAgeResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order Statistics > Retrieve Order/Sales Status by Age Group and Gender (Chart) > \## Function Description\ > \* Order Statistics > Retrieves order/sales status by age group and gender. (Chart)\ > \---\ > \## Detailed Description\ > \* This is data used to build the chart.\ > \* Retrieved as a list of age group, gender, and order/sales total.\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"SalesStatusByGenderAgeRequest":{"type":"object","properties":{"agrtGb":{"type":"string"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"stdCtgNo":{"type":"string"}}},"SalesStatusByGenderAgeChartResponse":{"type":"object","properties":{"ageGroup":{"type":"string","description":"Age Group"},"totalSales":{"type":"integer","format":"int64","description":"Order/Sales Total"},"sexGbCd":{"type":"string","description":"Gender Type"}}},"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/orderStatus/getSalesStatusByGenderAgeChart":{"get":{"tags":["Order Statistics"],"summary":"Order Statistics > Retrieve Order/Sales Status by Age Group and Gender (Chart)","description":" ## Function Description\n * Order Statistics > Retrieves order/sales status by age group and gender. (Chart)\n ---\n ## Detailed Description\n * This is data used to build the chart.\n * Retrieved as a list of age group, gender, and order/sales total.\n ---\n ## Revision History\n * Release v2.00_240613: Improved period search condition\n","operationId":"getSalesStatusByGenderAgeGroupChart","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SalesStatusByGenderAgeRequest"}},{"name":"agrtGb","in":"query","description":"Aggregation Type Code","required":true,"schema":{"type":"String"}},{"name":"startDate","in":"query","description":"Search Period (Start Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search Period (End Date)","schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Category No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesStatusByGenderAgeChartResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Retrieve Order (Sales) Status List > \## Function Description\ > \* This function retrieves the order (sales) status.\ > \---\ > \## Detailed Description\ > \* Called when the search button is clicked on the \[BO] Statistics > Order Statistics > Order Status (Sales Status) page.\ > \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\ > \* \*\*Standard Classification No., Product No., Vendor No., Brand No.\*\* are optional search conditions.\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"OrderStatusRequest":{"type":"object","description":"Order/Sales Status DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"calendarType":{"type":"string","description":"Daily or Monthly"},"startMonth":{"type":"string","description":"Search Period (Start Month)"},"endMonth":{"type":"string","description":"Search Period (End Month)"},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"mdId":{"type":"string","description":"MD in Charge"},"entrNo":{"type":"string","description":"Vendor No."},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"}}},"RealGridListResponseOrderStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatusResponse"}}}},"OrderStatusResponse":{"type":"object","description":"Order Status / Sales Status DTO","properties":{"agrtDt":{"type":"string","description":"Search Date"},"imgPath":{"type":"string","description":"Image Path"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"siteNo":{"type":"string","description":"Site No."},"siteNm":{"type":"string","description":"Site Name"},"stdCtgNo":{"type":"string","description":"Standard Category No."},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"mdId":{"type":"string","description":"MD in Charge"},"mdNm":{"type":"string","description":"MD in Charge Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"brandNm":{"type":"string","description":"Brand Name"},"dcAmt2nd":{"type":"number","description":"Secondary Discount Amount"},"dcAmt3rd":{"type":"number","description":"Tertiary Discount Amount"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"finalOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"finalOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}},"realOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"dcAmt":{"type":"number","description":"Discount Amount"},"currRealOrdAmt":{"type":"integer","format":"int64","description":"Current Net Order Amount"}}},"OrderSalesStatusInfo":{"type":"object","description":"Order (Sales) Status Graph DTO","properties":{"agrtDt":{"type":"string","description":"Base Date (Base Time)"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount (Net Sales Amount)"},"pwRealOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount Compared to Period (Net Sales Amount Compared to Period)"},"realOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity (Net Sales Quantity)"},"pwRealOrdQty":{"type":"integer","format":"int64","description":"Net Order Quantity Compared to Period (Net Sales Quantity Compared to Period)"}}},"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/orderStatus/getOrderStatusList":{"get":{"tags":["Order Statistics"],"summary":"Retrieve Order (Sales) Status List","description":"## Function Description\n* This function retrieves the order (sales) status.\n---\n## Detailed Description\n* Called when the search button is clicked on the [BO] Statistics > Order Statistics > Order Status (Sales Status) page.\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Standard Classification No., Product No., Vendor No., Brand No.** are optional search conditions.\n---\n## Revision History\n* Release v2.00_240613: Improved period search condition\n","operationId":"getOrderStatusList","parameters":[{"name":"orderStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderStatusRequest"}},{"name":"startDate","in":"query","description":"Search Start Date","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search End Date","required":true,"schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Classification No.","schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"brandNo","in":"query","description":"Brand No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order Statistics > Retrieve Order/Sales Amount Ratio List by Age and Grade > \## Function Description\ > \* Order Statistics > Retrieves the order/sales status list by age and the order/sales status list by grade.\ > \---\ > \## Detailed Description\ > \* Retrieves data matching the conditions by receiving the aggregation type code (order/sales) and group type code (age/grade) as parameters.\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"OrderSalesGroupStatusRequest":{"type":"object","description":"Order/Sales Status by Age and Grade DTO","properties":{"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"stdCtgNo":{"type":"string","description":"Standard Classification No."},"ageList":{"type":"array","description":"Age Group","items":{"type":"string"}},"selectTopYn":{"type":"string","description":"Top Items by Age Group Search Status"},"agrtGb":{"type":"string","description":"Aggregation Type"},"groupCd":{"type":"string","description":"Group Type"}}},"RealGridListResponseOrderSalesGroupStatusInfoResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OrderSalesGroupStatusInfoResponse"}}}},"OrderSalesGroupStatusInfoResponse":{"type":"object","description":"Order/Sales Status by Age and Grade Response DTO","properties":{"groupCd":{"type":"string","description":"Group Type Code A: By Age, G: By Grade"},"agrtDt":{"type":"string","description":"Search Date"},"stdCtgNm":{"type":"string","description":"Standard Classification Name"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"realOrdQty":{"type":"integer","format":"int32","description":"Net Order Quantity"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"dcAmt":{"type":"number","description":"Discount Amount"}}},"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/orderStatus/getOrderSalesGroupStatusList":{"get":{"tags":["Order Statistics"],"summary":"Order Statistics > Retrieve Order/Sales Amount Ratio List by Age and Grade","description":" ## Function Description\n * Order Statistics > Retrieves the order/sales status list by age and the order/sales status list by grade.\n ---\n ## Detailed Description\n * Retrieves data matching the conditions by receiving the aggregation type code (order/sales) and group type code (age/grade) as parameters.\n ---\n ## Revision History\n * Release v2.00_240613: Improved period search condition\n","operationId":"getOrderSalesGroupStatusList","parameters":[{"name":"orderSalesGroupStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderSalesGroupStatusRequest"}},{"name":"startDate","in":"query","description":"Search Period (Start Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search Period (End Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Classification No.","schema":{"type":"String"}},{"name":"ageList","in":"query","description":"Age Group","schema":{"type":"String"}},{"name":"selectTopYn","in":"query","description":"Top Items by Age Group Search Status","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}},{"name":"groupCd","in":"query","description":"Group Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseOrderSalesGroupStatusInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ``` ## Order Statistics > Retrieve Order/Sales Amount Ratio Data by Age and Grade > \## Function Description\ > \* Order Statistics > Retrieves the data for the order/sales amount ratio graph by age and the order/sales amount ratio graph by grade.\ > \---\ > \## Detailed Description\ > \* Retrieves data matching the conditions by receiving the aggregation type code (order/sales) and group type code (age/grade) as parameters.\ > \---\ > \## Revision History\ > \* Release v2.00\_240613: Improved period search condition
```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":{"OrderSalesGroupStatusRequest":{"type":"object","description":"Order/Sales Status by Age and Grade DTO","properties":{"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"stdCtgNo":{"type":"string","description":"Standard Classification No."},"ageList":{"type":"array","description":"Age Group","items":{"type":"string"}},"selectTopYn":{"type":"string","description":"Top Items by Age Group Search Status"},"agrtGb":{"type":"string","description":"Aggregation Type"},"groupCd":{"type":"string","description":"Group Type"}}},"OrderSalesGroupStatusChartResponse":{"type":"object","description":"Order/Sales Amount Ratio by Age and Grade DTO","properties":{"groupCd":{"type":"string","description":"Group Code A: By Age, G: By Grade"},"ordAmt":{"type":"number","description":"Net Order Amount"}}},"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/orderStatus/getOrderSalesGroupStatusChart":{"get":{"tags":["Order Statistics"],"summary":"Order Statistics > Retrieve Order/Sales Amount Ratio Data by Age and Grade","description":" ## Function Description\n * Order Statistics > Retrieves the data for the order/sales amount ratio graph by age and the order/sales amount ratio graph by grade.\n ---\n ## Detailed Description\n * Retrieves data matching the conditions by receiving the aggregation type code (order/sales) and group type code (age/grade) as parameters.\n ---\n ## Revision History\n * Release v2.00_240613: Improved period search condition\n","operationId":"getOrderSalesGroupStatusChart","parameters":[{"name":"orderSalesGroupStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderSalesGroupStatusRequest"}},{"name":"startDate","in":"query","description":"Search Period (Start Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search Period (End Date)","required":true,"schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Classification No.","schema":{"type":"String"}},{"name":"ageList","in":"query","description":"Age Group","schema":{"type":"String"}},{"name":"selectTopYn","in":"query","description":"Top Items by Age Group Search Status","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}},{"name":"groupCd","in":"query","description":"Group Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderSalesGroupStatusChartResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}} ```