POST
https://api.nexscope.ai/api/skill-api/v1/skills/walmart-product-detail/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/walmart-product-detail/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
productId | integer | required | Product ID (ItemId), the numeric ID contained in the product detail link. For example: the 5169493923 in https://www.walmart.com/ip/5169493923 Example: 5169493923 |
includeStats | boolean | optional | Whether to include historical price/historical sales, default true Example: false |
Request example
{
"productId": "5169493923",
"includeStats": false
}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 | Number of products returned (typically 1 for this endpoint) Example: 1 |
data.products | array | optional | Product list (see product object below) Example: [] |
data.columns | array | optional | Column definitions (metadata describing each field in products, including field, title, cellType, etc.) Example: [] |
data.type | string | optional | Response render type (fixed value "productWorkbenches") Example: null |
data.costTime | integer | optional | API elapsed time (milliseconds) Example: 1 |
data.costToken | integer | optional | Token cost Example: 1 |
data.products[].usItemId | integer | optional | Internal product ID (same as the requested productId) Example: 1 |
data.products[].productId | string | optional | Walmart product unique identifier (alphanumeric, e.g., "6YBM50F6ZXAE") Example: example-id |
data.products[].title | string | optional | Product name Example: null |
data.products[].description | string | optional | Product description Example: null |
data.products[].price | number | optional | Current selling price (USD) Example: 1 |
data.products[].wasPrice | number | optional | Striketrough price (USD), may be null when no discount Example: 1 |
data.products[].minPrice | number | optional | Minimum price (USD) Example: 1 |
data.products[].brand | string | optional | Brand name Example: null |
data.products[].rating | number | optional | Product rating (0.0-5.0) Example: 1 |
data.products[].reviews | integer | optional | Review count Example: 1 |
data.products[].salesEstimate | integer | optional | Sales estimate (units, in recent period) Example: 1 |
data.products[].revenue | number | optional | Revenue estimate (USD) Example: 1 |
data.products[].sellerName | string | optional | Seller name Example: null |
data.products[].fulfillmentType | string | optional | Fulfillment type: "MARKETPLACE" (third-party seller self-fulfilled) or "WFS" (Walmart Fulfillment Services) Example: null |
data.products[].productPageUrl | string | optional | Product page URL Example: https://example.com/image.jpg |
data.products[].imageUrl | string | optional | Product image URL (thumbnail) Example: https://example.com/image.jpg |
data.products[].departmentName | string | optional | Department name (e.g., "Cell Phones") Example: null |
data.products[].departmentId | integer | optional | Department ID Example: 1 |
data.products[].listingScore | integer | optional | Listing quality score Example: 1 |
data.products[].contentScore | integer | optional | Content quality score Example: 1 |
data.products[].outOfStock | integer | optional | Whether out of stock (0=in stock, 1=out of stock) Example: 1 |
data.products[].sponsored | integer | optional | Whether a sponsored product (0=no, 1=yes) Example: 1 |
data.products[].isBranded | integer | optional | Whether a branded product (0=no, 1=yes) Example: 1 |
data.products[].multipleOptionsAvailable | integer | optional | Whether there are variants (0=no, 1=yes) Example: 1 |
data.products[].createdAt | string | optional | First indexed time by WallySmarter (format: yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z') Example: null |
data.products[].updatedAt | string | optional | Most recent data update time (same format as above) Example: 2026-01-01 |
data.products[].stats | object | optional | Historical statistics (only returned when includeStats=true, otherwise null. See structure below) Example: {} |
data.products[].sourceTool | string | optional | Source tool identifier Example: null |
data.products[].sourceType | string | optional | Product source platform (fixed value "walmart") Example: null |
data.stats.price | array | optional | Historical selling price time series (sorted by date ascending). Each item is a single date-price mapping Example: [] |
data.stats.sales | array | optional | Historical sales time series (sorted by date ascending). Each item is a single date-sales mapping Example: [] |
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.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": [
{
"usItemId": 1,
"productId": "example-id",
"price": 1,
"wasPrice": 1,
"minPrice": 1,
"rating": 1,
"reviews": 1,
"salesEstimate": 1,
"revenue": 1,
"productPageUrl": "https://example.com/image.jpg",
"imageUrl": "https://example.com/image.jpg",
"departmentId": 1,
"listingScore": 1,
"contentScore": 1,
"outOfStock": 1,
"sponsored": 1,
"isBranded": 1,
"multipleOptionsAvailable": 1,
"updatedAt": "2026-01-01",
"stats": {}
}
],
"columns": [],
"costTime": 1,
"costToken": 1,
"stats": {
"price": [],
"sales": []
}
},
"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.