Reviews | BigCommerce Dev Center

Get Product Reviews

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

Request

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

Authentication

X-Auth-Token in header - required

Parameters

store_hash in path - string
Accept in header with default of application/json - string - required
The MIME type of the response body.
product_id in path - integer - required
The ID of the Product to which the resource belongs.
include_fields in query - string
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields in query - string
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
page in query - integer
Specifies the page number in a limited (paginated) list of products.
limit in query - integer
Controls the number of items per page in a limited (paginated) list of products.
status in query - integer
Filter items by status. 1 for approved, 0 for pending.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/reviews' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

dataarray[object]
metaobject
Data about the response, including pagination and collection totals.

example

{
  "data": [
    {
      "title": "string",
      "text": "string",
      "status": "string",
      "rating": 0,
      "email": "string",
      "name": "string",
      "date_reviewed": "2019-08-24T14:15:22Z",
      "id": 0,
      "product_id": 0,
      "date_created": "2019-08-24T14:15:22Z",
      "date_modified": "2019-08-24T14:15:22Z"
    }
  ],
  "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"
      }
    }
  }
}

Create a Product Review

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

Request

Creates a Product Review.

Required Fields

title
date_reviewed

Read-Only Fields

Authentication

X-Auth-Token in header - required

Parameters

store_hash in path - string
Content-Type in header with default of application/json - string - required
The MIME type of the request body.

Body

application/json

The model for a POST to create a product review.

titlestring
required
The title for the product review. Required in /POST.
>= 0 characters<= 255 characters
textstring
The text for the product review.
statusstring
The status of the product review. Must be one of approved, disapproved or pending.
ratinginteger
The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
emailstring
The email of the reviewer. Must be a valid email, or an empty string.
namestring
The name of the reviewer.
>= 0 characters<= 255 characters
date_reviewedstring
required
Date the product was reviewed. Required in /POST.

example

{
  "title": "string",
  "text": "string",
  "status": "string",
  "rating": 0,
  "email": "string",
  "name": "string",
  "date_reviewed": "2019-08-24T14:15:22Z"
}

Response

Body

object | application/json

Response payload for the BigCommerce API.

dataobject
A product review model.
metaobject
Response metadata.

example

{
  "data": {
    "title": "irur",
    "text": "anim aute",
    "status": "Lorem ad sed voluptate",
    "rating": 3,
    "email": "esse Lorem laborum aute",
    "name": "ut in ",
    "date_reviewed": "2011-12-31T13:40:42.971Z",
    "id": 82495037,
    "product_id": 22609026,
    "date_created": "1985-01-17T07:37:20.439Z",
    "date_modified": "2004-09-28T14:38:21.973Z"
  },
  "meta": {}
}

Get a Product Review

GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/reviews/{review_id}

Request

Returns a single Product Review. Optional parameters maybe passed in.

Authentication

X-Auth-Token in header - required

Parameters

store_hash in path - string
Accept in header with default of application/json - string - required
The MIME type of the response body.
product_id in path - integer - required
The ID of the Product to which the resource belongs.
review_id in path - integer - required
The ID of the review that is being operated on.
review_id in path - integer - required
The ID of the review that is being operated on.
include_fields in query - string
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
exclude_fields in query - string
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/reviews/[review_id]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

object | application/json

Response payload for the BigCommerce API.

dataobject
A product review model.
metaobject
Response metadata.

example

{
  "data": {
    "title": "irur",
    "text": "anim aute",
    "status": "Lorem ad sed voluptate",
    "rating": 3,
    "email": "esse Lorem laborum aute",
    "name": "ut in ",
    "date_reviewed": "2011-12-31T13:40:42.971Z",
    "id": 82495037,
    "product_id": 22609026,
    "date_created": "1985-01-17T07:37:20.439Z",
    "date_modified": "2004-09-28T14:38:21.973Z"
  },
  "meta": {}
}

Update a Product Review

PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/reviews/{review_id}

Request

Updates a Product Review.

Required Fields

none

Read-Only Fields

Authentication

X-Auth-Token in header - required

Parameters

store_hash in path - string
Content-Type in header with default of application/json - string - required
The MIME type of the request body.
review_id in path - integer - required
The ID of the review that is being operated on.

A BigCommerce ProductReview object.

Body

application/json

The model for a PUT to update a product review.

titlestring
required
The title for the product review. Required in /POST.
>= 0 characters<= 255 characters
textstring
The text for the product review.
statusstring
The status of the product review. Must be one of approved, disapproved or pending.
ratinginteger
The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
emailstring
The email of the reviewer. Must be a valid email, or an empty string.
namestring
The name of the reviewer.
>= 0 characters<= 255 characters
date_reviewedstring
required
Date the product was reviewed. Required in /POST.

example

{
  "title": "string",
  "text": "string",
  "status": "string",
  "rating": 0,
  "email": "string",
  "name": "string",
  "date_reviewed": "2019-08-24T14:15:22Z"
}

Response

Body

object | application/json

Response payload for the BigCommerce API.

dataobject
A product review model.
metaobject
Response metadata.

example

{
  "data": {
    "title": "irur",
    "text": "anim aute",
    "status": "Lorem ad sed voluptate",
    "rating": 3,
    "email": "esse Lorem laborum aute",
    "name": "ut in ",
    "date_reviewed": "2011-12-31T13:40:42.971Z",
    "id": 82495037,
    "product_id": 22609026,
    "date_created": "1985-01-17T07:37:20.439Z",
    "date_modified": "2004-09-28T14:38:21.973Z"
  },
  "meta": {}
}

Delete a Product Review

DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/reviews/{review_id}

Request

Deletes a Product Review.

Authentication

X-Auth-Token in header - required

Parameters

store_hash in path - string
Accept in header with default of application/json - string - required
The MIME type of the response body.
product_id in path - integer - required
The ID of the Product to which the resource belongs.
review_id in path - integer - required
The ID of the review that is being operated on.
review_id in path - integer - required
The ID of the review that is being operated on.

example

curl --request DELETE \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/reviews/[review_id]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Get Product Reviews

Request

Authentication

Parameters

example

Response

Body

dataarray[object]

metaobject

example

Create a Product Review

Request

Authentication

Parameters

Body

titlestringrequired

textstring

statusstring

ratinginteger

emailstring

namestring

date_reviewedstringrequired

example

Response

Body

dataobject

metaobject

example

Get a Product Review

Request

Authentication

Parameters

example

Response

Body

dataobject

metaobject

example

Update a Product Review

Request

Authentication

Parameters

Body

titlestringrequired

textstring

statusstring

ratinginteger

emailstring

namestring

date_reviewedstringrequired

example

Response

Body

dataobject

metaobject

example

Delete a Product Review

Request

Authentication

Parameters

example

Response

titlestring
required

date_reviewedstring
required

titlestring
required

date_reviewedstring
required