https://api.nexscope.ai/walmart/searchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/walmart/search |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | optional | Search keyword, maximum length 1024 characters; provide at least one with `categoryId`. |
categoryId | string | optional | Category ID, provide at least one with `keyword`; `0` means all departments, for example `976759_976787`. |
sort | string | optional | Sort by: `price_low` (price from low to high), `price_high` (price from high to low), `best_seller` (best selling), `best_match` (best match). Uses default relevance ordering when not specified. |
page | integer | optional | Pagination page number, the maximum value is `100`. Example: 1 |
minPrice | number | optional | lowest price. |
maxPrice | number | optional | Highest price. |
spelling | boolean | optional | Whether to enable spelling correction. Example: true |
softSort | boolean | optional | Whether to sort by relevance; set to `false` to disable. Example: true |
storeId | string | optional | Store ID to filter products by a specific store. |
device | string | optional | Device type: `desktop`, `tablet`, `mobile`. Example: desktop |
nextDayEnabled | boolean | optional | Whether to display only NextDay delivery results. Example: false |
jsonRestrictor | string | optional | JSON field limiter. |
Code example
{
"keyword": "wireless earbuds",
"page": 1,
"sort": "best_seller"
}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 (30 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of records. |
products | array | optional | Product list, element fields are shown in the table below. |
columns | array | optional | Rendered columns. |
type | string | optional | Rendering style. |
costToken | integer | optional | The number of tokens consumed. |
productId | string | optional | Product ID. |
usItemId | string | optional | US product ID. |
title | string | optional | Product title. |
description | string | optional | Product description. |
price | number | optional | current price. |
wasPrice | number | optional | Original price. |
currency | string | optional | monetary unit. |
minPrice | number | optional | lowest price. |
pricePerUnitAmount | string | optional | Unit price amount. |
pricePerUnit | string | optional | Unit price. |
rating | number | optional | Rating. |
reviews | integer | optional | Number of reviews. |
sellerName | string | optional | Seller name. |
sellerId | string | optional | Seller ID. |
imageUrl | string | optional | Product thumbnail URL. |
productPageUrl | string | optional | Product page URL. |
sponsored | boolean | optional | Whether it is a sponsored product. |
outOfStock | boolean | optional | Is it out of stock? |
freeShipping | boolean | optional | Is shipping free? |
twoDayShipping | boolean | optional | Whether to support two-day shipping. |
freeShippingWithWalmartPlus | boolean | optional | Is shipping free for Walmart Plus members? |
shippingPrice | number | optional | Shipping costs. |
multipleOptionsAvailable | boolean | optional | Are there multiple options. |
variantSwatches | array | optional | Sample list of variants; each contains `name`, `imageUrl`, `productPageUrl`, `variantFieldId`. |
sourceType | string | optional | Source type: `walmart`. |
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.