Nexscope

Walmart Intelligence ST: walmart/product Analysis API

Use Walmart Intelligence ST: walmart/product Analysis API through Nexscope with documented parameters, structured results and API key authentication.

CostRecent Avg. 14 · Range 13–25 credits / call
Try online
POST · https://api.nexscope.ai/st/walmart/productAnalysisMCP · nexscope_data_st_walmart_product_analysis
Walmart Intelligence ST

What this API does

Use Walmart Intelligence ST: walmart/product Analysis API through Nexscope with documented parameters, structured results and API key authentication. The request accepts operation, name, productId, queryDate, queryEndDate. Its documented result includes errcode, errmsg, requestConsumed, costCredit, sourceType, searchByName, detail, trend.

Walmart Intelligence ST: walmart/product Analysis API API use cases

Inspect a candidate product

To inspect a candidate product, a marketplace analyst submits operation and name to Walmart Intelligence ST: walmart/product Analysis API. The returned errcode, errmsg, requestConsumed help inspect the documented attributes of the candidate product.

Compare listing details

A marketplace analyst uses Walmart Intelligence ST: walmart/product Analysis API with operation and name to compare listing details. The returned errcode, errmsg, requestConsumed help compare product details with another shortlisted listing.

Prepare product evidence for a sourcing review

For this workflow, a marketplace analyst calls Walmart Intelligence ST: walmart/product Analysis API with operation and name to prepare product evidence for a sourcing review. The result helps record product facts before a sourcing discussion.

Walmart Intelligence ST: walmart/product Analysis API API FAQ

What does the Walmart Intelligence ST: walmart/product Analysis API API return?

Use Walmart Intelligence ST: walmart/product Analysis API through Nexscope with documented parameters, structured results and API key authentication. The documented output includes errcode, errmsg, requestConsumed, costCredit, sourceType, searchByName, detail, trend. It corresponds to the supplied operation, name, productId, queryDate, queryEndDate. Optional fields can be absent; a missing value should not be interpreted as a measured zero. Example values illustrate the response shape, rather than live account results.

How many credits does the Walmart Intelligence ST: walmart/product Analysis API API cost?

The current documented cost is Recent Avg. 14 · Range 13–25 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the Walmart Intelligence ST: walmart/product Analysis API API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/st/walmart/productAnalysis with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_data_st_walmart_product_analysis. The same documented request parameters apply; use Online test to review a request before adding it to your app.

View plans and creditsConnect this API with MCP

Try this API
Endpoint
https://api.nexscope.ai/st/walmart/productAnalysis
MCP method
nexscope_data_st_walmart_product_analysis

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx
Missing or invalid API keys return an authentication error. Manage keys from .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/st/walmart/productAnalysis

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/st/walmart/productAnalysis' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "operation": "detail",
  "productId": "5169493923"
}'

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

