> 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-analysis.md).
# Order Analysis
## Order (Sales) Status Period Comparison
> \## Function Description\
> \* Retrieves order (sales) status data compared to a prior period.\
> \---\
> \## Detailed Description\
> \* Called when the search button is clicked in the graph at the top of the Statistics > Order Analysis > Order Status by Period (Sales Status by Period) page.\
> \* When calendarType is date (daily), \*\*aggregation type code, search period (search start date, search end date)\*\* are required search conditions.\
> \* When calendarType is month (monthly), \*\*aggregation type code, search period (search start month, search end month)\*\* are required search conditions.\
> \
\
\
> \* Two search results are displayed as a bar graph.\
> \* Data for the search period (Order status: net order amount / Sales status: net sales amount)\
> \* Data for the equivalent period before the search period (Order status: net order amount vs. prior period / Sales status: net sales amount vs. prior period)\
> \* Two search results are displayed as a line graph.\
> \* Data for the search period (Order quantity: net order quantity / Sales quantity: net sales quantity)\
> \* Data for the equivalent period before the search period (Order status: net order quantity vs. prior period / Sales status: net sales quantity vs. prior period)\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation of order (sales) status by period comparison inquiry
```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":{"PeriodBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Period 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"}}},"PeriodBasedStatusResponse":{"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/periodBasedStatus/getPeriodBasedStatusGraphData":{"post":{"tags":["Order Analysis"],"summary":"Order (Sales) Status Period Comparison","description":"## Function Description\n* Retrieves order (sales) status data compared to a prior period.\n---\n## Detailed Description\n* Called when the search button is clicked in the graph at the top of the Statistics > Order Analysis > Order Status by Period (Sales Status by Period) page.\n* When calendarType is date (daily), **aggregation type code, search period (search start date, search end date)** are required search conditions.\n* When calendarType is month (monthly), **aggregation type code, search period (search start month, search end month)** are required search conditions.\n
\n* Two search results are displayed as a bar graph.\n * Data for the search period (Order status: net order amount / Sales status: net sales amount)\n * Data for the equivalent period before the search period (Order status: net order amount vs. prior period / Sales status: net sales amount vs. prior period)\n* Two search results are displayed as a line graph.\n * Data for the search period (Order quantity: net order quantity / Sales quantity: net sales quantity)\n * Data for the equivalent period before the search period (Order status: net order quantity vs. prior period / Sales status: net sales quantity vs. prior period)\n---\n## Revision History\n* Release v2.00_240827: Initial creation of order (sales) status by period comparison inquiry\n","operationId":"getPeriodBasedStatusGraphData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeriodBasedStatusRequest"}}},"required":true},"responses":{"200":{"description":"Successfully retrieved period comparison data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PeriodBasedStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Hourly Order (Sales) Status Graph Data
> \## Function Description\
> \* Retrieves hourly order (sales) status graph data.\
> \---\
> \## Detailed Description\
> \* The search date and aggregation type code are required conditions.\
> \* The aggregation type code distinguishes between order (01) and sales (02).\
> \* Retrieves the list of orders that occurred during the search date.\
> \* If search conditions are provided, the list is filtered by those values.\
> \* Retrieves the hourly net order amount and order quantity for orders that occurred on the search date.\
> \* Retrieves the total net order amount and order quantity for orders that occurred on the search date.\
> \* Retrieves the hourly net order amount and order quantity, compared to the prior period, for orders that occurred on the day before the search date (search date -1).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"HourBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Time Slot Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"targetDate":{"type":"string","format":"date","description":"Search 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"}}},"HourBasedStatusResponse":{"type":"object","description":"Order/Sales Status by Time Slot Response DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"agrtDt":{"type":"string","description":"Search Time"},"imgPath":{"type":"string","description":"Representative Image"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"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":"Product Detail Page Inflow Count"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}}}},"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/hourBasedStatus/getHourBasedStatusGraphData":{"post":{"tags":["Order Analysis"],"summary":"Retrieve Hourly Order (Sales) Status Graph Data","description":" ## Function Description\n * Retrieves hourly order (sales) status graph data.\n ---\n ## Detailed Description\n * The search date and aggregation type code are required conditions.\n * The aggregation type code distinguishes between order (01) and sales (02).\n * Retrieves the list of orders that occurred during the search date.\n * If search conditions are provided, the list is filtered by those values.\n * Retrieves the hourly net order amount and order quantity for orders that occurred on the search date.\n * Retrieves the total net order amount and order quantity for orders that occurred on the search date.\n * Retrieves the hourly net order amount and order quantity, compared to the prior period, for orders that occurred on the day before the search date (search date -1).\n ---\n ## Revision History\n * Release v2.00_240827 : Initial creation\n","operationId":"getHourBasedStatusGraphData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HourBasedStatusRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HourBasedStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Order (Sales) Status Period Comparison
> \## Function Description\
> \* Retrieves order (sales) status data compared to a prior period.\
> \---\
> \## Detailed Description\
> \* Called when the search button is clicked in the graph at the top of the Statistics > Order Analysis > Order Status by Period (Sales Status by Period) page.\
> \* When calendarType is date (daily), \*\*aggregation type code, search period (search start date, search end date)\*\* are required search conditions.\
> \* When calendarType is month (monthly), \*\*aggregation type code, search period (search start month, search end month)\*\* are required search conditions.\
> \
\
\
> \* Two search results are displayed as a bar graph.\
> \* Data for the search period (Order status: net order amount / Sales status: net sales amount)\
> \* Data for the equivalent period before the search period (Order status: net order amount vs. prior period / Sales status: net sales amount vs. prior period)\
> \* Two search results are displayed as a line graph.\
> \* Data for the search period (Order quantity: net order quantity / Sales quantity: net sales quantity)\
> \* Data for the equivalent period before the search period (Order status: net order quantity vs. prior period / Sales status: net sales quantity vs. prior period)\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation of order (sales) status by period comparison inquiry
```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":{"PeriodBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Period 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"}}},"PeriodBasedStatusResponse":{"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":{"/v2/statistics/period/sales-status/graph-data":{"get":{"tags":["Order Analysis"],"summary":"Order (Sales) Status Period Comparison","description":"## Function Description\n* Retrieves order (sales) status data compared to a prior period.\n---\n## Detailed Description\n* Called when the search button is clicked in the graph at the top of the Statistics > Order Analysis > Order Status by Period (Sales Status by Period) page.\n* When calendarType is date (daily), **aggregation type code, search period (search start date, search end date)** are required search conditions.\n* When calendarType is month (monthly), **aggregation type code, search period (search start month, search end month)** are required search conditions.\n
\n* Two search results are displayed as a bar graph.\n * Data for the search period (Order status: net order amount / Sales status: net sales amount)\n * Data for the equivalent period before the search period (Order status: net order amount vs. prior period / Sales status: net sales amount vs. prior period)\n* Two search results are displayed as a line graph.\n * Data for the search period (Order quantity: net order quantity / Sales quantity: net sales quantity)\n * Data for the equivalent period before the search period (Order status: net order quantity vs. prior period / Sales status: net sales quantity vs. prior period)\n---\n## Revision History\n* Release v2.00_240827: Initial creation of order (sales) status by period comparison inquiry\n","operationId":"getPeriodBasedStatusGraphData_1","parameters":[{"name":"periodBasedStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PeriodBasedStatusRequest"}}],"responses":{"200":{"description":"Successfully retrieved period comparison data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PeriodBasedStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Hourly Order (Sales) Status Graph Data
> \## Function Description\
> \* Retrieves hourly order (sales) status graph data.\
> \---\
> \## Detailed Description\
> \* The search date and aggregation type code are required conditions.\
> \* The aggregation type code distinguishes between order (01) and sales (02).\
> \* Retrieves the list of orders that occurred during the search date.\
> \* If search conditions are provided, the list is filtered by those values.\
> \* Retrieves the hourly net order amount and order quantity for orders that occurred on the search date.\
> \* Retrieves the total net order amount and order quantity for orders that occurred on the search date.\
> \* Retrieves the hourly net order amount and order quantity, compared to the prior period, for orders that occurred on the day before the search date (search date -1).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"HourBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Time Slot Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"targetDate":{"type":"string","format":"date","description":"Search 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"}}},"HourBasedStatusResponse":{"type":"object","description":"Order/Sales Status by Time Slot Response DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"agrtDt":{"type":"string","description":"Search Time"},"imgPath":{"type":"string","description":"Representative Image"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"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":"Product Detail Page Inflow Count"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}}}},"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":{"/v2/statistics/period/hourly/sales-status/graph-data":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Hourly Order (Sales) Status Graph Data","description":" ## Function Description\n * Retrieves hourly order (sales) status graph data.\n ---\n ## Detailed Description\n * The search date and aggregation type code are required conditions.\n * The aggregation type code distinguishes between order (01) and sales (02).\n * Retrieves the list of orders that occurred during the search date.\n * If search conditions are provided, the list is filtered by those values.\n * Retrieves the hourly net order amount and order quantity for orders that occurred on the search date.\n * Retrieves the total net order amount and order quantity for orders that occurred on the search date.\n * Retrieves the hourly net order amount and order quantity, compared to the prior period, for orders that occurred on the day before the search date (search date -1).\n ---\n ## Revision History\n * Release v2.00_240827 : Initial creation\n","operationId":"getHourBasedStatusGraphData_1","parameters":[{"name":"orderStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/HourBasedStatusRequest"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HourBasedStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status List by Category - Dashboard
> \## Function Description\
> \* Retrieves the order (sales) status list by category.\
> \* Retrieves the TOP-N items without paging.\
> \---\
> \## Detailed Description\
> \* Aggregates the previous day's data based on 09:00 daily.\
> \* Retrieves the order (sales) status list by category.\
> \* The aggregation type value distinguishes between order (01) and sales (02).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation
```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":{"CategoryStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"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"},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"},"top":{"type":"integer","format":"int32","description":"Top Count"}}},"CategoryStatusResponse":{"type":"object","properties":{"stdCtgNo":{"type":"string","description":"Standard Category No."},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"siteNm":{"type":"string","description":"Site Name"},"mdId":{"type":"string","description":"MD in Charge"},"mdNm":{"type":"string","description":"MD in Charge"},"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"}}},"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/statistics/category/sales-status":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status List by Category - Dashboard","description":"## Function Description\n* Retrieves the order (sales) status list by category.\n* Retrieves the TOP-N items without paging.\n---\n## Detailed Description\n* Aggregates the previous day's data based on 09:00 daily.\n* Retrieves the order (sales) status list by category.\n* The aggregation type value distinguishes between order (01) and sales (02).\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getCategoryStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CategoryStatusRequest"}},{"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":"Payment Method Code (OM013)","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD ID","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryStatusResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status List by Period
> \## Function Description\
> \* This function retrieves the order (sales) status by period.\
> \---\
> \## Detailed Description\
> \* Called when the search button is clicked on the \[BO] Statistics > Order Analysis > Order Status by Period (Sales Status by Period) page.\
> \* If calendarType is date (daily), \*\*Aggregation Type Code, Search Period (Search Start Date, Search End Date)\*\* are required search conditions.\
> \* If calendarType is month (monthly), \*\*Aggregation Type Code, Search Period (Search Start Month, Search End Month)\*\* are required search conditions.\
> \* \*\*Standard Classification No., MD in Charge, Vendor No., Brand No., Product No., Site\*\* are optional search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation of order (sales) status by period inquiry\
> \* Release v2.00\_260512: Umami → GA4 data source migration (Product detail page inflow by period: SM\_DAYCL\_GOODS\_INF\_AGRT → SM\_HOURCL\_GOODS\_INF\_AGRT)
```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":{"PeriodBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Period 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"}}},"RealGridListResponsePeriodBasedStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PeriodBasedStatusResponse"}}}},"PeriodBasedStatusResponse":{"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/periodBasedStatus/getPeriodBasedStatusList":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status List by Period","description":"## Function Description\n* This function retrieves the order (sales) status by period.\n---\n## Detailed Description\n* Called when the search button is clicked on the [BO] Statistics > Order Analysis > Order Status by Period (Sales Status by Period) page.\n* If calendarType is date (daily), **Aggregation Type Code, Search Period (Search Start Date, Search End Date)** are required search conditions.\n* If calendarType is month (monthly), **Aggregation Type Code, Search Period (Search Start Month, Search End Month)** are required search conditions.\n* **Standard Classification No., MD in Charge, Vendor No., Brand No., Product No., Site** are optional search conditions.\n---\n## Revision History\n* Release v2.00_240827: Initial creation of order (sales) status by period inquiry\n* Release v2.00_260512: Umami → GA4 data source migration (Product detail page inflow by period: SM_DAYCL_GOODS_INF_AGRT → SM_HOURCL_GOODS_INF_AGRT)\n","operationId":"getPeriodBasedStatusList","parameters":[{"name":"periodBasedStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PeriodBasedStatusRequest"}},{"name":"calendarType","in":"query","description":"Daily or Monthly","required":true,"schema":{"type":"String"}},{"name":"startMonth","in":"query","description":"Search Start Month","schema":{"type":"String"}},{"name":"endMonth","in":"query","description":"Search End Month","schema":{"type":"String"}},{"name":"startDate","in":"query","description":"Search Start Date","schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search End Date","schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Classification No.","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD in Charge","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"brandNo","in":"query","description":"Brand No.","schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site 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/RealGridListResponsePeriodBasedStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Batch Excel Download of Order (Sales) Status Grid by Period
> \## Function Description\
> \* Generates and downloads the order (sales) status grid list by period as an Excel file.\
> \---\
> \## Detailed Description\
> \* The displayed items are the same as the grid list.\
> \* Retrieves all data matching the search conditions without paging.\
> \* If calendarType is date (daily), \*\*Aggregation Type Code, Search Period (Search Start Date, Search End Date)\*\* are required search conditions.\
> \* If calendarType is month (monthly), \*\*Aggregation Type Code, Search Period (Search Start Month, Search End Month)\*\* are required search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation of order (sales) status by period inquiry\
> \* Release v2.00\_260512: Umami → GA4 data source migration (Product detail page inflow by period: SM\_DAYCL\_GOODS\_INF\_AGRT → SM\_HOURCL\_GOODS\_INF\_AGRT)
```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":{"PeriodBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Period 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"}}},"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/periodBasedStatus/downloadPeriodBasedStatusExcel":{"get":{"tags":["Order Analysis"],"summary":"Batch Excel Download of Order (Sales) Status Grid by Period","description":" ## Function Description\n * Generates and downloads the order (sales) status grid list by period as an Excel file.\n ---\n ## Detailed Description\n * The displayed items are the same as the grid list.\n * Retrieves all data matching the search conditions without paging.\n * If calendarType is date (daily), **Aggregation Type Code, Search Period (Search Start Date, Search End Date)** are required search conditions.\n * If calendarType is month (monthly), **Aggregation Type Code, Search Period (Search Start Month, Search End Month)** are required search conditions.\n ---\n ## Revision History\n * Release v2.00_240827: Initial creation of order (sales) status by period inquiry\n * Release v2.00_260512: Umami → GA4 data source migration (Product detail page inflow by period: SM_DAYCL_GOODS_INF_AGRT → SM_HOURCL_GOODS_INF_AGRT)\n","operationId":"downloadPeriodBasedStatusExcel","parameters":[{"name":"periodBasedStatusRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PeriodBasedStatusRequest"}},{"name":"calendarType","in":"query","description":"Daily or Monthly","required":true,"schema":{"type":"String"}},{"name":"startMonth","in":"query","description":"Search Start Month","schema":{"type":"String"}},{"name":"endMonth","in":"query","description":"Search End Month","schema":{"type":"String"}},{"name":"startDate","in":"query","description":"Search Start Date","schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"Search End Date","schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Classification No.","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD in Charge","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"brandNo","in":"query","description":"Brand No.","schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Excel Download Successful"},"900":{"description":"Excel Download Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Download Order (Sales) Status List by Payment Method as Excel
> \## Function Description\
> \* Downloads the order (sales) status list by payment method as an Excel file.\
> \---\
> \## Detailed Description\
> \* Downloads the order (sales) status list by payment method matching the search conditions as an Excel file with unpaged data.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation
```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":{"PayWayStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"agrtGb":{"type":"string","description":"Aggregation Type"},"payWayCd":{"type":"string","description":"Payment Method Code"}}},"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/payWayStatus/payWayStatusExcelDownload":{"get":{"tags":["Order Analysis"],"summary":"Download Order (Sales) Status List by Payment Method as Excel","description":"## Function Description\n* Downloads the order (sales) status list by payment method as an Excel file.\n---\n## Detailed Description\n* Downloads the order (sales) status list by payment method matching the search conditions as an Excel file with unpaged data.\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"payWayStatusExcelDownload","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PayWayStatusRequest"}},{"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":"payWayCd","in":"query","description":"Payment Method Code (OM013)","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status List by Payment Method
> \## Function Description\
> \* Retrieves the order (sales) status list by payment method.\
> \---\
> \## Detailed Description\
> \* Aggregates the previous day's data based on 09:00 daily.\
> \* Retrieves the order (sales) status list by payment method.\
> \* The aggregation type value distinguishes between order (01) and sales (02).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation
```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":{"PayWayStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"startDate":{"type":"string","format":"date","description":"Start Date"},"endDate":{"type":"string","format":"date","description":"End Date"},"agrtGb":{"type":"string","description":"Aggregation Type"},"payWayCd":{"type":"string","description":"Payment Method Code"}}},"RealGridListResponsePayWayStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PayWayStatusResponse"}}}},"PayWayStatusResponse":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"agrtDt":{"type":"string","description":"Aggregation Date"},"agrtGb":{"type":"string","description":"Aggregation Type"},"payWayCd":{"type":"string","description":"Payment Method Code"},"payWayNm":{"type":"string","description":"Payment Method"},"siteNm":{"type":"string","description":"Site 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"}}},"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/payWayStatus/getPayWayStatusList":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status List by Payment Method","description":"## Function Description\n* Retrieves the order (sales) status list by payment method.\n---\n## Detailed Description\n* Aggregates the previous day's data based on 09:00 daily.\n* Retrieves the order (sales) status list by payment method.\n* The aggregation type value distinguishes between order (01) and sales (02).\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getPayWayStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PayWayStatusRequest"}},{"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":"payWayCd","in":"query","description":"Payment Method Code (OM013)","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePayWayStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status Grid List by Time Slot
> \## Function Description\
> \* Retrieves the order (sales) status grid list by time slot.\
> \---\
> \## Detailed Description\
> \* Search date and aggregation type code value are required conditions.\
> \* The aggregation type code distinguishes between order (01)/sales (02).\
> \* Retrieves order records (compared by order status date/time) within 24 hours of the search date, grouped by time slot.\
> \* If search conditions are present, the list is filtered by those values.\
> \* Time slots with no order records are also displayed in the list.\
> \* For the product detail page inflow count, data is extracted based on the number of records registered in the product detail inflow aggregation table for the same time slot.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation\
> \* Release v2.00\_260512: Umami → GA4 data source migration (Product detail page inflow by time slot: SM\_UMAMI\_INF\_AGRT(raw) → SM\_HOURCL\_GOODS\_INF\_AGRT(hourly pre-aggregation))
```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":{"HourBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Time Slot Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"targetDate":{"type":"string","format":"date","description":"Search 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"}}},"RealGridListResponseHourBasedStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/HourBasedStatusResponse"}}}},"HourBasedStatusResponse":{"type":"object","description":"Order/Sales Status by Time Slot Response DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"agrtDt":{"type":"string","description":"Search Time"},"imgPath":{"type":"string","description":"Representative Image"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"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":"Product Detail Page Inflow Count"},"compareDataList":{"type":"array","description":"Period Comparison Amount List","items":{"$ref":"#/components/schemas/OrderSalesStatusInfo"}}}},"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/hourBasedStatus/getHourBasedStatusList":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status Grid List by Time Slot","description":" ## Function Description\n * Retrieves the order (sales) status grid list by time slot.\n ---\n ## Detailed Description\n * Search date and aggregation type code value are required conditions.\n * The aggregation type code distinguishes between order (01)/sales (02).\n * Retrieves order records (compared by order status date/time) within 24 hours of the search date, grouped by time slot.\n * If search conditions are present, the list is filtered by those values.\n * Time slots with no order records are also displayed in the list.\n * For the product detail page inflow count, data is extracted based on the number of records registered in the product detail inflow aggregation table for the same time slot.\n ---\n ## Revision History\n * Release v2.00_240827 : Initial creation\n * Release v2.00_260512: Umami → GA4 data source migration (Product detail page inflow by time slot: SM_UMAMI_INF_AGRT(raw) → SM_HOURCL_GOODS_INF_AGRT(hourly pre-aggregation))\n","operationId":"getHourBasedStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/HourBasedStatusRequest"}},{"name":"targetDate","in":"query","description":"Search Date","required":true,"schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Category No.","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD in Charge","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"brandNo","in":"query","description":"Brand No.","schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type Code","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseHourBasedStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Batch Excel Download of Order (Sales) Status Grid by Time Slot
> \## Function Description\
> \* Generates and downloads the order (sales) status grid list by time slot as an Excel file.\
> \---\
> \## Detailed Description\
> \* The displayed items are the same as the grid list.\
> \* Retrieves all data matching the search conditions without paging.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation\
> \* Release v2.00\_260512: Umami → GA4 data source migration (Product detail page inflow by time slot: SM\_UMAMI\_INF\_AGRT(raw) → SM\_HOURCL\_GOODS\_INF\_AGRT(hourly pre-aggregation))
```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":{"HourBasedStatusRequest":{"type":"object","description":"Order/Sales Status by Time Slot Request DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"targetDate":{"type":"string","format":"date","description":"Search 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"}}},"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/hourBasedStatus/downloadHourBasedStatusExcel":{"get":{"tags":["Order Analysis"],"summary":"Batch Excel Download of Order (Sales) Status Grid by Time Slot","description":" ## Function Description\n * Generates and downloads the order (sales) status grid list by time slot as an Excel file.\n ---\n ## Detailed Description\n * The displayed items are the same as the grid list.\n * Retrieves all data matching the search conditions without paging.\n ---\n ## Revision History\n * Release v2.00_240827 : Initial creation\n * Release v2.00_260512: Umami → GA4 data source migration (Product detail page inflow by time slot: SM_UMAMI_INF_AGRT(raw) → SM_HOURCL_GOODS_INF_AGRT(hourly pre-aggregation))\n","operationId":"downloadHourBasedStatusExcel","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/HourBasedStatusRequest"}},{"name":"targetDate","in":"query","description":"Search Date","required":true,"schema":{"type":"LocalDate"}},{"name":"stdCtgNo","in":"query","description":"Standard Category No.","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD in Charge","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"brandNo","in":"query","description":"Brand No.","schema":{"type":"String"}},{"name":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type Code","required":true,"schema":{"type":"String"}},{"name":"fileName","in":"query","description":"File Name","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Excel Download Successful"},"900":{"description":"Excel Download Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status List by Product
> \## Function Description\
> \* Retrieves the order (sales) status list by product.\
> \---\
> \## Detailed Description\
> \* Aggregates the previous day's data based on 09:00 daily.\
> \* Retrieves the order (sales) status list by product.\
> \* The aggregation type value distinguishes between order (01) and sales (02).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"GoodsStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"agrtGb":{"type":"string","description":"Aggregation Type"},"goodsNo":{"type":"string","description":"Product No."},"entrNo":{"type":"string","description":"Vendor No."}}},"RealGridListResponseGoodsStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsStatusResponse"}}}},"GoodsStatusResponse":{"type":"object","properties":{"imgPath":{"type":"string","description":"Product Image Path"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"siteNm":{"type":"string","description":"Site Name"},"dcAmt2nd":{"type":"number","description":"Secondary Discount Amount"},"dcAmt3rd":{"type":"number","description":"Tertiary Discount Amount"},"ordAmt":{"type":"number","description":"Order (Delivery Completed) Amount"},"cnclAmt":{"type":"number","description":"Cancellation (Return Completed) Amount"},"realOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int64","description":"Order (Delivery Completed) Quantity"},"cnclQty":{"type":"integer","format":"int64","description":"Cancel (Return Completed) Quantity"},"realOrdQty":{"type":"integer","format":"int64","description":"Net Order (Sales) Quantity"}}},"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/goodsStatus/getGoodsStatusList":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status List by Product","description":"## Function Description\n* Retrieves the order (sales) status list by product.\n---\n## Detailed Description\n* Aggregates the previous day's data based on 09:00 daily.\n* Retrieves the order (sales) status list by product.\n* The aggregation type value distinguishes between order (01) and sales (02).\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"getGoodsStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsStatusRequest"}},{"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":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseGoodsStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Batch Excel Download of Order (Sales) Status Grid by Product
> \## Function Description\
> \* Generates and downloads the order (sales) status grid list by product as an Excel file.\
> \---\
> \## Detailed Description\
> \* The displayed items are the same as the grid list.\
> \* Retrieves all data matching the search conditions without paging.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"GoodsStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"agrtGb":{"type":"string","description":"Aggregation Type"},"goodsNo":{"type":"string","description":"Product No."},"entrNo":{"type":"string","description":"Vendor No."}}},"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/goodsStatus/downloadGoodsStatusExcel":{"get":{"tags":["Order Analysis"],"summary":"Batch Excel Download of Order (Sales) Status Grid by Product","description":"## Function Description\n* Generates and downloads the order (sales) status grid list by product as an Excel file.\n---\n## Detailed Description\n* The displayed items are the same as the grid list.\n* Retrieves all data matching the search conditions without paging.\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"downloadGoodsStatusExcel","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsStatusRequest"}},{"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":"goodsNo","in":"query","description":"Product No.","schema":{"type":"String"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}},{"name":"fileName","in":"query","description":"File Name","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Excel Download Successful"},"900":{"description":"Excel Download Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status List by Vendor
> \## Function Description\
> \* Retrieves the order (sales) status list by vendor.\
> \---\
> \## Detailed Description\
> \* Aggregates the previous day's data based on 09:00 daily.\
> \* Retrieves the order (sales) status list by vendor.\
> \* The aggregation type value distinguishes between order (01) and sales (02).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"EnterpriseStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"agrtGb":{"type":"string","description":"Aggregation Type"},"entrNo":{"type":"string","description":"Vendor No."}}},"RealGridListResponseEnterpriseStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseStatusResponse"}}}},"EnterpriseStatusResponse":{"type":"object","properties":{"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"siteNm":{"type":"string","description":"Site Name"},"dcAmt2nd":{"type":"number","description":"Secondary Discount Amount"},"dcAmt3rd":{"type":"number","description":"Tertiary Discount Amount"},"ordAmt":{"type":"number","description":"Order (Delivery Completed) Amount"},"cnclAmt":{"type":"number","description":"Cancellation (Return Completed) Amount"},"finalOrdAmt":{"type":"integer","format":"int64","description":"Net Order Amount"},"ordQty":{"type":"integer","format":"int64","description":"Order (Delivery Completed) Quantity"},"cnclQty":{"type":"integer","format":"int64","description":"Cancel (Return Completed) Quantity"},"finalOrdQty":{"type":"integer","format":"int64","description":"Net Order (Sales) Quantity"}}},"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/enterpriseStatus/getEnterpriseStatusList":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status List by Vendor","description":"## Function Description\n* Retrieves the order (sales) status list by vendor.\n---\n## Detailed Description\n* Aggregates the previous day's data based on 09:00 daily.\n* Retrieves the order (sales) status list by vendor.\n* The aggregation type value distinguishes between order (01) and sales (02).\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"getEnterpriseStatusList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EnterpriseStatusRequest"}},{"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":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseEnterpriseStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Batch Excel Download of Order (Sales) Status Grid by Vendor
> \## Function Description\
> \* Generates and downloads the order (sales) status grid list by vendor as an Excel file.\
> \---\
> \## Detailed Description\
> \* The displayed items are the same as the grid list.\
> \* Retrieves all data matching the search conditions without paging.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"EnterpriseStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"startDate":{"type":"string","format":"date","description":"Search Period (Start Date)"},"endDate":{"type":"string","format":"date","description":"Search Period (End Date)"},"agrtGb":{"type":"string","description":"Aggregation Type"},"entrNo":{"type":"string","description":"Vendor No."}}},"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/enterpriseStatus/downloadEnterpriseStatusExcel":{"get":{"tags":["Order Analysis"],"summary":"Batch Excel Download of Order (Sales) Status Grid by Vendor","description":"## Function Description\n* Generates and downloads the order (sales) status grid list by vendor as an Excel file.\n---\n## Detailed Description\n* The displayed items are the same as the grid list.\n* Retrieves all data matching the search conditions without paging.\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"downloadEnterpriseStatusExcel","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EnterpriseStatusRequest"}},{"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":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}},{"name":"fileName","in":"query","description":"File Name","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Excel Download Successful"},"900":{"description":"Excel Download Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Order (Sales) Status List by Category
> \## Function Description\
> \* Retrieves the order (sales) status list by category.\
> \---\
> \## Detailed Description\
> \* Aggregates the previous day's data based on 09:00 daily.\
> \* Retrieves the order (sales) status list by category.\
> \* The aggregation type value distinguishes between order (01) and sales (02).\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"CategoryStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"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"},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"},"top":{"type":"integer","format":"int32","description":"Top Count"}}},"RealGridListResponseCategoryStatusResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CategoryStatusResponse"}}}},"CategoryStatusResponse":{"type":"object","properties":{"stdCtgNo":{"type":"string","description":"Standard Category No."},"stdCtgNm":{"type":"string","description":"Standard Category Name"},"siteNm":{"type":"string","description":"Site Name"},"mdId":{"type":"string","description":"MD in Charge"},"mdNm":{"type":"string","description":"MD in Charge"},"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"}}},"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/categoryStatus/getCategoryStatusList":{"get":{"tags":["Order Analysis"],"summary":"Retrieve Order (Sales) Status List by Category","description":"## Function Description\n* Retrieves the order (sales) status list by category.\n---\n## Detailed Description\n* Aggregates the previous day's data based on 09:00 daily.\n* Retrieves the order (sales) status list by category.\n* The aggregation type value distinguishes between order (01) and sales (02).\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"getCategoryStatusList_1","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CategoryStatusRequest"}},{"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":"Payment Method Code (OM013)","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD ID","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCategoryStatusResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Download Order (Sales) Status List by Category as Excel
> \## Function Description\
> \* Downloads the order (sales) status list by category as an Excel file.\
> \---\
> \## Detailed Description\
> \* Downloads the order (sales) status list by category matching the search conditions as an Excel file with unpaged data.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Initial creation
```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":{"CategoryStatusRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"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"},"brandNo":{"type":"string","description":"Brand No."},"goodsNo":{"type":"string","description":"Product No."},"agrtGb":{"type":"string","description":"Aggregation Type"},"top":{"type":"integer","format":"int32","description":"Top Count"}}},"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/categoryStatus/categoryStatusExcelDownload":{"get":{"tags":["Order Analysis"],"summary":"Download Order (Sales) Status List by Category as Excel","description":"## Function Description\n* Downloads the order (sales) status list by category as an Excel file.\n---\n## Detailed Description\n* Downloads the order (sales) status list by category matching the search conditions as an Excel file with unpaged data.\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"categoryStatusExcelDownload","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CategoryStatusRequest"}},{"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":"Payment Method Code (OM013)","schema":{"type":"String"}},{"name":"mdId","in":"query","description":"MD ID","schema":{"type":"String"}},{"name":"agrtGb","in":"query","description":"Aggregation Type","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```