post

/catalog/products/{product_id}/reviews

Creates a Product Review.

Required Fields

  • title
  • date_reviewed

Read-Only Fields

  • id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Request Body

1 Example
Schema
object

The model for a POST to create a product review.

title
string

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

2 validations + required
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.

email
string

The email of the reviewer. Must be a valid email, or an empty string.

name
string

The name of the reviewer.

2 validations
date_reviewed
string

Date the product was reviewed. Required in /POST.

1 validation + required

Responses

1 Example
Schema
object

Response payload for the BigCommerce API.

data
object

A product review model.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
product_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token