https://api.nexscope.ai/ws/productDetailRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ws/productDetail |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
productId | integer | required | Item ID (Item ID), the numeric ID contained in the product details link, such as `5169493923` in `https://www.walmart.com/ip/5169493923`. |
includeStats | boolean | optional | Whether to include historical price and historical sales data. Example: true |
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 (38 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | Return code; `"200"` indicates success. |
msg | string | optional | Message; `"ok"` on success, error description on failure. |
total | integer | optional | The quantity of goods returned is usually 1 for this interface. |
products | array | optional | Product list, element fields are shown in the table below. |
columns | array | optional | Column definition, describing the meta information of each field in `products`, including `field`, `title`, `cellType`, etc. |
type | string | optional | Response rendering type, fixed value is `"productWorkbenches"`. |
costTime | integer | optional | API latency in milliseconds |
costToken | integer | optional | The number of tokens consumed. |
usItemId | integer | optional | The product internal ID, which is `productId` in the request. |
productId | string | optional | A unique identifier for the Walmart product, which may be an alphanumeric string. |
title | string | optional | Product name. |
description | string | optional | Product description. |
price | number | optional | Current selling price in US dollars. |
wasPrice | number/null | optional | Strikethrough price in USD; may be `null` without discount. |
minPrice | number | optional | Lowest price in USD. |
brand | string | optional | Brand name. |
rating | number | optional | Product rating, ranging from 0.0–5.0. |
reviews | integer | optional | Number of comments. |
salesEstimate | integer | optional | Sales volume estimate for the recent cycle, in units. |
revenue | number | optional | Revenue estimates in U.S. dollars. |
sellerName | string | optional | Seller name. |
fulfillmentType | string | optional | Shipping type: `MARKETPLACE` (fulfilled by third-party seller) or `WFS` (Walmart Fulfillment Services). |
productPageUrl | string | optional | Product page URL. |
imageUrl | string | optional | Product image URL (thumbnail). |
departmentName | string | optional | The name of the department you belong to. |
departmentId | integer | optional | Department ID. |
listingScore | integer | optional | Listing quality score. |
contentScore | integer | optional | Content quality points. |
outOfStock | integer | optional | Whether it is out of stock: `0`=in stock, `1`=out of stock. |
sponsored | integer | optional | Whether to advertise products: `0`=No, `1`=Yes. |
isBranded | integer | optional | Whether it is a branded product: `0`=No, `1`=Yes. |
multipleOptionsAvailable | integer | optional | Are there variations: `0`=No, `1`=Yes. |
createdAt | string | optional | ws First collection time, in the format of `yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'`. |
updatedAt | string | optional | The last data update time, the format is the same as above. |
stats | object/null | optional | Historical statistics; returned if `includeStats=true`, otherwise `null`. |
sourceType | string | optional | Product source platform, fixed value is `"walmart"`. |
stats.price | array | optional | Historical selling price time series, sorted by date in ascending order. |
stats.sales | array | optional | Historical sales time series, sorted by date in ascending order. |
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.