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

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 - array
    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
    Type: array[string]

    Allowed: name | type | sku | description | weight | width | depth | height | price | cost_price | retail_price | sale_price | map_price | tax_class_id | product_tax_code | calculated_price | categories | brand_id | option_set_id | option_set_display | inventory_level | inventory_warning_level | inventory_tracking | reviews_rating_sum | reviews_count | total_sold | fixed_cost_shipping_price | is_free_shipping | is_visible | is_featured | related_products | warranty | bin_picking_number | layout_file | upc | mpn | gtin | date_last_imported | search_keywords | availability | availability_description | condition | is_condition_shown | order_quantity_minimum | order_quantity_maximum | page_title | meta_keywords | meta_description | date_created | date_modified | view_count | preorder_release_date | preorder_message | is_preorder_only | is_price_hidden | price_hidden_label | custom_url | base_variant_id | open_graph_type | open_graph_title | open_graph_description | open_graph_use_meta_description | open_graph_use_product_name | open_graph_use_image

  • exclude_fields in query - array
    Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
    Type: array[string]
  • page in query - integer

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

  • limit in query with default of 50 - 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.

    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

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.

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

Body

object | application/json

The model for a POST to create a product review.

  • title    string
    required

    The title for the product review. Required in /POST.

    >= 0 characters<= 255 characters
    Example: Great Product

  • text    string

    The text for the product review.

  • status    string

    The status of the product review. Must be one of approved, disapproved or pending.

    Example: approved

  • rating    integer

    The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.
    Example: 5

  • name    string

    The name of the reviewer.
    >= 0 characters<= 255 characters
    Example: Bob S.

  • date_reviewed    string
    required

    Date the product was reviewed. Required in /POST.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    object

    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

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.

  • include_fields in query - array
    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
    Type: array[string]

    Allowed: name | type | sku | description | weight | width | depth | height | price | cost_price | retail_price | sale_price | map_price | tax_class_id | product_tax_code | calculated_price | categories | brand_id | option_set_id | option_set_display | inventory_level | inventory_warning_level | inventory_tracking | reviews_rating_sum | reviews_count | total_sold | fixed_cost_shipping_price | is_free_shipping | is_visible | is_featured | related_products | warranty | bin_picking_number | layout_file | upc | mpn | gtin | date_last_imported | search_keywords | availability | availability_description | condition | is_condition_shown | order_quantity_minimum | order_quantity_maximum | page_title | meta_keywords | meta_description | date_created | date_modified | view_count | preorder_release_date | preorder_message | is_preorder_only | is_price_hidden | price_hidden_label | custom_url | base_variant_id | open_graph_type | open_graph_title | open_graph_description | open_graph_use_meta_description | open_graph_use_product_name | open_graph_use_image

  • exclude_fields in query - array
    Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
    Type: array[string]

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    object

    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

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.

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

A BigCommerce ProductReview object.

Body

object | application/json

The model for a PUT to update a product review.

  • title    string
    required

    The title for the product review. Required in /POST.

    >= 0 characters<= 255 characters

  • text    string

    The text for the product review.

  • status    string

    The status of the product review. Must be one of approved, disapproved or pending.

  • rating    integer

    The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.

  • name    string

    The name of the reviewer.
    >= 0 characters<= 255 characters

  • date_reviewed    string
    required

    Date the product was reviewed. Required in /POST.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    object

    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

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.

example

Response

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