GET
/
catalog
/
products
/
{product_id}
/
reviews
curl --request GET \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/catalog/products/{product_id}/reviews \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "reviews": [
      {
        "rating": 3,
        "review_text": "<string>",
        "name": "<string>",
        "email": "[email protected]",
        "status": "pending",
        "is_featured": false,
        "tags": [
          "<string>"
        ],
        "review_date": "2023-11-07T05:31:56Z",
        "images": [
          {
            "blur_url": "<string>",
            "thumbnail_url": "<string>",
            "standard_url": "<string>"
          }
        ],
        "videos": [
          {
            "cover_image_url": "<string>",
            "video_preview_url": "<string>",
            "playback": {
              "hls": "<string>",
              "dash": "<string>"
            },
            "duration": "<string>",
            "size": "<string>"
          }
        ],
        "created_at": "2023-05-25T14:15:22Z",
        "modified_at": "2023-05-25T14:15:22Z"
      }
    ],
    "review_tags": [
      "<string>"
    ],
    "pagination": {
      "total_records": 252,
      "total_pages": 26,
      "previous_page": null,
      "next_page": 2,
      "limit": 10
    }
  }
}

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

no of rows per page

Required range: x >= 1
​
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"}

Examples:

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

​
search
string

search keyword

​
review_tag
string

filter review with review tag

Response

200
application/json
Success response

The response is of type object.