json icon

Get Product Reviews

v1.0.0queries

Query to fetch the published reviews and aggregate rating for a product.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "GetProductReviews",
4  "type": "object",
5  "properties": {
6    "productId": { "type": "string", "description": "The product to fetch reviews for." },
7    "page": { "type": "integer", "minimum": 1, "default": 1 },
8    "pageSize": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 },
9    "sort": { "type": "string", "enum": ["newest", "highest", "lowest", "most_helpful"], "default": "newest" }
10  },
11  "required": ["productId"]
12}
13

Details

Format
JSON Schema
Resource
queries
Filename
schema.json

Versions