Walmart Search API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector

Amazon Marketplace Intelligence

API overview

Search and browse Walmart product listings by keyword, category, price range, and other conditions.

Try this API

Endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/walmart-search/run

MCP method

nexscope_walmart_search

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 .

POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/walmart-search/run

Run an API

Request parameters documented by ecommerce.walmart-search.

Slug	`walmart-search`
Headers	`Authorization: Bearer nk_...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Direct API response payload. No data/result wrapper is added.

Status codes

Code	Description
200	API executed successfully. Body is the direct response payload.
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.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/walmart-search/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "keyword": "phone case",   "spelling": true,   "page": 1 }'

All categories/ Amazon Marketplace Intelligence

POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/walmart-search/run

Run this API

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

Open tester

Endpoint

Method	`POST`
Path	`https://claw-callback.nexscope.ai/api/skill-api/v1/skills/walmart-search/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`keyword`	`string`	optional	Search keyword, max length 1024 characters. *At least one of keyword and categoryId must be provided Example: phone case
`categoryId`	`string`	optional	Category ID. *At least one of keyword and categoryId must be provided. 0 means all departments. For example: 976759_976787 means "Cookies" Example: 976759_976787
`sort`	`string`	optional	Sort method. Options: price_low (price low to high), price_high (price high to low), best_seller (best seller), best_match (best match)
`page`	`integer`	optional	Page number for pagination, default 1, max 100 Example: 1
`minPrice`	`number`	optional	Minimum price Example: 1
`maxPrice`	`number`	optional	Maximum price Example: 1
`spelling`	`boolean`	optional	Enable spelling correction, default true. true includes spelling correction, false excludes it Example: false
`softSort`	`boolean`	optional	Sort by relevance, default true. Set to false to disable relevance sorting Example: false
`storeId`	`string`	optional	Store ID, used to filter products by a specific store Example: example-id
`device`	`string`	optional	Device type, default desktop. Options: desktop, tablet, mobile
`facet`	`string`	optional	Filter conditions, format as key:value pairs separated by \
`nextDayEnabled`	`boolean`	optional	Only show NextDay delivery results, default false. true to enable, false to disable Example: false
`jsonRestrictor`	`string`	optional	JSON field restrictor

Request example

{
  "keyword": "phone case",
  "spelling": true,
  "page": 1
}

Response body

Returns the documented upstream API response directly without an additional wrapper.

