Docs
Catalog API
Products
Reviews

Reviews

Get Product Reviews

GET /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
  • status in query - integer

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

    Allowed: 0 | 1

example

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create a Product Review

POST /catalog/products/{product_id}/reviews

Request

Creates a Product Review.

Required Fields

  • title
  • date_reviewed

Read-Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a POST to create a product review.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    A product review model.

  • meta    object

    Response metadata.

example

Get a Product Review

GET /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

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    A product review model.

  • meta    object

    Response metadata.

example

Update a Product Review

PUT /catalog/products/{product_id}/reviews/{review_id}

Request

Updates a Product Review.

Required Fields

  • none

Read-Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

A BigCommerce ProductReview object.

Body

application/json

The model for a PUT to update a product review.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    A product review model.

  • meta    object

    Response metadata.

example

Delete a Product Review

DELETE /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

example

Response

Did you find what you were looking for?
Delete a Product MetafieldGet Product Reviews