> 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/goods-bo-api/product-dashboard.md).
# Product Dashboard
## Retrieve Restock Notification Application Status
> \## Function Description\
> \* Searches the restock alert application status to be displayed on the dashboard.\
> \---\
> \## Detailed Description\
> \* If the logged-in user has a vendor value, the restock alert application status of that vendor is searched.\
> \* Searches the top 5 based on the most restock alert applications within the last 30 days.\
> \---\
> \## Revision History\
> \* Release v2.00\_240826 : 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":{"DashboardReWhsgNotiSgtRequest":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"userId":{"type":"string","description":"User ID"}}},"ResponseDashboardReWhsgNotiSgtResponse":{"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":{"$ref":"#/components/schemas/DashboardReWhsgNotiSgtResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"DashboardReWhsgNotiSgtResponse":{"type":"object","description":"Dashboard Restock Alert Request Status Response","properties":{"totCnt":{"type":"integer","format":"int64","description":"Dashboard Restock Notification Application Status Count"},"list":{"type":"array","description":"Dashboard Restock Notification Application Status List","items":{"$ref":"#/components/schemas/DashboardReWhsgNotiSgtDto"}}}},"DashboardReWhsgNotiSgtDto":{"type":"object","description":"Dashboard Restock Alert Request Status Response","properties":{"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"cnt":{"type":"integer","format":"int32","description":"Quantity"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/dashboardApi/getReWhsgNotiSgtStatus":{"get":{"tags":["Product Dashboard"],"summary":"Retrieve Restock Notification Application Status","description":"## Function Description\n* Searches the restock alert application status to be displayed on the dashboard.\n---\n## Detailed Description\n* If the logged-in user has a vendor value, the restock alert application status of that vendor is searched.\n* Searches the top 5 based on the most restock alert applications within the last 30 days.\n---\n## Revision History\n* Release v2.00_240826 : Initial creation\n","operationId":"getReWhsgNotiSgtStatus","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardReWhsgNotiSgtRequest"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"String"}},{"name":"userId","in":"query","description":"User ID","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Retrieve Restock Notification Application Status Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseDashboardReWhsgNotiSgtResponse"}}}},"900":{"description":"Retrieve Restock Notification Application Status Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Retrieve Product Inquiry Status
> \## Function Description\
> \* Retrieves the product inquiry status to be displayed on the dashboard.\
> \---\
> \## Detailed Description\
> \* If the logged-in user has a vendor value, only products of that vendor are retrieved.\
> \* If procStatCd: Transfer Processing Status Code (PR039) is provided, retrieves the inquiry list corresponding to that code.\
> \* Retrieves the top 5 inquiries and the total inquiry count, sorted by the most recent registration date.\
> \## Revision History\
> \* Release v2.00\_240827 : If the user's work group is 'BO\_MD' and there is a mapped standard category, retrieves only products in that category
```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":{"DashboardGoodsCituationRequest":{"type":"object","description":"Dashboard Product Status Request","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"userId":{"type":"string","description":"User ID"}}},"ResponseDashboardQnAResponse":{"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":{"$ref":"#/components/schemas/DashboardQnAResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"DashboardQnAResponse":{"type":"object","description":"Dashboard Product Status Response","properties":{"stdCtgNoCntByUserId":{"type":"integer","format":"int32","description":"Number of Categories Managed by the User"},"totalCnt":{"type":"integer","format":"int32","description":"Total Count"},"list":{"type":"array","description":"Dashboard Product Status DTO List","items":{"$ref":"#/components/schemas/DashboardQnAResponseDto"}}}},"DashboardQnAResponseDto":{"type":"object","description":"Dashboard Product Status Response DTO","properties":{"questNo":{"type":"string","description":"Question No."},"siteNo":{"type":"string","description":"Site No."},"mbrNo":{"type":"string","description":"Member No."},"goodsNo":{"type":"string","description":"Product No."},"entrNo":{"type":"string","description":"Vendor No."},"questTypCd":{"type":"string","description":"Question Type Code (PR041)"},"questTitle":{"type":"string","description":"Question Title"},"questCont":{"type":"string","description":"Question Details"},"questDtm":{"type":"string","format":"date-time","description":"Question Date/Time"},"procStatCd":{"type":"string","description":"Processing Status Code (PR039)"},"procStatDtm":{"type":"string","format":"date-time","description":"Processing Status Date/Time"},"questTypCdNm":{"type":"string","description":"Question Type Code Name"},"procStatCdNm":{"type":"string","description":"Processing Status Code Name"},"totalCnt":{"type":"integer","format":"int32","description":"Total Count"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/dashboardApi/getQnASicuations":{"get":{"tags":["Product Dashboard"],"summary":"Retrieve Product Inquiry Status","description":"## Function Description\n* Retrieves the product inquiry status to be displayed on the dashboard.\n---\n## Detailed Description\n* If the logged-in user has a vendor value, only products of that vendor are retrieved.\n* If procStatCd: Transfer Processing Status Code (PR039) is provided, retrieves the inquiry list corresponding to that code.\n* Retrieves the top 5 inquiries and the total inquiry count, sorted by the most recent registration date.\n## Revision History\n* Release v2.00_240827 : If the user's work group is 'BO_MD' and there is a mapped standard category, retrieves only products in that category\n","operationId":"getQnASicuations","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardGoodsCituationRequest"}},{"name":"procStatCd","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Retrieve Product Inquiry Status Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseDashboardQnAResponse"}}}},"900":{"description":"Retrieve Product Inquiry Status Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Search Product Summary Information
> \## Function Description\
> \* Searches the product summary information to be displayed on the dashboard.\
> \---\
> \## Detailed Description\
> \* If the logged-in user has a vendor value, only the products of that vendor are searched.\
> \* Searches the product with the most events for each type value (order, wish, cart).\
> \* Searches products within the last 7 days.\
> \---\
> \## Code Reference\
> \* \`\`\` Type Value (gbValue) \`\`\` : ORDER order, WISH wish, CART cart
````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":{"ResponseListDashboardGoodsSumResponse":{"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":{"type":"array","description":"payload","items":{"$ref":"#/components/schemas/DashboardGoodsSumResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"DashboardGoodsSumResponse":{"type":"object","description":"Dashboard Product Summary Response DTO","properties":{"gbValue":{"type":"string","description":"Classification Value"},"goodsNm":{"type":"string","description":"Product Name"},"goodsNo":{"type":"string","description":"Product No."}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/dashboardApi/getGoodsSummary":{"get":{"tags":["Product Dashboard"],"summary":"Search Product Summary Information","description":"## Function Description\n* Searches the product summary information to be displayed on the dashboard.\n---\n## Detailed Description\n* If the logged-in user has a vendor value, only the products of that vendor are searched.\n* Searches the product with the most events for each type value (order, wish, cart).\n* Searches products within the last 7 days.\n ---\n## Code Reference\n* ``` Type Value (gbValue) ``` : ORDER order, WISH wish, CART cart\n","operationId":"getGoodsSummary","parameters":[{"name":"entrNo","in":"query","description":"Vendor No.","required":false,"schema":{"type":"String"}}],"responses":{"200":{"description":"Search Product Summary Information Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListDashboardGoodsSumResponse"}}}},"900":{"description":"Search Product Summary Information Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````
## Retrieve Review Status
> \## Function Description\
> \* Retrieves the review status information to be displayed on the dashboard.\
> \---\
> \## Detailed Description\
> \* Aggregates the counts of 'New Reviews (10)', 'High-Rated Reviews (20)', and 'Low-Rated Reviews (30)' for reviews written within the last 7 days.\
> \* If the user's work group is 'BO\_MD' and there is a mapped standard category, aggregates only products in that category.\
> \* Filters products by site.\
> \* 'High-Rated Reviews' are counted only when the star rating is 4 or more (or 4 points or more).\
> \* 'Low-Rated Reviews' are counted only when the star rating is 2 or less (or 2 points or less).\
> \* Excludes items whose deletion status is 'Y', or whose Review Display Status Code (PR022) value is not 'Displayed (20)'.\
> \---\
> \## 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":{"DashboardGoodsReviewRequest":{"type":"object","description":"Product Review Status Request DTO","properties":{"userId":{"type":"string","description":"User ID"}}},"DashboardGoodsReviewResponse":{"type":"object","description":"Product Review Status Response DTO","properties":{"revStateCd":{"type":"string","description":"Review Status Code","enum":["10","20","30"]},"revState":{"type":"string","description":"Review Status","enum":["신규 상품평","평점 높은 상품평","평점 낮은 상품평"]},"revCnt":{"type":"integer","format":"int64","description":"Review Count"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/dashboardApi/getGoodsReviewSituations":{"get":{"tags":["Product Dashboard"],"summary":"Retrieve Review Status","description":"## Function Description\n* Retrieves the review status information to be displayed on the dashboard.\n---\n## Detailed Description\n* Aggregates the counts of 'New Reviews (10)', 'High-Rated Reviews (20)', and 'Low-Rated Reviews (30)' for reviews written within the last 7 days.\n* If the user's work group is 'BO_MD' and there is a mapped standard category, aggregates only products in that category.\n* Filters products by site.\n* 'High-Rated Reviews' are counted only when the star rating is 4 or more (or 4 points or more).\n* 'Low-Rated Reviews' are counted only when the star rating is 2 or less (or 2 points or less).\n* Excludes items whose deletion status is 'Y', or whose Review Display Status Code (PR022) value is not 'Displayed (20)'.\n---\n## Revision History\n* Release v2.00_240827 : Initial creation\n","operationId":"getGoodsReviewSituations","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardGoodsReviewRequest"}},{"name":"userId","in":"query","description":"User ID","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Retrieve Review Status Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DashboardGoodsReviewResponse"}}}}},"900":{"description":"Retrieve Review Status Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Retrieve Product Status
> \## Function Description\
> \* Retrieves the product status to be displayed on the dashboard.\
> \---\
> \## Detailed Description\
> \* If the logged-in user has a vendor value, only products of that vendor are retrieved.\
> \* For products under inventory management, if the stock is lower than the safety stock quantity, the product status is retrieved as 'Out of Stock'.\
> \---\
> \## Code Reference\
> \* \`\`\` Product Status (saleStatCd) \`\`\` : 00 Out of Stock, 02 Pending Approval, 03 Rejected, 10 On Sale, 20 Sold Out\
> \---\
> \## Revision History\
> \* Release v2.00\_240827 : Out of Stock -> Below Safety Stock, parameter changed (String -> Request DTO)\
> If the user's work group is 'BO\_MD' and there is a mapped standard category, retrieves only products in that category
````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":{"DashboardGoodsCituationRequest":{"type":"object","description":"Dashboard Product Status Request","properties":{"siteNo":{"type":"string","description":"Site No."},"entrNo":{"type":"string","description":"Vendor No."},"userId":{"type":"string","description":"User ID"}}},"ResponseListDashboardGoodsCituationResponse":{"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":{"type":"array","description":"payload","items":{"$ref":"#/components/schemas/DashboardGoodsCituationResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"DashboardGoodsCituationResponse":{"type":"object","description":"Dashboard Product Status Response","properties":{"saleStatCd":{"type":"string","description":"Sales Status Code (PR005)"},"saleStatCdNm":{"type":"string","description":"Sales Status Code Name"},"cnt":{"type":"integer","format":"int32","description":"Quantity"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/dashboardApi/getGoodsCurrentSicuations":{"get":{"tags":["Product Dashboard"],"summary":"Retrieve Product Status","description":"## Function Description\n* Retrieves the product status to be displayed on the dashboard.\n---\n## Detailed Description\n* If the logged-in user has a vendor value, only products of that vendor are retrieved.\n* For products under inventory management, if the stock is lower than the safety stock quantity, the product status is retrieved as 'Out of Stock'.\n ---\n## Code Reference\n* ``` Product Status (saleStatCd) ``` : 00 Out of Stock, 02 Pending Approval, 03 Rejected, 10 On Sale, 20 Sold Out\n---\n## Revision History\n* Release v2.00_240827 : Out of Stock -> Below Safety Stock, parameter changed (String -> Request DTO)\n If the user's work group is 'BO_MD' and there is a mapped standard category, retrieves only products in that category\n","operationId":"getGoodsCurrentSicuations","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardGoodsCituationRequest"}},{"name":"entrNo","in":"query","description":"Vendor No.","schema":{"type":"String"}},{"name":"userId","in":"query","description":"User ID","schema":{"type":"String"}}],"responses":{"200":{"description":"Retrieve Product Status Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListDashboardGoodsCituationResponse"}}}},"900":{"description":"Retrieve Product Status Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````