> 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-guide/store-front/goods/undefined-6.md).

# 상품평

상품번호(goodsNo), 회원번호(mbrNo), 리뷰번호(revNo)를 이용하여 상품평을 등록, 수정, 조회하는 기능을 제공합니다. 상품평 등록 시에는 상품평 마일리지 적립이 이루어지며, 상품평 조회 시에는 상품평 리스트, 단 건 상세조회, 요약정보 조회 등을 지원하여 front에서 상품평 정보를 시각화할 수 있습니다. 또한, 상품평 신고 처리와 도움돼요 등록 기능을 포함합니다.

***

## 주요 기능

* **상품평 등록**
  * 상품평 등록 시 상품평 정보, 상품평 평가항목, 멤버 프로필 정보, 상품평 컨텐츠 정보를 저장합니다.
  * 회원 API를 호출하여 상품평 마일리지 적립을 처리합니다.
* **상품평 조회**
  * 상품평 목록 조회: 회원번호, 상품번호, 리뷰번호 중 하나를 이용하여 상품평 목록을 조회합니다.
  * 상품평 상세조회: 상품평 정보, 상품평 평가항목, 멤버 프로필 정보, 상품평 컨텐츠 정보를 조회합니다.
  * 최근 등록된 상품평의 사진, 동영상 썸네일 리스트 조회: 상품별로 최근 등록된 상품평의 사진, 동영상 썸네일 리스트를 조회합니다.
  * 상품별 상품평 요약정보 조회: 상품 카테고리에 따라 상품평 요약정보를 조회합니다.
* **상품평 수정 및 삭제**
  * 상품평 수정: 작성한 상품평을 수정하는 기능을 제공합니다.
  * 상품평 삭제: 작성한 상품평을 삭제하는 기능을 제공합니다.
* **기타 기능**
  * 상품평 도움돼요 등록: 상품평 도움돼요를 등록하는 기능을 제공합니다.
  * 상품평 신고: 부적절한 상품평에 대해 신고하는 기능을 제공합니다.

## 프로세스 정의

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FeulXyvko2EGxkVQolOp9%2F183238810.jpg?alt=media&amp;token=2a66ac98-db3e-4f83-bfd6-f3abf6712ecd" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 회원별 상품평 목록 조회

* 회원이 작성한 상품평 목록을 조회합니다.
* 별도 조회조건 미설정시 최근 1개월 내 작성된 상품평 목록을 조회합니다.
  {% endstep %}

{% step %}

### 상품평 수정

* 회원이 기존에 작성했던 상품평을 수정합니다.
* 마이페이지의 작성한 상품평 화면에서 상품평 수정시 호출됩니다.
* 리뷰번호를 파라미터로 받아서 해당 리뷰번호에 해당하는 상품평을 수정합니다.
* 회원정보를 확인하여 본인이 작성한 상품평만 수정이 가능합니다.
  {% endstep %}

{% step %}

### 상품평 등록

* 마이페이지 활동현황 내 작성가능 상품평 화면에서 상품평작성을 통해 상품평 등록시 호출됩니다.
* 회원정보를 확인하여 본인이 주문한 상품에 대해서만 상품평 작성이 가능합니다.
* 동일 상품에 대해서는 한 건만 상품평 작성이 가능하며, 리뷰작성여부로 확인합니다.
* 적립기한 내 상품평을 작성할 경우 마일리지가 지급됩니다.
  {% endstep %}

{% step %}

### 리뷰번호별 상품평 목록 조회(전시제공)

* 상품번호를 파라미터로 받아 상품의 상품평 목록을 조회합니다.
* 상품상세 페이지 진입시 하단 상품평 영역에 상품평 정보 노출을 위해 호출됩니다.
  {% endstep %}

{% step %}

### 상품평 상세 내역 조회

* 상품평 수정시 기존 상품Q\&A 정보를 불러오기 위해 호출합니다.
* 리뷰번호를 파라미터로 받아 단일 상품평의 상세내용을 조회합니다.
  {% endstep %}

{% step %}

### 상품별 상품평 목록 조회

* 상품 리뷰번호를 통해 해당 리뷰번호에 해당하는 상품평 정보를 조회합니다.
* 전시 모듈에 제공되며, 코너 콘텐츠 상세 정보 조회시 호출됩니다.
  {% endstep %}

{% step %}

### 최근 등록 상품평 컨텐츠 조회

