> 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/back-office-api/goods-bo-api/undefined-27.md).
# 상품 대시보드
## 재입고 알림 신청 현황 조회
> \## 기능설명\
> \* 대시보드에 노출될 재입고 알림 신청 현황 조회합니다.\
> \---\
> \## 상세설명\
> \* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 재입고 알림 신청 현황이 조회됩니다.\
> \* 최근 30일 기준 재입고 알림 최다 신청 순으로 5건 조회합니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240826 : 최초 생성
```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":"사이트번호"},"entrNo":{"type":"string","description":"협력사번호"},"userId":{"type":"string","description":"사용자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":"대시보드 재입고 알림 신청 현황 Response","properties":{"totCnt":{"type":"integer","format":"int64","description":"대시보드 재입고 알림 신청 현황 건수"},"list":{"type":"array","description":"대시보드 재입고 알림 신청 현황 목록","items":{"$ref":"#/components/schemas/DashboardReWhsgNotiSgtDto"}}}},"DashboardReWhsgNotiSgtDto":{"type":"object","description":"대시보드 재입고 알림 신청 현황 Response","properties":{"goodsNo":{"type":"string","description":"상품번호"},"goodsNm":{"type":"string","description":"상품명"},"cnt":{"type":"integer","format":"int32","description":"수량"}}},"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":["상품 대시보드"],"summary":"재입고 알림 신청 현황 조회","description":"## 기능설명\n* 대시보드에 노출될 재입고 알림 신청 현황 조회합니다.\n---\n## 상세설명\n* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 재입고 알림 신청 현황이 조회됩니다.\n* 최근 30일 기준 재입고 알림 최다 신청 순으로 5건 조회합니다.\n---\n## 수정번호\n* Release v2.00_240826 : 최초 생성\n","operationId":"getReWhsgNotiSgtStatus","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardReWhsgNotiSgtRequest"}},{"name":"entrNo","in":"query","description":"협력사번호","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"사이트번호","required":true,"schema":{"type":"String"}},{"name":"userId","in":"query","description":"사용자ID","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"재입고 알림 신청 현황 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseDashboardReWhsgNotiSgtResponse"}}}},"900":{"description":"재입고 알림 신청 현황 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## 상품문의 현황 조회
> \## 기능설명\
> \* 대시보드에 노출될 상품문의 현황을 조회합니다.\
> \---\
> \## 상세설명\
> \* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회됩니다.\
> \* procStatCd: 이관처리상태코드(PR039)가 있는 경우 해당코드에 해당하는 문의 목록을 조회합니다.\
> \* 최신 등록일 순으로 상위 5건의 문의 목록과 총 문의 건수를 조회합니다.\
> \## 수정번호\
> \* Release v2.00\_240827 : 사용자의 업무그룹이 'BO\_MD'이면서 맵핑된 표준카테고리가 있는경우, 해당 카테고리 상품만을 대상으로 조회
```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":"대시보드 상품현황 Request","properties":{"siteNo":{"type":"string","description":"사이트번호"},"entrNo":{"type":"string","description":"협력사번호"},"userId":{"type":"string","description":"사용자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":"대시보드 상품현황 Response","properties":{"stdCtgNoCntByUserId":{"type":"integer","format":"int32","description":"user의 담당 카테고리 수"},"totalCnt":{"type":"integer","format":"int32","description":"총 갯수"},"list":{"type":"array","description":"대시보드 상품현황 DTO 리스트","items":{"$ref":"#/components/schemas/DashboardQnAResponseDto"}}}},"DashboardQnAResponseDto":{"type":"object","description":"대시보드 상품현황 Response DTO","properties":{"questNo":{"type":"string","description":"질문번호"},"siteNo":{"type":"string","description":"사이트번호"},"mbrNo":{"type":"string","description":"회원번호"},"goodsNo":{"type":"string","description":"상품번호"},"entrNo":{"type":"string","description":"협력사번호"},"questTypCd":{"type":"string","description":"질문유형코드(PR041)"},"questTitle":{"type":"string","description":"질문제목"},"questCont":{"type":"string","description":"질문내용"},"questDtm":{"type":"string","format":"date-time","description":"질문일시"},"procStatCd":{"type":"string","description":"처리상태코드(PR039)"},"procStatDtm":{"type":"string","format":"date-time","description":"처리상태일시"},"questTypCdNm":{"type":"string","description":"질문유형코드명"},"procStatCdNm":{"type":"string","description":"처리상태코드명"},"totalCnt":{"type":"integer","format":"int32","description":"총 건수"}}},"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":["상품 대시보드"],"summary":"상품문의 현황 조회","description":"## 기능설명\n* 대시보드에 노출될 상품문의 현황을 조회합니다.\n---\n## 상세설명\n* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회됩니다.\n* procStatCd: 이관처리상태코드(PR039)가 있는 경우 해당코드에 해당하는 문의 목록을 조회합니다.\n* 최신 등록일 순으로 상위 5건의 문의 목록과 총 문의 건수를 조회합니다.\n## 수정번호\n* Release v2.00_240827 : 사용자의 업무그룹이 'BO_MD'이면서 맵핑된 표준카테고리가 있는경우, 해당 카테고리 상품만을 대상으로 조회\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":"협력사번호","schema":{"type":"String"}}],"responses":{"200":{"description":"상품문의 현황 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseDashboardQnAResponse"}}}},"900":{"description":"상품문의 현황 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## 상품요약 정보 조회
> \## 기능설명\
> \* 대시보드에 노출될 상품요약 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회됩니다.\
> \* 각 구분값(주문, 찜, 장바구니)에 대하여 가장 많은 이벤트가 발생한 상품을 조회합니다.\
> \* 최근 7일 이내의 상품으로 조회합니다.\
> \---\
> \## 코드정리\
> \* \`\`\` 구분값(gbValue) \`\`\` : ORDER 주문, WISH 찜, 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":"대시보드 상품요약 Response DTO","properties":{"gbValue":{"type":"string","description":"구분값"},"goodsNm":{"type":"string","description":"상품명"},"goodsNo":{"type":"string","description":"상품번호"}}},"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":["상품 대시보드"],"summary":"상품요약 정보 조회","description":"## 기능설명\n* 대시보드에 노출될 상품요약 정보를 조회합니다.\n---\n## 상세설명\n* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회됩니다.\n* 각 구분값(주문, 찜, 장바구니)에 대하여 가장 많은 이벤트가 발생한 상품을 조회합니다.\n* 최근 7일 이내의 상품으로 조회합니다.\n ---\n## 코드정리\n* ``` 구분값(gbValue) ``` : ORDER 주문, WISH 찜, CART 장바구니\n","operationId":"getGoodsSummary","parameters":[{"name":"entrNo","in":"query","description":"협력사번호","required":false,"schema":{"type":"String"}}],"responses":{"200":{"description":"상품요약 정보 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListDashboardGoodsSumResponse"}}}},"900":{"description":"상품요약 정보 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````
## 상품평 현황 조회
> \## 기능설명\
> \* 대시보드에 노출될 상품평 현황 정보를 조회 합니다.\
> \---\
> \## 상세설명\
> \* 최근 7일간 작성된 리뷰를 대상 으로, '신규 상품평(10), '평점 높은 상품평(20)', '평점 낮은 상품평(30)' 갯수를 집계합니다.\
> \* 사용자의 업무그룹이 'BO\_MD'이면서 맵핑된 표준카테고리가 있는경우, 해당 카테고리 상품만을 대상으로 집계합니다.\
> \* 사이트별로 상품을 필터링 합니다.\
> \* '평점 높은 상품평'의 집계 기준은 별점이 4개(혹은 4점) 이상인 경우에 한해 조회합니다.\
> \* '평점 낮은 상품평'의 집계 기준은 별점이 2개(혹은 2점) 이하인 경우에 한해 조회합니다.\
> \* 삭제 여부가 'Y'이거나, 리뷰전시상태코드(PR022)값이 전시처리(20) 상태가 아닌 경우, 대상에서 제외합니다.\
> \---\
> \## 수정번호\
> \* Release v2.00\_240827 : 최초 생성
```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":"상품평 현황 요청 DTO","properties":{"userId":{"type":"string","description":"사용자ID"}}},"DashboardGoodsReviewResponse":{"type":"object","description":"상품평 현황 응답 DTO","properties":{"revStateCd":{"type":"string","description":"리뷰 상태 코드","enum":["10","20","30"]},"revState":{"type":"string","description":"리뷰 싱테","enum":["신규 상품평","평점 높은 상품평","평점 낮은 상품평"]},"revCnt":{"type":"integer","format":"int64","description":"리뷰 건수"}}},"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":["상품 대시보드"],"summary":"상품평 현황 조회","description":"## 기능설명\n* 대시보드에 노출될 상품평 현황 정보를 조회 합니다.\n---\n## 상세설명\n* 최근 7일간 작성된 리뷰를 대상 으로, '신규 상품평(10), '평점 높은 상품평(20)', '평점 낮은 상품평(30)' 갯수를 집계합니다.\n* 사용자의 업무그룹이 'BO_MD'이면서 맵핑된 표준카테고리가 있는경우, 해당 카테고리 상품만을 대상으로 집계합니다.\n* 사이트별로 상품을 필터링 합니다.\n* '평점 높은 상품평'의 집계 기준은 별점이 4개(혹은 4점) 이상인 경우에 한해 조회합니다.\n* '평점 낮은 상품평'의 집계 기준은 별점이 2개(혹은 2점) 이하인 경우에 한해 조회합니다.\n* 삭제 여부가 'Y'이거나, 리뷰전시상태코드(PR022)값이 전시처리(20) 상태가 아닌 경우, 대상에서 제외합니다.\n---\n## 수정번호\n* Release v2.00_240827 : 최초 생성\n","operationId":"getGoodsReviewSituations","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardGoodsReviewRequest"}},{"name":"userId","in":"query","description":"사용자ID","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"사이트번호","schema":{"type":"String"}}],"responses":{"200":{"description":"상품평 현황 조회 성공","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DashboardGoodsReviewResponse"}}}}},"900":{"description":"상품평 현황 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## 상품현황 조회
> \## 기능설명\
> \* 대시보드에 노출될 상품현황을 조회합니다.\
> \---\
> \## 상세설명\
> \* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회됩니다.\
> \* 재고관리하는 상품의 경우 안전재고수량보다 재고가 적은 상품의 상품상태는 재고부족으로 조회됩니다.\
> \---\
> \## 코드정리\
> \* \`\`\` 상품상태(saleStatCd) \`\`\` : 00 재고부족, 02 승인대기, 03 반려, 10 판매중, 20 품절\
> \---\
> \## 수정번호\
> \* Release v2.00\_240827 : 재고부족 -> 안전재고 이하, 파라메터 변경(String -> Request DTO)\
> 사용자의 업무그룹이 'BO\_MD'이면서 맵핑된 표준카테고리가 있는경우, 해당 카테고리 상품만을 대상으로 조회
````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":"대시보드 상품현황 Request","properties":{"siteNo":{"type":"string","description":"사이트번호"},"entrNo":{"type":"string","description":"협력사번호"},"userId":{"type":"string","description":"사용자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":"대시보드 상품현황 Response","properties":{"saleStatCd":{"type":"string","description":"판매상태코드(PR005)"},"saleStatCdNm":{"type":"string","description":"판매상태코드명"},"cnt":{"type":"integer","format":"int32","description":"수량"}}},"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":["상품 대시보드"],"summary":"상품현황 조회","description":"## 기능설명\n* 대시보드에 노출될 상품현황을 조회합니다.\n---\n## 상세설명\n* 로그인한 사용자의 협력사 값이 있는 경우 해당 협력사의 상품들만 조회됩니다.\n* 재고관리하는 상품의 경우 안전재고수량보다 재고가 적은 상품의 상품상태는 재고부족으로 조회됩니다.\n ---\n## 코드정리\n* ``` 상품상태(saleStatCd) ``` : 00 재고부족, 02 승인대기, 03 반려, 10 판매중, 20 품절\n---\n## 수정번호\n* Release v2.00_240827 : 재고부족 -> 안전재고 이하, 파라메터 변경(String -> Request DTO)\n 사용자의 업무그룹이 'BO_MD'이면서 맵핑된 표준카테고리가 있는경우, 해당 카테고리 상품만을 대상으로 조회\n","operationId":"getGoodsCurrentSicuations","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DashboardGoodsCituationRequest"}},{"name":"entrNo","in":"query","description":"협력사번호","schema":{"type":"String"}},{"name":"userId","in":"query","description":"사용자ID","schema":{"type":"String"}}],"responses":{"200":{"description":"상품현황 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListDashboardGoodsCituationResponse"}}}},"900":{"description":"상품현황 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````