Skip to content

Submit a review

POST
/api/v1/business/website/reviews/

Review a product (or the store itself when product_id is omitted). is_verified_purchase is set automatically when the shopper has a delivered order containing the product. One review per product per shopper.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"product_id": 0,
  
"rating": 0,
  
"title": "string",
  
"content": "string",
  
"images": [
  
  
"string"
  
]
}

Responses

Review submitted.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": "string"
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale