Skip to main content
POST
/
v1
/
reviews
Create
curl --request POST \
  --url https://{defaultHost}/v1/reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "review": {
    "title": "Useful Product",
    "body": "Easy to use",
    "stars": 4.5,
    "product": "ca2d63f8-6292-4841-8044-9391c0e1ad3d",
    "customer": "59370fb3-0c02-4cae-84ee-0a55fc9ff14e"
  }
}
'
{
  "id": "376024a6-c3f2-46ce-80a6-86fbe180f374",
  "object": "review",
  "body": "Easy to use",
  "status": "in_review",
  "title": "Useful Product",
  "stars": 4.5,
  "verified": false,
  "customer": "59370fb3-0c02-4cae-84ee-0a55fc9ff14e",
  "product": "ca2d63f8-6292-4841-8044-9391c0e1ad3d",
  "purchase": null,
  "created_at": 1767909768,
  "updated_at": 1767909768
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
review
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
title
string | null

The title of the review.

​
body
string | null

The content/body of the review.

​
stars
number<float> | null

The numerical rating provided in the review. Can be a decimal from 1.0 to 5.0.

​
status
string | null

The status of the review (e.g. in_review, published, unpublished).

​
verified
boolean

Indicates whether the reviewer has purchased the product (based on presence of a purchase).

​
customer

Expandable – The associated customer ID.

​
product

Expandable – The associated product ID.

​
purchase

Expandable – The associated purchase ID.

​
review_medias

Expandable – Property not returned unless expanded.

​
discarded_at
integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.