> 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/product-statistics.md).

# Product Statistics

## Retrieve Product Analysis Sales Status List

> \## Function Description\
> \* This function retrieves the product sales status.\
> \* Retrieves the TOP-N items without paging.\
> \---\
> \## Detailed Description\
> \* Called when the search button is clicked on the \[BO] Statistics > Product Analysis > Sales Status page.\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.\*\* are optional search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goods/sales-status":{"get":{"tags":["Product Statistics"],"summary":"Retrieve Product Analysis Sales Status List","description":"## Function Description\n* This function retrieves the product sales status.\n* Retrieves the TOP-N items without paging.\n---\n## Detailed Description\n* Called when the search button is clicked on the [BO] Statistics > Product Analysis > Sales Status page.\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.** are optional search conditions.\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getGoodsSalesStatusList","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Product Analysis Product Detail Inflow Information List

> \## Function Description\
> \* This function retrieves the product detail page inflow information list.\
> \* Retrieves the TOP-N items without paging.\
> \---\
> \## Detailed Description\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Site No.\*\* is an optional search condition.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goods/inflow-status":{"get":{"tags":["Product Statistics"],"summary":"Retrieve Product Analysis Product Detail Inflow Information List","description":"## Function Description\n* This function retrieves the product detail page inflow information list.\n* Retrieves the TOP-N items without paging.\n---\n## Detailed Description\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Site No.** is an optional search condition.\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getGoodsInfStatusList","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Product Analysis Cancellation/Return List

> \## Function Description\
> \* This function retrieves the cancellation/return status list.\
> \* Retrieves the TOP-N items without paging.\
> \---\
> \## Detailed Description\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.\*\* are optional search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goods/cancel-return-status":{"get":{"tags":["Product Statistics"],"summary":"Retrieve Product Analysis Cancellation/Return List","description":"## Function Description\n* This function retrieves the cancellation/return status list.\n* Retrieves the TOP-N items without paging.\n---\n## Detailed Description\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.** are optional search conditions.\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getGoodsCnclRtnStatusList","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Product Analysis Sales Status List

> \## Function Description\
> \* This function retrieves the product sales status.\
> \---\
> \## Detailed Description\
> \* Called when the search button is clicked on the \[BO] Statistics > Product Analysis > Sales Status page.\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.\*\* are optional search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation\
> \* Release v2.00\_260512: Umami → GA4 data source migration (Product detail page inflow count: SM\_DAYCL\_GOODS\_INF\_AGRT → SM\_HOURCL\_GOODS\_INF\_AGRT)<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"RealGridListResponseGoodsAnalysisResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goodsAnalysis/getGoodsSalesStatusList":{"get":{"tags":["Product Statistics"],"summary":"Retrieve Product Analysis Sales Status List","description":"## Function Description\n* This function retrieves the product sales status.\n---\n## Detailed Description\n* Called when the search button is clicked on the [BO] Statistics > Product Analysis > Sales Status page.\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.** are optional search conditions.\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 count: SM_DAYCL_GOODS_INF_AGRT → SM_HOURCL_GOODS_INF_AGRT)\n","operationId":"getGoodsSalesStatusList_1","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseGoodsAnalysisResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Product Analysis Product Detail Inflow Information List

> \## Function Description\
> \* This function retrieves the product detail page inflow information list.\
> \---\
> \## Detailed Description\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Site No.\*\* is an optional search condition.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation\
> \* Release v2.00\_260512: Umami → GA4 data source migration (Product detail page inflow count: SM\_UMAMI\_INF\_AGRT(raw) → SM\_HOURCL\_GOODS\_INF\_AGRT(hourly pre-aggregation))<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"RealGridListResponseGoodsAnalysisResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goodsAnalysis/getGoodsInfStatusList":{"get":{"tags":["Product Statistics"],"summary":"Retrieve Product Analysis Product Detail Inflow Information List","description":"## Function Description\n* This function retrieves the product detail page inflow information list.\n---\n## Detailed Description\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Site No.** is an optional search condition.\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 count: SM_UMAMI_INF_AGRT(raw) → SM_HOURCL_GOODS_INF_AGRT(hourly pre-aggregation))\n","operationId":"getGoodsInfStatusList_1","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseGoodsAnalysisResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Product Analysis Cancellation/Return List

> \## Function Description\
> \* This function retrieves the cancellation/return status list.\
> \---\
> \## Detailed Description\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.\*\* are optional search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"RealGridListResponseGoodsAnalysisResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goodsAnalysis/getGoodsCnclRtnStatusList":{"get":{"tags":["Product Statistics"],"summary":"Retrieve Product Analysis Cancellation/Return List","description":"## Function Description\n* This function retrieves the cancellation/return status list.\n---\n## Detailed Description\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.** are optional search conditions.\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getGoodsCnclRtnStatusList_1","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseGoodsAnalysisResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Product Analysis Common List Inquiry

> \## Function Description\
> \* This function retrieves the product analysis list.\
> \---\
> \## Detailed Description\
> \* \*\*Aggregation Type Code, Search Period (Start Date, End Date)\*\* are required search conditions.\
> \* \*\*Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.\*\* are optional search conditions.\
> \---\
> \## Revision History\
> \* Release v2.00\_240827: Initial creation<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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"}}},"RealGridListResponseGoodsAnalysisResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsAnalysisResponse"}}}},"GoodsAnalysisResponse":{"type":"object","description":"Product Analysis DTO","properties":{"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"},"ordAmt":{"type":"number","description":"Order Amount"},"cnclAmt":{"type":"number","description":"Cancellation Amount"},"ordQty":{"type":"integer","format":"int32","description":"Order Quantity"},"cnclQty":{"type":"integer","format":"int32","description":"Cancellation Quantity"},"infCnt":{"type":"integer","format":"int32","description":"Number of Inflows"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"cvr":{"type":"number","format":"float","description":"Purchase Conversion Rate"},"cnclRtnQty":{"type":"integer","format":"int32","description":"Cancellation/Return Quantity"},"rtnRate":{"type":"number","format":"float","description":"Return Rate"}}},"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/goodsAnalysis/getGoodsAnalysisList":{"get":{"tags":["Product Statistics"],"summary":"Product Analysis Common List Inquiry","description":"## Function Description\n* This function retrieves the product analysis list.\n---\n## Detailed Description\n* **Aggregation Type Code, Search Period (Start Date, End Date)** are required search conditions.\n* **Standard Classification No., MD in Charge, Product No., Vendor No., Brand No., Site No.** are optional search conditions.\n---\n## Revision History\n* Release v2.00_240827: Initial creation\n","operationId":"getGoodsAnalysisList","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"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/RealGridListResponseGoodsAnalysisResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Batch Excel Download of Product Analysis Sales Status Grid

> \## Function Description\
> \* Generates and downloads the product sales status grid list 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 count: SM\_DAYCL\_GOODS\_INF\_AGRT → SM\_HOURCL\_GOODS\_INF\_AGRT)<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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/goodsAnalysis/downloadGoodsSalesStatusExcel":{"get":{"tags":["Product Statistics"],"summary":"Batch Excel Download of Product Analysis Sales Status Grid","description":"## Function Description\n* Generates and downloads the product sales status grid list 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 count: SM_DAYCL_GOODS_INF_AGRT → SM_HOURCL_GOODS_INF_AGRT)\n","operationId":"downloadGoodsSalesStatusExcel","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"fileName","in":"query","description":"File Name","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Batch Excel Download of Product Analysis Cancellation/Return Grid

> \## Function Description\
> \* Generates and downloads the product cancellation/return status grid list 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<br>

```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":{"GoodsAnalysisRequest":{"type":"object","description":"Product Analysis DTO","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/goodsAnalysis/downloadGoodsCnclRtnStatusExcel":{"get":{"tags":["Product Statistics"],"summary":"Batch Excel Download of Product Analysis Cancellation/Return Grid","description":"## Function Description\n* Generates and downloads the product cancellation/return status grid list 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":"downloadGoodsCnclRtnStatusExcel","parameters":[{"name":"goodsAnalysisRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsAnalysisRequest"}},{"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":"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":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"fileName","in":"query","description":"File Name","schema":{"type":"String"}}],"responses":{"200":{"description":"Order Status List Retrieved Successfully"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```