* 최근 작성된 사진/동영상 첨부 상품평의 썸네일을 조회합니다.
* 상품상세 화면 하단 상품평 정보 영역과, 상품별 상품평 목록 화면 상단에 사진/동영상 상품평의 썸네일을 노출하기 위해 호출합니다.
* 각 상품평 별로 1개의 썸네일이 조회되며, 총 개수가 4개가 넘을 경우 더보기 버튼이 호출됩니다.
  {% endstep %}

{% step %}

### 상품평 삭제

* 마이페이지의 작성한 상품평 화면에서 상품평 삭제시 호출됩니다.
* 회원정보를 확인하여 본인이 작성한 상품평만 삭제가 가능합니다.
* 상품평을 물리적으로 삭제하지 않고 삭제 여부만 'Y'로 변경하여 화면에 노출되지 않게 합니다.
  {% endstep %}

{% step %}

### 상품평 평가항목, 고객프로필 조회

* 카테고리별 평가정보리스트, 고객 프로필리스트를 조회합니다.
* 상품평 등록 화면에서 해당 상품과 매핑된 평가항목과 표준 카테고리를 나타내기 위해 호출됩니다.
  {% endstep %}

{% step %}

### 상품평 신고 처리

* 리뷰번호를 파라미터로 받아 상품평을 신고합니다.
* 본인이 작성하지 않은 상품평만 신고할 수 있습니다.
  {% endstep %}

{% step %}

### 상품평 도움돼요 등록

* 상품평 도움돼요를 등록하고 해당 상품평의 총 도움돼요 개수를 조회합니다.
* 상품평 회원정보를 확인하여 본인이 작성하지 않은 상품평만 도움돼요가 가능합니다.
  {% endstep %}

{% step %}

### 상품별 상품평 요약정보 조회

* 해당 상품의 총 상품평 갯수, 평점, 평가통계, 평가통계 디테일을 조회합니다.
* 상품상세 화면 하단 상품평 정보 영역에 해당 상품의 상품평 토탈 정보 노출을 위해 호출됩니다.
  {% endstep %}
  {% endstepper %}

## API 기능 목록

