Amazon: Get listing reviews
curl --request GET \
--url https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"fields": {
"date_text": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"helpful_count": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"rating_score": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"relation": {
"listing_id": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"review_country": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"reviewer_name": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"text": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"title": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"variation_attributes": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"verified_purchase": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"vine": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"flags": [
"<string>"
],
"key": "<string>",
"kind": "<string>",
"rank": 123
}
],
"meta": {
"sources": {}
},
"missing": [
{
"reason": "<string>",
"source": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}AIsa commerce
Amazon: Get listing reviews
Retrieve customer reviews for an Amazon listing.
### Limitations
Reviews are collected on demand and commonly take 30-120 seconds. Allow a client timeout greater than 150 seconds. A longer client timeout does not extend server or source time limits; slow source requests may still return source_unavailable. The source collects and bills whole pages of 10 reviews per star rating. A star quota below 10 reduces returned rows, but does not reduce source work or source cost.
### Data and provenance
By default, each value includes value and source. Shared collection time, license, origin, and value_type are grouped in meta.sources. Use provenance=full for complete per-value provenance. Requested fields not delivered by a source are listed in missing with a reason.
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
GET
https://api.aisa.one
/
apis
/
v1
/
commerce
/
amazon
/
listings
/
{country}
/
{listing_id}
/
reviews
Amazon: Get listing reviews
curl --request GET \
--url https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"fields": {
"date_text": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"helpful_count": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"rating_score": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"relation": {
"listing_id": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"review_country": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"reviewer_name": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"text": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"title": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"variation_attributes": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"verified_purchase": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
},
"vine": {
"confidence": 123,
"dims": {},
"fetched_at": "2023-11-07T05:31:56Z",
"license": "<string>",
"metric": "<string>",
"origin": "<string>",
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"precision": "<string>",
"source": "<string>",
"sources": [
"<string>"
],
"value": "<unknown>",
"value_type": "<string>",
"verified": true
}
},
"flags": [
"<string>"
],
"key": "<string>",
"kind": "<string>",
"rank": 123
}
],
"meta": {
"sources": {}
},
"missing": [
{
"reason": "<string>",
"source": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"retry_hint": "<string>",
"retryable": true,
"type": "<string>",
"details": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Request contract
- Method and path: GET /apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews - country: path; required
- listing_id: path; required
- star_1_limit: query; optional
- star_2_limit: query; optional
- star_3_limit: query; optional
- star_4_limit: query; optional
- star_5_limit: query; optional
- sort_by: query; optional
- format_type: query; optional
- reviewer_type: query; optional
- media_type: query; optional
- q: query; optional
- fields: query; optional
- provenance: query; optional
- Runtime facts: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8
{
"operationId": "get_aisa_commerce_apis_v1_commerce_amazon_listing_4ba29d",
"method": "GET",
"path": "/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.",
"in": "path",
"name": "country",
"required": true,
"schema": {
"description": "Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.",
"enum": [
"DE",
"GB",
"US"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Native product ID on the platform.",
"in": "path",
"name": "listing_id",
"required": true,
"schema": {
"description": "Native product ID on the platform.",
"type": [
"string",
"null"
]
}
},
{
"description": "Maximum number of 1-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"in": "query",
"name": "star_1_limit",
"required": false,
"schema": {
"description": "Maximum number of 1-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"type": [
"string",
"null"
]
}
},
{
"description": "Maximum number of 2-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"in": "query",
"name": "star_2_limit",
"required": false,
"schema": {
"description": "Maximum number of 2-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"type": [
"string",
"null"
]
}
},
{
"description": "Maximum number of 3-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"in": "query",
"name": "star_3_limit",
"required": false,
"schema": {
"description": "Maximum number of 3-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"type": [
"string",
"null"
]
}
},
{
"description": "Maximum number of 4-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"in": "query",
"name": "star_4_limit",
"required": false,
"schema": {
"description": "Maximum number of 4-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"type": [
"string",
"null"
]
}
},
{
"description": "Maximum number of 5-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"in": "query",
"name": "star_5_limit",
"required": false,
"schema": {
"description": "Maximum number of 5-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
"type": [
"string",
"null"
]
}
},
{
"description": "Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. published_at sorts newest reviews first; the response exposes date_text rather than a same-named field. helpful_count sorts by helpful votes in descending order.",
"in": "query",
"name": "sort_by",
"required": false,
"schema": {
"description": "Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. published_at sorts newest reviews first; the response exposes date_text rather than a same-named field. helpful_count sorts by helpful votes in descending order.",
"enum": [
"helpful_count",
"published_at"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Review scope: all variants or current_variant only.",
"in": "query",
"name": "format_type",
"required": false,
"schema": {
"description": "Review scope: all variants or current_variant only.",
"enum": [
"all",
"current_variant"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Reviewer filter: all reviewers or verified_purchase only.",
"in": "query",
"name": "reviewer_type",
"required": false,
"schema": {
"description": "Reviewer filter: all reviewers or verified_purchase only.",
"enum": [
"all",
"verified_purchase"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Review content filter: all or with_media (images or videos).",
"in": "query",
"name": "media_type",
"required": false,
"schema": {
"description": "Review content filter: all or with_media (images or videos).",
"enum": [
"all",
"with_media"
],
"type": [
"string",
"null"
]
}
},
{
"description": "Search keywords.",
"in": "query",
"name": "q",
"required": false,
"schema": {
"description": "Search keywords.",
"type": [
"string",
"null"
]
}
},
{
"description": "Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.",
"explode": false,
"in": "query",
"name": "fields",
"required": false,
"schema": {
"description": "Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.",
"items": {
"enum": [
"date_text",
"helpful_count",
"rating_score",
"relation.listing_id",
"review_country",
"reviewer_name",
"text",
"title",
"variation_attributes",
"verified_purchase",
"vine"
],
"type": "string"
},
"type": [
"array",
"null"
]
},
"style": "form"
},
{
"description": "compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.",
"in": "query",
"name": "provenance",
"required": false,
"schema": {
"default": "compact",
"description": "compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.",
"enum": [
"compact",
"full"
],
"type": [
"string",
"null"
]
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cache_hit_share_bps": 10000,
"customer_micros_usd": 250000,
"customer_pricing_ref": "commerce.amazon.listing_reviews.query.v1.pricing@1",
"description": "Charged once per delivered read: an entity with at least one requested field, or one page of a result set. A read that delivers nothing is not charged. A read answered from stored values is charged the cache-hit share of the price. Variants are priced by the route parameters they fix.",
"kind": "fixed_request"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.
Available options:
DE, GB, US Native product ID on the platform.
Query Parameters
Maximum number of 1-star reviews. If any star quota is supplied, omitted star quotas default to 0.
Maximum number of 2-star reviews. If any star quota is supplied, omitted star quotas default to 0.
Maximum number of 3-star reviews. If any star quota is supplied, omitted star quotas default to 0.
Maximum number of 4-star reviews. If any star quota is supplied, omitted star quotas default to 0.
Maximum number of 5-star reviews. If any star quota is supplied, omitted star quotas default to 0.
Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. published_at sorts newest reviews first; the response exposes date_text rather than a same-named field. helpful_count sorts by helpful votes in descending order.
Available options:
helpful_count, published_at Review scope: all variants or current_variant only.
Available options:
all, current_variant Reviewer filter: all reviewers or verified_purchase only.
Available options:
all, verified_purchase Review content filter: all or with_media (images or videos).
Available options:
all, with_media Search keywords.
Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.
Available options:
date_text, helpful_count, rating_score, relation.listing_id, review_country, reviewer_name, text, title, variation_attributes, verified_purchase, vine compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.
Available options:
compact, full