Walmart Search API

REST API and MCP service documentation generated from server-side API definitions. Responses use the shared code, msg, and data envelope.

API selector

Walmart Marketplace Intelligence

API overview

Search Walmart product listings by keyword, category, price range, and other filters. Review request and response fields.

Try this API

Endpoint

https://api.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://api.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	Platform envelope: code, msg, data, ts, time, cost, traceId. Inspect data.status for asynchronous completion.

Status codes

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.

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 '{   "spelling": true,   "keyword": "phone case",   "page": 1 }'

All categories/ Walmart Marketplace Intelligence

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

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

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

Response body

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`	`string`	required	Elapsed milliseconds, never credits; -1 outside web requests.
`traceId`	`string \| null`	required	Trace id value used by this API operation.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data`	`null`	required	Data value used by this API operation.

Response example

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

{
  "data": {
    "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
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

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.

Related APIs

Walmart Category Market API

Research Walmart category trees, search category names, and retrieve category market reports through three governed read-only operations.

Walmart Keyword Research API

Research Walmart keyword markets, matching products, keyword details, related terms, product keywords, and saved dictionaries safely.

Walmart Product Analysis API

Analyze Walmart products, detail records, performance trends, and dated sales volume while preserving long product identifiers as strings.

Walmart Product Detail API

Query Walmart product details through WallySmarter, including pricing history and sales trends. View request parameters, response fields, and MCP usage.

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": {
      "spelling": true,
      "keyword": "phone case",
      "page": 1
    }
  }
}

Online test

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

21 credits / callAPI usage records

Try it

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

Endpoint

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

MCP method

nexscope_walmart_search

API key*

JSON payload*

cURL

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

Response

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