> 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/api-guides-en/store-front/goods/product-review.md).

# Product Review

Provides features to register, edit, and retrieve product reviews using the product number (goodsNo), member number (mbrNo), and review number (revNo). Mileage is accrued for the product review when it is registered, and when retrieving reviews, supports a review list, single-item detail lookup, and summary information lookup so that review information can be visualized on the front end. It also includes review report handling and "Helpful" registration features.

***

## Key Features

* **Register Product Review**
  * When a product review is registered, saves the review information, review evaluation items, member profile information, and review content information.
  * Calls the Member API to process mileage accrual for the product review.
* **Retrieve Product Review**
  * Retrieve product review list: Retrieves the product review list using one of member number, product number, or review number.
  * Retrieve product review detail: Retrieves the review information, review evaluation items, member profile information, and review content information.
  * Retrieve recently registered product review photo/video thumbnail list: Retrieves the photo/video thumbnail list of recently registered product reviews per product.
  * Retrieve product review summary information per product: Retrieves product review summary information according to the product category.
* **Edit and Delete Product Review**
  * Edit product review: Provides a feature to edit a written product review.
  * Delete product review: Provides a feature to delete a written product review.
* **Other Features**
  * Register product review "Helpful": Provides a feature to register "Helpful" for a product review.
  * Report product review: Provides a feature to report an inappropriate product review.

## Process Definition

<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&#x26;token=2a66ac98-db3e-4f83-bfd6-f3abf6712ecd" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Retrieve Product Review List per Member

* Retrieves the list of product reviews written by a member.
* If no separate search condition is set, retrieves the list of product reviews written within the most recent month.
  {% endstep %}

{% step %}

### Edit Product Review

* Edits a product review previously written by the member.
* Called when editing a product review on the "My Written Reviews" screen of My Page.
* Edits the product review corresponding to the given review number, using the review number as a parameter.
* Verifies member information so that only the member who wrote the review can edit it.
  {% endstep %}

{% step %}

### Register Product Review

* Called when a product review is registered by writing a review on the "Reviews Available to Write" screen within the activity status section of My Page.
* Verifies member information so that a review can only be written for products the member has actually ordered.
* Only one review can be written per product, verified by whether a review has already been written.
* Mileage is granted if the review is written within the accrual deadline.
  {% endstep %}

{% step %}

### Retrieve Product Review List by Review Number (Display Use)

* Retrieves the review list for a product using the product number as a parameter.
* Called to display review information in the review area at the bottom of the page when entering the product detail page.
  {% endstep %}

{% step %}

### Retrieve Product Review Detail Content

* Called to load the existing product Q\&A information when editing a product review.
* Retrieves the detailed content of a single product review using the review number as a parameter.
  {% endstep %}

{% step %}

### Retrieve Product Review List per Product

* Retrieves the product review information corresponding to the given review number using the product's review number.
* Provided to the Display module and called when retrieving corner content detail information.
  {% endstep %}

{% step %}

### Retrieve Recently Registered Product Review Content

* Retrieves thumbnails of recently written product reviews that include photo/video attachments.
* Called to display photo/video review thumbnails in the review information area at the bottom of the product detail screen and at the top of the product review list screen.
* One thumbnail is retrieved per review, and a "more" button is displayed if the total count exceeds 4.
  {% endstep %}

{% step %}

### Delete Product Review

* Called when a product review is deleted on the "My Written Reviews" screen of My Page.
* Verifies member information so that only the member who wrote the review can delete it.
* The review is not physically deleted; only the deletion status is changed to 'Y' so that it is no longer displayed on screen.
  {% endstep %}

{% step %}

### Retrieve Product Review Evaluation Items and Customer Profile

* Retrieves the evaluation information list and customer profile list by category.
* Called on the product review registration screen to display the evaluation items and standard category mapped to the product.
  {% endstep %}

{% step %}

### Process Product Review Report

* Reports a product review using the review number as a parameter.
* Only reviews not written by the reporting member can be reported.
  {% endstep %}

{% step %}

### Register Product Review "Helpful"

* Registers "Helpful" for a product review and retrieves the total "Helpful" count for that review.
* Verifies the review's member information so that only members who did not write the review can mark it as "Helpful".
  {% endstep %}

{% step %}

### Retrieve Product Review Summary Information per Product

* Retrieves the total review count, rating, evaluation statistics, and evaluation statistics detail for the product.
* Called to display the product's total review information in the review information area at the bottom of the product detail screen.
  {% endstep %}
  {% endstepper %}

## API Function List

