BigCommerce Docs

{
  "data": [
    {
      "title": "Excellent Quality and Fit",
      "date_reviewed": "2024-01-15T09:30:00Z",
      "text": "I was really impressed with the quality of this product. It fits perfectly and the material feels durable.",
      "status": "approved",
      "rating": 5,
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "id": 1024,
      "date_created": "2024-01-15T09:30:00Z",
      "date_modified": "2024-01-16T10:00:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": null,
        "current": "?page=1&limit=50",
        "next": null
      }
    }
  }
}

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.

### 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

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

datalist of objects

metaobject

Data about the response, including pagination and collection totals.

Errors

404

Not Found Error

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

List Product Reviews

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

Errors

OAuth scopes

Authentication header

Further reading