Name	Type	Required	Description
`total`	`integer`	optional	Record count Example: 1
`products`	`array`	optional	Product list (see product object below) Example: []
`columns`	`array`	optional	Rendered columns Example: []
`type`	`string`	optional	Render style
`costToken`	`integer`	optional	Token cost Example: 1
`products[].productId`	`string`	optional	Product ID Example: example-id
`products[].usItemId`	`string`	optional	US item ID Example: example-id
`products[].title`	`string`	optional	Title
`products[].description`	`string`	optional	Description
`products[].price`	`number`	optional	Price Example: 1
`products[].wasPrice`	`number`	optional	Original price (was_price) Example: 1
`products[].currency`	`string`	optional	Currency unit
`products[].minPrice`	`number`	optional	Minimum price Example: 1
`products[].pricePerUnitAmount`	`string`	optional	Price per unit amount
`products[].pricePerUnit`	`string`	optional	Price per unit
`products[].rating`	`number`	optional	Rating Example: 1
`products[].reviews`	`integer`	optional	Review count Example: 1
`products[].sellerName`	`string`	optional	Seller name
`products[].sellerId`	`string`	optional	Seller ID Example: example-id
`products[].imageUrl`	`string`	optional	Thumbnail Example: https://example.com/image.jpg
`products[].productPageUrl`	`string`	optional	Product page URL Example: https://example.com/image.jpg
`products[].sponsored`	`boolean`	optional	Whether a sponsored product Example: false
`products[].outOfStock`	`boolean`	optional	Whether out of stock Example: false
`products[].freeShipping`	`boolean`	optional	Whether free shipping Example: false
`products[].twoDayShipping`	`boolean`	optional	Whether two-day shipping supported Example: false
`products[].freeShippingWithWalmartPlus`	`boolean`	optional	Free shipping for Walmart Plus members Example: false
`products[].shippingPrice`	`number`	optional	Shipping cost Example: 1
`products[].multipleOptionsAvailable`	`boolean`	optional	Whether multiple options available Example: false
`products[].variantSwatches`	`array`	optional	Variant swatch list (each item contains name variant name, imageUrl variant image URL, productPageUrl variant product page URL, variantFieldId variant field ID) Example: []
`products[].sourceTool`	`string`	optional	Source tool
`products[].sourceType`	`string`	optional	Source type: walmart
`errcode`	`integer`	optional	Upstream status code returned by the provider.
`errmsg`	`string`	optional	Upstream status message returned by the provider.
`code`	`string`	optional	Provider-specific status code.
`msg`	`string`	optional	Provider-specific status message.
`message`	`string`	optional	Provider-specific message.
`title`	`string`	optional	Provider-specific response title.
`sourceType`	`string`	optional	Provider-specific source platform type.
`sourceTool`	`string`	optional	Provider-specific source tool name.
`costTime`	`integer`	optional	Execution time reported by the upstream provider.
`page`	`integer`	optional	Current page returned by the upstream provider.
`pageSize`	`integer`	optional	Page size returned by the upstream provider.
`pageItemCount`	`integer`	optional	Item count on the current page returned by the upstream provider.
`totalPage`	`integer`	optional	Total page count returned by the upstream provider.
`dataSnapshotMonth`	`string`	optional	Data snapshot month returned by the upstream provider.

Response example

Direct response payload. No extra wrapper is added.

{
  "total": 1,
  "products": [
    {
      "productId": "example-id",
      "usItemId": "example-id",
      "price": 1,
      "wasPrice": 1,
      "minPrice": 1,
      "rating": 1,
      "reviews": 1,
      "sellerId": "example-id",
      "imageUrl": "https://example.com/image.jpg",
      "productPageUrl": "https://example.com/image.jpg",
      "sponsored": false,
      "outOfStock": false,
      "freeShipping": false,
      "twoDayShipping": false,
      "freeShippingWithWalmartPlus": false,
      "shippingPrice": 1,
      "multipleOptionsAvailable": false,
      "variantSwatches": []
    }
  ],
  "columns": [],
  "costToken": 1
}

Responses

Code	Description
200	API executed successfully. Body is the direct response payload.
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.

Related APIs

Amazon Alexa Search

Initiate natural language Q&A through Amazon's storefront Alexa shopping assistant to get shopping guidance answers, recommended product groups, ASIN lists, and follow-up questions. Each call supports only 1 prompt; for follow-ups, the agent must summarize context and concatenate a new question for a new request. A url can be used to supplement Amazon page context.

Amazon Asin Traffic Summary

Use SIF (Search Intelligence Framework) data to analyze ASIN traffic source composition and exposure distribution, covering current period/previous period/newly entered/exited period comparisons.

Amazon Broad Product Search

Use SellerSprite data to search and filter Amazon products, supporting multi-dimensional criteria including price, monthly sales, BSR ranking, gross margin, ratings, fulfillment method, badges, seller origin, and more across multiple Amazon marketplaces.

Amazon Competitor Lookup

Use SellerSprite data to find and analyze competitors on Amazon, covering 12 marketplaces, with product metrics including sales, BSR, pricing, ratings, and growth trends.

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp

POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_walmart_search",
    "arguments": {
      "keyword": "phone case",
      "spelling": true,
      "page": 1
    }
  }
}

Online test

Execute the current API with your API key and JSON payload.

Try it

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

Endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/walmart-search/run

MCP method

nexscope_walmart_search

API key*JSON payload*

cURL

curl -X POST \
  https://claw-callback.nexscope.ai/api/skill-api/v1/skills/walmart-search/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "phone case", "spelling": true, "page": 1 }'

Response

No response yet. Run the request to see the response here.