Raw schema
{
"type": "object",
"properties": {
"type": {
"description": "What to return (default: all review kinds).",
"type": "string",
"enum": [
"store_review",
"product_review",
"store_third_party_review",
"questions"
]
},
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "Product SKUs, separated by semicolons for several (e.g. \"SKU-1;SKU-2\")."
},
"mpn": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "Product MPNs, separated by semicolons for several (e.g. \"SKU-1;SKU-2\")."
},
"gtin": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "Product GTINs, separated by semicolons for several (e.g. \"SKU-1;SKU-2\")."
},
"tag": {
"type": "string",
"minLength": 1,
"maxLength": 1000,
"description": "Review tags, separated by semicolons for several (e.g. \"SKU-1;SKU-2\")."
},
"branch": {
"description": "Only reviews of this branch name.",
"type": "string",
"maxLength": 200
},
"keyword": {
"description": "Only reviews whose text contains this keyword.",
"type": "string",
"maxLength": 200
},
"email": {
"description": "Only reviews left by this e-mail address.",
"type": "string",
"maxLength": 254
},
"with": {
"description": "Only reviews with active photos, videos or either.",
"type": "string",
"enum": [
"images",
"videos",
"media"
]
},
"date_from": {
"description": "Reviews newer than this date (yyyy-mm-dd).",
"type": "string"
},
"date_to": {
"description": "Reviews older than this date (yyyy-mm-dd).",
"type": "string"
},
"min_rating": {
"description": "Minimum star rating 1-5.",
"type": "integer",
"minimum": 1,
"maximum": 5
},
"sort": {
"description": "Sort order (default date_desc).",
"type": "string",
"enum": [
"date_desc",
"date_asc",
"highest_rating",
"lowest_rating",
"helpful_desc",
"helpful_asc",
"date_update_desc",
"date_update_asc"
]
},
"must_have_body": {
"description": "Only reviews with a comment.",
"type": "boolean"
},
"page": {
"description": "Page, 1-based (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"per_page": {
"description": "Results per page, 1-100.",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}