<table><thead><tr><th width="108.9998779296875">API</th><th width="392.3333740234375">Description</th><th width="94.6666259765625">Server</th><th width="86.888916015625">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Retrieve Product Review<br>List<br>per Member</td><td><ul><li>Retrieves the list of product reviews written by the member.</li><li>If no separate search condition is set, retrieves the list of reviews written within the most recent month.</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">🔗View API ></a></td></tr><tr><td>Edit Product<br>Review</td><td><ul><li>Edits a product review previously written by the member</li><li>Called when a product review is edited on the "My Written Reviews" screen of My Page</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">🔗View API ></a></td></tr><tr><td>Process Product<br>Review Report</td><td><ul><li>Reports a product review using the review number as a<br>parameter.</li><li>Only reviews not written by the reporting member can be<br>reported.</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">🔗View API ></a></td></tr><tr><td>Register Product<br>Review</td><td><ul><li>Called when a product review is registered by writing a review<br>on the "Reviews Available to Write" screen within the activity status<br>section of My Page</li><li>Verifies member information so that a review can only be written for<br>products the member has actually ordered.</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">🔗View API ></a></p><p>Mileage Use/Accrual Processing: /api/member/v1/mileage/mlgSaveUse</p></td></tr><tr><td>Register Product<br>Review "Helpful"</td><td><ul><li>Registers "Helpful" for a product review and retrieves the total "Helpful" count for that review.</li><li>Verifies the review's member information so that only members who did not write the review can mark it as "Helpful".</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">🔗View API ></a></td></tr><tr><td>Retrieve Product Review<br>Summary Information<br>per Product</td><td><ul><li>Retrieves the total review count, rating, evaluation statistics,<br>and evaluation statistics detail for the product</li><li>Called to display the product's total review information in the review information area at the bottom of the product detail screen</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">🔗View API ></a></td></tr><tr><td>Retrieve Product Review<br>List by Review Number (Display Use)</td><td><ul><li>Retrieves the product's review<br>list using the product number as a parameter.</li><li>Called to display review information in the review area at the bottom of<br>the page when entering the product detail page</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">🔗View API ></a></td></tr><tr><td>Retrieve Product Review<br>Detail Content</td><td><ul><li>Called to load the existing review information<br>when editing a product review.</li><li>Retrieves the detailed content of a single product review using the review number as a<br>parameter.</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">🔗View API ></a></td></tr><tr><td>Retrieve Product Review<br>List<br>per Product</td><td><ul><li>Retrieves the product review information corresponding to<br>the given review number, using the product's review number.</li><li>Provided to the Display module, and called when retrieving corner content detail information.</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">🔗View API ></a></td></tr><tr><td>Retrieve Recently Registered<br>Product Review<br>Content</td><td><ul><li>Retrieves thumbnails of recently written product reviews<br>that include photo/video attachments.</li><li>Called to display photo/video review thumbnails in the review information area at the bottom of the product detail screen, and at the top of the product review list screen per product</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">🔗View API ></a></td></tr><tr><td>Retrieve Product Review<br>Evaluation Items and Customer Profile</td><td><ul><li>Retrieves the evaluation information list by category and the<br>customer profile list mapped to the product.</li><li>Called on the product review registration screen to display the evaluation<br>items and standard category mapped to the product.</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">🔗View API ></a></td></tr><tr><td>Delete Product<br>Review</td><td><ul><li>Called when a product review is deleted on the "My Written Reviews" screen of My Page.</li><li>Verifies member information so that only the member who wrote the review can delete it.</li><li>The review is not physically deleted; only the deletion status is changed to 'Y' so that it is no longer displayed on screen.</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">🔗View API ></a></td></tr></tbody></table>

## Terminology

<table><thead><tr><th width="141.7777099609375">Term</th><th>Description</th><th data-hidden>Notes</th></tr></thead><tbody><tr><td>Product</td><td><ul><li>Refers to any goods sold through a commerce channel.</li><li>The basic unit for displaying a product, and the basic unit that composes the product detail<br>screen.</li><li>A product is the unit by which price is managed.</li></ul></td><td></td></tr><tr><td>Item</td><td><ul><li>The smallest management unit under a product — the smallest unit of product stock and sale,<br>i.e., the unit the customer actually purchases.</li><li>The unit for managing order product information based on the customer's selected options.</li><li>The unit for managing stock. (In the solution, stock refers to 'web stock'.)</li><li>Item information is created from a combination of options.<br>(Example) Item A: Color-Black/Size-260 / Item B: Color-Black/Size-250</li></ul></td><td></td></tr><tr><td>General Product (Category)</td><td><ul><li>Refers to any goods product for which standard delivery is provided.</li></ul></td><td></td></tr><tr><td>General Product</td><td><ul><li>Refers to a product whose options are managed as codes at the item level.</li><li>Stock is deducted at the item level.</li></ul></td><td></td></tr></tbody></table>

##