Search docs ⌘K
esc
Type to search across all documentation pages
Commerce

Reviews

Manage product reviews and ratings submitted by customers.

Create a review

POST
/modules/commerce/reviews
commerce:write0.0000053 tokens

Create a product review.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/commerce/reviews \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"product_id":"...","rating":1}'
json — 201 Created
{ "status": "ok" }
Body field
Type
Description
product_id required
string
customer_id
string
order_id
string
rating required
integer
range ≥1 .. ≤5
title
string
max 256 chars
body
string
max 10000 chars
images
array
max 10 items
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

List reviews

GET
/modules/commerce/reviews
commerce:read0.0000008 tokens

List product reviews.

curl
curl https://api.saasignal.saastemly.com/modules/commerce/reviews \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Query param
Type
Description
product_id
string
customer_id
string
status
string
min_rating
integer
range ≥1 .. ≤5
limit
integer
range ≥1 .. ≤100default 25
cursor
string
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Get a review

GET
/modules/commerce/reviews/{review_id}
commerce:read0.0000008 tokens

Retrieve a single review.

curl
curl https://api.saasignal.saastemly.com/modules/commerce/reviews/{review_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
review_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

commerceReviewUpdate

GET

Delete a review

DELETE
/modules/commerce/reviews/{review_id}
commerce:admin

Permanently remove a review.

curl
curl -X DELETE https://api.saasignal.saastemly.com/modules/commerce/reviews/{review_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
review_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited