Walmart Product Analysis

Analyze Walmart products, detail records, performance trends, and dated sales volume. Results come back as structured JSON. Call it via REST API or MCP.

CostRecent Avg. 14 · Range 10–25 credits / call

Try online

POST · https://api.nexscope.ai/st/walmart/productAnalysisMCP · nexscope_walmart_product_analysis

What this API does

Analyze Walmart products, detail records, performance trends, and dated sales volume. Results come back as structured JSON. The request accepts operation, name, productId, queryDate, queryEndDate. Its documented result includes errcode, errmsg, requestConsumed, costCredit, sourceType, searchByName, detail, trend.

Walmart Product Analysis API use cases

Inspect a candidate product

To inspect a candidate product, a marketplace analyst submits operation and name to Walmart Product Analysis. The returned errcode, errmsg, requestConsumed help inspect the documented attributes of the candidate product.

Compare listing details

A marketplace analyst uses Walmart Product Analysis 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 Product Analysis with operation and name to prepare product evidence for a sourcing review. The result helps record product facts before a sourcing discussion.

Walmart Product Analysis API FAQ

What does the Walmart Product Analysis API return?

Analyze Walmart products, detail records, performance trends, and dated sales volume. Results come back as structured JSON. 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 Product Analysis API cost?

The current documented cost is Recent Avg. 14 · Range 10–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 Product Analysis 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_walmart_product_analysis. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

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

MCP method

nexscope_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"
}'

Code example

{
  "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

Code	Description
200	Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429	Execution admission rate limit; honor Retry-After when present.
503	Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-in	X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.

View parameters & response Try online

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.

Open tester

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

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

No response example is published for this API. Refer to the response fields below.

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	Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429	Execution admission rate limit; honor Retry-After when present.
503	Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-in	X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses.

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_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

Data Example

Request parameters

{
  "operation": "detail",
  "productId": "546427139"
}

Response

{
  "code": 0,
  "msg": null,
  "data": {
    "data": {
      "value": {
        "ListingSalesOfMonth": 0,
        "Shipedby": "自发货",
        "Savewith": 0,
        "Attribute": [
          "Hair type",
          "All Hair Types",
          "Brand",
          "Aquage",
          "Hair care key benefits",
          "Strengthening & Split End Repair, Cleansing, Moisturizing",
          "Primary ingredient",
          "Glycerin",
          "Scent",
          "Aquage",
          "Size",
          "16 fl oz",
          "Shampoo & conditioner type",
          "Conditioners",
          "Hair product form",
          "Creams",
          "Container type",
          "Bottle",
          "Active ingredients",
          "Glycerin",
          "Instructions",
          "Cleanse with Aquage Strengthening Shampoo. Apply Strengthening Conditioner. Gently comb through and rinse.",
          "Product net content uom",
          "Fluid Ounces",
          "Product net content parent",
          "16 Fluid Ounces",
          "Age group",
          "Adult",
          "Gender",
          "Female",
          "Count per pack",
          "1",
          "Inactive ingredients",
          "Water/Aqua/Eau, Myristyl Alcohol, Propylene Glycol, Cetearyl Alcohol, Cetrimonium Chloride*, Hippophae Rhamnoides (Sea Buckthorn/Argousier) Fruit/Seed Oil, Borago Officinalis (Borage/Bourrache) Seed Oil, Mangifera Indica (Mango/Mangue) Seed Butter, Butyrospermum Parkii (Shea/Karite) Butter, Hydroxypropyl Guar Hydroxypropyltrimonium Chloride, Aloe Barbadensis Leaf Juice, Glycerin, Hydrolyzed Quinoa, Aminomethyl Propanol, Bis-PCA Dimethicone, Butylene Glycol, C11-15 Pareth-7, C12-16 Pareth-9, Caprylyl Glycol, Decyl Oleate, Disodium PEG-12 Dimethicone Sulfosuccinate, Trideceth-12, Trimethylsiloxyamodimethicone, Citric Acid, Etidronic Acid, Lauryl Alcohol, Hydrogenated Palm Glycerides Citrate, Phenoxyethanol, Potassium Sorbate, Sodium Benzoate, Cetyl Alcohol, Benzyl Alcohol, Tocopherol, Fragrance/Parfum, Hydroxycitronellal, Limonene, Ext. Violet 2 (CI 60730) *antistatic agent/agent antistatique"
        ],
        "FirstReviewsDate": null,
        "Size": null,
        "PopularPick": 0,
        "Label": [],
        "ReducedPrice": 0,
        "Photo": [
          "https://i5.walmartimages.com/seo/Aquage-SeaExtend-Strengthening-Conditioner-16-oz_d3a31b9b-0bbe-49c1-af75-cd3ed55f8788.b8b5b0e6b92a8bb489db501d1d11c211.jpeg",
          "https://i5.walmartimages.com/asr/14636eb9-1bab-42ec-8ccb-e45eb052ae22.ec31255e50e0ac212fd57603599c9bd3.jpeg",
          "https://i5.walmartimages.com/asr/d00485b4-2b2d-43fd-9471-bef08f91ab8f.8d0711f32aebd85f69057f70f29cede7.jpeg",
          "https://i5.walmartimages.com/asr/f50d7eba-663f-4139-a6e8-5ada6d3a085c.e352eef32b49c9944a3f740b206000be.jpeg",
          "https://i5.walmartimages.com/asr/2f36fd73-0f22-4cc3-bb6c-01aef6d7facf.62f2c4aca822002f3e4def0a57f66dd7.jpeg",
          "https://i5.walmartimages.com/asr/ee6ba57e-362b-4666-b496-ba34b777a0b9.0eb8ebd9753455b2d59bb641c1931728.jpeg",
          "https://i5.walmartimages.com/asr/35533f6e-3f31-4d24-bc3d-5f6d7e5afcd3.2ee717878eb67eae9e553c639a19d1b0.jpeg",
          "https://i5.walmartimages.com/asr/fb4b6934-ab8d-4138-ad7d-755439b1947c.f1d6a59197ee32356f54f7524ed00b10.jpeg"
        ],
        "ProductId": "546427139",
        "Clearance": 0,
        "Ratings": 4.7,
        "UpdateDate": null,
        "FlashDeal": 0,
        "ParentProductId": "546427139",
        "Rollback": 0,
        "NumberOfStar": [
          1,
          1,
          2,
          1,
          3,
          0,
          4,
          4,
          5,
          28
        ],
        "ReviewsCount": 34,
        "Pickup": 0,
        "Title": "Aquage SeaExtend Strengthening Conditioner 16 oz",
        "Bestseller": 0,
        "NodePath": [
          "Premium Conditioners in Beauty",
          "1085666_3020074",
          "2026-09-30",
          "195",
          "Premium Conditioners in Beauty",
          "1085666_3020074",
          "2026-10-01",
          null,
          "Premium Conditioners in Beauty",
          "1085666_3020074",
          "2026-10-02",
          "119",
          "Premium Conditioners in Beauty",
          "1085666_3020074",
          "2026-10-03",
          null,
          "Premium Conditioners in Beauty",
          "1085666_3020074",
          "2026-10-04",
          "131",
          "Premium Conditioners in Beauty",
          "1085666_3020074",
          "2026-10-05",
          "112"
        ],
        "Weight": 0,
        "Brand": "Aquage",
        "Variants": [
          "546427139",
          " https://www.walmart.com/ip/Aquage-SeaExtend-Strengthening-Conditioner-16-oz/546427139",
          [
            "Size",
            "16 fl oz"
          ]
        ],
        "WFSFee": 0,
        "Price": 3030,
        "ListingSalesVolumeOfMonth": 0,
        "Seller": "Beautyvice"
      }
    },
    "costTime": 962,
    "sourceType": "sorftime",
    "operation": "detail",
    "requestConsumed": 1
  }
}

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.

Recent Avg. 14 · Range 10–25 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_walmart_product_analysis

API key*

JSON payload*

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

Walmart Category Market

Find Walmart categories and review category market reports.

Walmart Keyword Research

Research Walmart keywords and the products associated with them.