<table><thead><tr><th width="108.9998779296875">API</th><th width="392.3333740234375">설명</th><th width="94.6666259765625">Server</th><th width="86.888916015625">메소드</th><th>비고</th></tr></thead><tbody><tr><td>회원별 <br>상품평 <br>목록 조회</td><td><ul><li>회원이 작성한 상품평 목록을 조회합니다.</li><li>별도 조회조건 미설정시 최근 1개월 내 작성된 상품평 목록을 조회합니다.</li></ul></td><td>Goods</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=seltUserRev">🔗API 확인하기></a></td></tr><tr><td>상품평 <br>수정</td><td><ul><li>회원이 기존에 작성했던 상품평을 수정합니다</li><li>마이페이지의 작성한 상품평 화면에서 상품평 수정시 호출됩니다</li></ul></td><td>Goods</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=modifyRev">🔗API 확인하기></a></td></tr><tr><td>상품평 <br>신고 처리</td><td><ul><li>리뷰번호를 파라미터로 받아 상품평을 <br>신고합니다.</li><li>본인이 작성하지 않은 상품평만 신고할 수 <br>있습니다.</li></ul></td><td>Goods</td><td>POST</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=insertRevDeclaration">🔗API 확인하기></a></td></tr><tr><td>상품평 <br>등록</td><td><ul><li>마이페이지 활동현황 내 작성가능 상품평 <br>화면에서 상품평작성을 통해 상품평 등록시 <br>호출됩니다</li><li>회원정보를 확인하여 본인이 주문한 상품에 <br>대해서만 상품평 작성이 가능합니다.</li></ul></td><td>Goods</td><td>POST</td><td><p><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=insertRev">🔗API 확인하기></a></p><p>마일리지 사용/적립 처리: /api/member/v1/mileage/mlgSaveUse</p></td></tr><tr><td>상품평 <br>도움돼요 등록</td><td><ul><li>상품평 도움돼요를 등록하고 해당 상품평의 총 도움돼요 개수를 조회합니다.</li><li>상품평 회원정보를 확인하여 본인이 작성하지 않은 상품평만 도움돼요가 가능합니다.</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=registerRevHlpfulAndRtnCnt">🔗API 확인하기></a></td></tr><tr><td>상품별 <br>상품평 <br>요약정보 조회</td><td><ul><li>해당 상품의 총 상품평 갯수, 평점, 평가통계, <br>평가통계 디테일을 조회합니다</li><li>상품상세 화면 하단 상품평 정보 영역에 해당 상품의 상품평 토탈 정보 노출을 위해 호출됩니다</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=seltRevTotalInfo">🔗API 확인하기></a></td></tr><tr><td>리뷰번호별 상품평 <br>목록 조회(전시제공)</td><td><ul><li>상품번호를 파라미터로 받아 상품의 상품평 <br>목록을 조회합니다.</li><li>상품상세 페이지 진입시 하단 상품평 영역에 <br>상품평 정보노출을 위해 호출됩니다</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=seltRevList">🔗API 확인하기></a></td></tr><tr><td>상품평 <br>상세내역 조회</td><td><ul><li>상품평 수정시 기존 상품평 정보를 불러오기 <br>위해 호출합니다.</li><li>리뷰번호를 파라미터로 받아 단일 상품평의 <br>상세내용을조회합니다.</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=getReviewInMypage">🔗API 확인하기></a></td></tr><tr><td>상품별 <br>상품평 <br>목록 조회</td><td><ul><li>상품 리뷰번호를 통해 해당 리뷰번호에 <br>해당하는 상품평정보를 조회합니다.</li><li>전시 모듈에 제공되며, 코너 콘텐츠 상세 정보 조회시 호출됩니다.</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=seltRevList">🔗API 확인하기></a></td></tr><tr><td>최근 등록 상품평 <br>컨텐츠 <br>조회</td><td><ul><li>최근 작성된 사진/동영상 첨부 상품평의 <br>썸네일을 조회합니다.</li><li>상품상세 화면 하단 상품평 정보 영역과, 상품별 상품평목록 화면 상단에 사진/동영상 상품평의 썸네일을 노출하기 위해 호출합니다</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=getRevContListOfRepresent">🔗API 확인하기></a></td></tr><tr><td>상품평 <br>평가항목, 고객프로필 조회</td><td><ul><li>상품에 매핑된 카테고리별 평가정보리스트, <br>고객 프로필리스트를 조회합니다.</li><li>상품평 등록 화면에서 해당 상품과 매핑된 <br>평가항목과 표준 카테고리를 나타내기 위해 <br>호출됩니다.</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=getEvltAndPrfleListByStdCtg">🔗API 확인하기></a></td></tr><tr><td>상품평 <br>삭제</td><td><ul><li>마이페이지의 작성한 상품평 화면에서 상품평 삭제시 호출됩니다.</li><li>회원정보를 확인하여 본인이 작성한 상품평만 삭제가 가능합니다.</li><li>상품평을 물리적으로 삭제하지 않고 삭제 여부만 'Y'로 변경하여 화면에 노출되지 않게 합니다.</li></ul></td><td>Goods</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=goods&#x26;depth=%EC%83%81%ED%92%88%ED%8F%89&#x26;path=delRev">🔗API 확인하기></a></td></tr></tbody></table>

## 용어 정의

<table><thead><tr><th width="141.7777099609375">명칭</th><th>설명</th><th data-hidden>비고</th></tr></thead><tbody><tr><td>상품</td><td><ul><li>상거래 채널을 통해 판매의 대상이 되는 모든 재화를 의미합니다.</li><li>상품을 전시하는 기본 단위이며 상품 상세 화면을 구성하는 기본 단위가 <br>됩니다.</li><li>상품은 가격을 관리하는 단위입니다.</li></ul></td><td></td></tr><tr><td>단품</td><td><ul><li>상품 하위의 최소 관리 단위로 상품 재고 및 판매의 최소 단위, <br>즉 고객이 구입하게 되는 단위입니다.</li><li>고객의 선택 옵션에 따른, 주문 상품 정보를 관리하는 단위입니다.</li><li>재고를 관리하는 단위입니다. (솔루션에서 재고는 ‘웹재고’를 의미합니다.)</li><li>옵션의 조합으로 단품 정보가 생성됩니다.<br>(예) 단품A : 컬러-블랙/사이즈-260 / 단품B : 컬러-블랙/사이즈-250</li></ul></td><td></td></tr><tr><td>일반상품 (구분)</td><td><ul><li>일반적인 배송이 이루어지는 모든 재화 상품을 의미합니다.</li></ul></td><td></td></tr><tr><td>일반상품</td><td><ul><li>단품에 상품의 옵션을 코드화에서 관리하는 상품을 의미합니다.</li><li>재고 차감은 단품 단위로 이루어 집니다.</li></ul></td><td></td></tr></tbody></table>

##