List Product Reviews

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/reviews

GET

/stores/:store_hash/v3/catalog/products/:product_id/reviews

curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/reviews \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "title": "string",
      "date_reviewed": "2024-01-15T09:30:00Z",
      "text": "string",
      "status": "string",
      "rating": 1,
      "email": "string",
      "name": "string",
      "id": 1,
      "date_created": "2024-01-15T09:30:00Z",
      "date_modified": "2024-01-15T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

Returns a list of all Product Reviews. Optional parameters can be passed in.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

product_idintegerRequired

The ID of the Product to which the resource belongs.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

include_fieldslist of enumsOptional

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fieldslist of stringsOptional

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional<=250Defaults to 50

Controls the number of items per page in a limited (paginated) list of products.

statusenumOptional

Filter items by status. 1 for approved, 0 for pending.

Allowed values:

Response

OK. If the product has no reviews, data is an empty array and meta.pagination.total is 0.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

404

Not Found Error