Walmart Rating Summary API
Collect aggregate ratings, counts and star distributions for Walmart products.
API Description
Walmart Rating Summary API Collect aggregate ratings, counts and star distributions for Walmart products.
Request URL
Request Headers
| Parameters | Parameter value | Type | Description |
|---|---|---|---|
| Content-Type | application/json | string | Data format |
| Authorization | Bearer xxx | string | Authorization Token |
Collection timeout: 90 seconds. Allow at least 105 seconds in your client.
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| country | Yes | string | Storefront country code. Values: [“CA”, “US”] |
| productId | No | string | Product ID as a string; supply productId or productUrl. |
| productUrl | No | string | Product URL on a configured storefront; alternative to productId. Maximum length: 2048 |
| allowStale | No | boolean | Defaults to false; true permits stale cache on failure, identified in meta. |
| refresh | No | boolean | Defaults to false; true bypasses fresh cache. |
Supply at least one of productId or productUrl. Product IDs must be strings.
Supported storefronts: US、CA。
Returns product-level rating statistics without pagination.
Response Fields
| Field | Type | Description |
|---|---|---|
| code | integer | Status code; 0 indicates success. |
| message | string | Response message; ok on success. |
| pointCost | number | Points charged for the complete response. |
| data | object | null | Collected data, described below. |
data Fields
| Field | Type | Description |
|---|---|---|
| country | string | Storefront country, not the review author’s country. |
| productId | string | Product ID, returned as a string. |
| meta | object | Collection status and cache metadata. |
| warnings | string[] | Collection scope and data interpretation notes. |
| capturedAt | string | Collection timestamp. |
| productSummary | object | null | Upstream product/review-group aggregate; never calculated from a partial page. |
| platform | string | Platform identifier. |
data.meta Fields
| Field | Type | Description |
|---|---|---|
| supplementalAttempts | integer | supplementalAttempts |
| reviewPage | object | reviewPage |
| status | string | Collection completion status. |
data.meta.reviewPage Fields
| Field | Type | Description |
|---|---|---|
| cache | string | cache |
| stale | boolean | stale |
| ageSeconds | integer | ageSeconds |
| upstreamAttempts | integer | upstreamAttempts |
| coalesced | boolean | coalesced |
data.productSummary Fields
| Field | Type | Description |
|---|---|---|
| averageRating | number | null | Aggregate average rating. Minimum: 0 Maximum: 5 |
| totalCount | integer | Platform total, interpreted using countKind. Minimum: 0 |
| countKind | any | Count semantics, distinguishing all ratings from text reviews. Values: [“platform_review_total”, “ratings”, “reviews_including_ratings_only”] |
| reviewCount | integer | null | Review count; null when unavailable. Minimum: 0 |
| withTextCount | integer | null | Text review count; null when unavailable. Minimum: 0 |
| starDistribution | object | null | Counts for ratings from 1 to 5 stars. |
| source | string | Source of the aggregate statistics. |
| scope | any | Scope covered by the aggregate. Values: [“upstream_product_or_review_group”] |
| warnings | string[] | Collection scope and data interpretation notes. |
data.productSummary.starDistribution Fields
| Field | Type | Description |
|---|---|---|
| 1 | integer | 1 Minimum: 0 |
| 2 | integer | 2 Minimum: 0 |
| 3 | integer | 3 Minimum: 0 |
| 4 | integer | 4 Minimum: 0 |
| 5 | integer | 5 Minimum: 0 |
Rating and text-review totals may use different count semantics. Interpret them using countKind, scope and source; unavailable values remain null.
Errors retain the response envelope and data.error. Codes: invalid parameters 1002, rate limit 4029, busy 5001, collection failure 9200. HTTP 503 cooldown responses retain Retry-After.
Request Example
Response Example
This excerpt retains the first list item and shortens long text and URLs. pointCost is the charge for the complete response.
Points Usage
0.8 points per rating summary.
Each successful call is billed independently, including cached responses. Errors and empty lists cost zero; pointCost reports the charge.

