Skip to main content
GET
/
catalog
/
marketplace
/
products
/
{product_id}
/
reviews
List all product reviews
curl --request GET \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/catalog/marketplace/products/{product_id}/reviews \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "reviews": [
      {
        "rating": 3,
        "review_text": "<string>",
        "name": "<string>",
        "email": "jsmith@example.com",
        "is_featured": false,
        "tags": [
          "<string>"
        ],
        "review_date": "2023-11-07T05:31:56Z",
        "images": [
          {
            "id": "<string>",
            "title": "<string>",
            "alternate_text": "<string>",
            "sort_order": 123,
            "url_tiny": "<string>",
            "url_thumbnail": "<string>",
            "url_standard": "<string>",
            "url_zoom": "<string>"
          }
        ],
        "videos": [
          {
            "title": "<string>",
            "alternate_text": "<string>",
            "sort_order": 123,
            "video_preview_url": "<string>",
            "video_stream_hls_url": "<string>",
            "video_stream_dash_url": "<string>",
            "image_thumbnail_url": "<string>",
            "video_duration": 123
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "review_tags": [
      "<string>"
    ],
    "pagination": {
      "total_records": 123,
      "total_pages": 123,
      "limit": 123,
      "next_page": 123,
      "previous_page": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Access token

Path Parameters

product_id
string
required

id of a particular product

Query Parameters

page
number

page number of pagination list

Required range: x >= 1
limit
integer

Number of results per page.

Required range: 1 <= x <= 100
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"} json string in format {'field_name':'asc', 'other_field_name':'desc', ...}

Example:

"{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}"

search keyword

review_tag
string

filter review with review tag

Response

Success response

message
string
required
success
boolean
required
content
object
required