https://api.nexscope.ai/st/walmart/productAnalysisRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/st/walmart/productAnalysis |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | optional | Required; only `searchByName`, `detail`, `trend`, `salesVolume` |
name | string | optional | `searchByName` required; non-empty natural language product name |
productId | string | optional | `detail`, `trend`, `salesVolume` required; not empty Walmart ProductId |
queryDate | string | optional | Start date in the format `yyyy-MM-dd` |
queryEndDate | string | optional | End date, in the format of `yyyy-MM-dd`; when only the start date is given, the default is the current day |
pageIndex | integer | optional | `searchByName`, `salesVolume` starts from 1, defaults to 1; maximum 100 items per page |
Code example
{
"operation": "detail",
"productId": "5169493923"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
Response field reference (59 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Gateway framework layer status code; `200` indicates that the request successfully entered the business response |
errmsg | string | optional | Gateway framework layer status message; typically `ok` on success |
code | integer | optional | `200` indicates success |
msg | string | optional | response message |
data | object | optional | Fixed response container; `data.value` retains each operation's ST primitive object, array, scalar, or `null` |
operation | string | optional | `searchByName`, `detail`, `trend` or `salesVolume` actually executed this time |
requestConsumed | integer | optional | This upstream consumption; when the upstream is missing or returns 0, it is completed according to the document consumption of the operation; when ST explicitly returns `Code=11` (no data), it remains 0 |
costTime | integer | optional | Time taken, unit is milliseconds |
costToken | integer / absent | optional | Production gateway response header `X-Cost-Token`; the entry script will be copied to this field, and this field is currently missing when parsing the JSON body directly. |
costCredit | integer / absent | optional | Production gateway response header `X-Cost-Credit`, which is the actual computing power deducted this time; the entry script will be copied to this field |
sourceType | string | optional | `st` |
searchByName | array<object> | optional | Related product summary array |
detail | object | optional | Single product details object |
trend | object | optional | Single product trend object |
salesVolume | array<array> | optional | Sales record row array; each row is `[date, sales, type]` |
Title | string | optional | Product title |
Photo | array<string> | optional | Product image URL array |
ListingSalesVolumeOfMonth | integer | optional | Estimated sales volume in the last 30 days in the Listing dimension, without distinguishing between variants |
ListingSalesOfMonth | integer | optional | Estimated sales in the past 30 days in the Listing dimension; the unit for the US site is cents |
ProductId | string | optional | Walmart ProductId |
ParentProductId | string | optional | Parent product ProductId |
Price | integer | optional | Selling price; the US site unit is cents, such as `1999` means `$19.99` |
Brand | string | optional | brand |
Seller | string | optional | Seller name at the time of collection |
Shipedby | string | optional | The delivery method at the time of collection; the field name is the original spelling of the upstream |
WFSFee | integer | optional | WFS fee; US site unit is cents |
Attribute | array<string> / null | optional | Product attributes, interleaved encoding according to `[attribute name, attribute value, ...]` |
FirstReviewsDate | string / null | optional | Date of first comment in the format `yyyy-MM-dd` |
ReviewsCount | integer | optional | Number of comments |
Ratings | number | optional | Rating, like `4.8` |
NodePath | array<string\|null> | optional | Category and ranking records are grouped and coded according to `[category name, NodeId, ranking date, ranking, ...]`; when the ranking on a certain day is missing, the corresponding position is `null` |
Label | array<string> | optional | Product tags, such as `pickup`, `savewith`, `bestsell` |
PopularPick | integer | optional | Popular Pick tag; `1` indicates existence |
Clearance | integer | optional | Clearance tag; `1` indicates existence |
ReducedPrice | integer | optional | Reduced Price tag; `1` indicates existence |
Rollback | integer | optional | Rollback token; `1` indicates existence |
FlashDeal | integer | optional | Flash Deal tag; `1` indicates existence |
Size | array<string> / null | optional | Outer packaging size `[longest side, second longest side, shortest side]`, unit is cm |
Weight | number | optional | Product weight in grams |
Variants | array / null | optional | Variant data; `searchByName` is encoded differently than `detail`, see below |
NumberOfStar | array<number\|string> / null | optional | The number of reviews for each star rating, according to `[star rating, number of reviews, ...]` staggered coding |
Pickup | integer | optional | Detail extension: Pickup tag mark; `1` indicates existence |
Savewith | integer | optional | Detail extension: Save with label mark; `1` indicates existence |
Bestseller | integer | optional | Detail extension: Best Seller tag; `1` indicates existence |
UpdateDate | string / null | optional | Detail extension: product data update time, usually `yyyy-MM-dd` |
VariantId | string | optional | Variant ProductId |
Url | string | optional | Variant product URL |
Property | array<string> | optional | Variant attributes, encoded by `[attribute name, attribute value, ...]` |
PriceUpdate | string / null | optional | Price update time, usually `yyyy-MM-dd` |
DetailUpdate | string / null | optional | Details update time, usually `yyyy-MM-dd`; when there is no valid date, upstream placeholders such as `--` may be used |
ProductId | string | optional | Walmart ProductId |
ListingSalesVolumeOfMonth | integer | optional | Estimated sales volume of the current Listing dimension in the past 30 days |
ListingSalesOfMonth | integer | optional | Estimated sales of the current Listing dimension in the past 30 days; the unit for the US site is cents |
ListingSalesVolumeOfMonthTrend | array<string> | optional | Monthly sales history, coded by `[yyyy-MM-dd, sales volume, ...]` |
ListingSalesOfMonthTrend | array<string> | optional | Monthly sales history, coded by `[yyyy-MM-dd, sales, ...]`; amount unit is cents |
PriceTrend | array<string> | optional | Price history, encoded by `[yyyy-MM-dd, price, ...]`; amounts are in cents |
ReviewsTrend | array<string> | optional | Comment count history, encoded by `[yyyy-MM-dd, comment count, ...]` |
StarTrend | array<string> | optional | Rating history, encoded as `[yyyy-MM-dd, rating, ...]`; current response example value is `5.00` |
RankTrend | array<array<string>> | optional | Ranking history of each category; each row is encoded by `[category name, NodeId, date, ranking, date, ranking, ...]` |
Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.