CodeDescription
200HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI execution or upstream service failed.
All categories/ Walmart Intelligence ST
POSThttps://api.nexscope.ai/st/walmart/productAnalysis

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/st/walmart/productAnalysis
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
operationstringoptional
Required; only `searchByName`, `detail`, `trend`, `salesVolume`
namestringoptional
`searchByName` required; non-empty natural language product name
productIdstringoptional
`detail`, `trend`, `salesVolume` required; not empty Walmart ProductId
queryDatestringoptional
Start date in the format `yyyy-MM-dd`
queryEndDatestringoptional
End date, in the format of `yyyy-MM-dd`; when only the start date is given, the default is the current day
pageIndexintegeroptional
`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)

NameTypeRequiredDescription
errcodeintegeroptional
Gateway framework layer status code; `200` indicates that the request successfully entered the business response
errmsgstringoptional
Gateway framework layer status message; typically `ok` on success
codeintegeroptional
`200` indicates success
msgstringoptional
response message
dataobjectoptional
Fixed response container; `data.value` retains each operation's ST primitive object, array, scalar, or `null`
operationstringoptional
`searchByName`, `detail`, `trend` or `salesVolume` actually executed this time
requestConsumedintegeroptional
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
costTimeintegeroptional
Time taken, unit is milliseconds
costTokeninteger / absentoptional
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.
costCreditinteger / absentoptional
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
sourceTypestringoptional
`st`
searchByNamearray<object>optional
Related product summary array
detailobjectoptional
Single product details object
trendobjectoptional
Single product trend object
salesVolumearray<array>optional
Sales record row array; each row is `[date, sales, type]`
Titlestringoptional
Product title
Photoarray<string>optional
Product image URL array
ListingSalesVolumeOfMonthintegeroptional
Estimated sales volume in the last 30 days in the Listing dimension, without distinguishing between variants
ListingSalesOfMonthintegeroptional
Estimated sales in the past 30 days in the Listing dimension; the unit for the US site is cents
ProductIdstringoptional
Walmart ProductId
ParentProductIdstringoptional
Parent product ProductId
Priceintegeroptional
Selling price; the US site unit is cents, such as `1999` means `$19.99`
Brandstringoptional
brand
Sellerstringoptional
Seller name at the time of collection
Shipedbystringoptional
The delivery method at the time of collection; the field name is the original spelling of the upstream
WFSFeeintegeroptional
WFS fee; US site unit is cents
Attributearray<string> / nulloptional
Product attributes, interleaved encoding according to `[attribute name, attribute value, ...]`
FirstReviewsDatestring / nulloptional
Date of first comment in the format `yyyy-MM-dd`
ReviewsCountintegeroptional
Number of comments
Ratingsnumberoptional
Rating, like `4.8`
NodePatharray<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`
Labelarray<string>optional
Product tags, such as `pickup`, `savewith`, `bestsell`
PopularPickintegeroptional
Popular Pick tag; `1` indicates existence
Clearanceintegeroptional
Clearance tag; `1` indicates existence
ReducedPriceintegeroptional
Reduced Price tag; `1` indicates existence
Rollbackintegeroptional
Rollback token; `1` indicates existence
FlashDealintegeroptional
Flash Deal tag; `1` indicates existence
Sizearray<string> / nulloptional
Outer packaging size `[longest side, second longest side, shortest side]`, unit is cm
Weightnumberoptional
Product weight in grams
Variantsarray / nulloptional
Variant data; `searchByName` is encoded differently than `detail`, see below
NumberOfStararray<number\|string> / nulloptional
The number of reviews for each star rating, according to `[star rating, number of reviews, ...]` staggered coding
Pickupintegeroptional
Detail extension: Pickup tag mark; `1` indicates existence
Savewithintegeroptional
Detail extension: Save with label mark; `1` indicates existence
Bestsellerintegeroptional
Detail extension: Best Seller tag; `1` indicates existence
UpdateDatestring / nulloptional
Detail extension: product data update time, usually `yyyy-MM-dd`
VariantIdstringoptional
Variant ProductId
Urlstringoptional
Variant product URL
Propertyarray<string>optional
Variant attributes, encoded by `[attribute name, attribute value, ...]`
PriceUpdatestring / nulloptional
Price update time, usually `yyyy-MM-dd`
DetailUpdatestring / nulloptional
Details update time, usually `yyyy-MM-dd`; when there is no valid date, upstream placeholders such as `--` may be used
ProductIdstringoptional
Walmart ProductId
ListingSalesVolumeOfMonthintegeroptional
Estimated sales volume of the current Listing dimension in the past 30 days
ListingSalesOfMonthintegeroptional
Estimated sales of the current Listing dimension in the past 30 days; the unit for the US site is cents
ListingSalesVolumeOfMonthTrendarray<string>optional
Monthly sales history, coded by `[yyyy-MM-dd, sales volume, ...]`
ListingSalesOfMonthTrendarray<string>optional
Monthly sales history, coded by `[yyyy-MM-dd, sales, ...]`; amount unit is cents
PriceTrendarray<string>optional
Price history, encoded by `[yyyy-MM-dd, price, ...]`; amounts are in cents
ReviewsTrendarray<string>optional
Comment count history, encoded by `[yyyy-MM-dd, comment count, ...]`
StarTrendarray<string>optional
Rating history, encoded as `[yyyy-MM-dd, rating, ...]`; current response example value is `5.00`
RankTrendarray<array<string>>optional
Ranking history of each category; each row is encoded by `[category name, NodeId, date, ranking, date, ranking, ...]`

Responses

CodeDescription
200HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI 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.

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json
Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_data_st_walmart_product_analysis",
    "arguments": {
      "operation": "detail",
      "productId": "5169493923"
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /mcp/legacy

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

At least 10 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint
/st/walmart/productAnalysis
MCP method
nexscope_data_st_walmart_product_analysis
cURL
curl -X POST \
  https://api.nexscope.ai/st/walmart/productAnalysis \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "operation": "detail", "productId": "5169493923" }'
Response
No response yet. Run the request to see the response here.

Related APIs