https://api.nexscope.ai/api/skill-api/v1/skills/walmart-product-analysis/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/walmart-product-analysis/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
operation: searchByName
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | required | Operation: searchByName, detail, trend, or salesVolume Constant: searchByName |
name | string | required | Product name required by searchByName Minimum length: 1 |
pageIndex | integer | optional | Page number, starting at 1 Default: 1 Minimum: 1 |
operation: detail
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | required | Operation: searchByName, detail, trend, or salesVolume Constant: detail |
productId | string | required | Walmart product ID required by detail, trend, and salesVolume Minimum length: 1 |
operation: trend
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | required | Operation: searchByName, detail, trend, or salesVolume Constant: trend |
productId | string | required | Walmart product ID required by detail, trend, and salesVolume Minimum length: 1 |
operation: salesVolume
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | required | Operation: searchByName, detail, trend, or salesVolume Constant: salesVolume |
productId | string | required | Walmart product ID required by detail, trend, and salesVolume Minimum length: 1 |
queryDate | string | optional | Sales-volume start date in YYYY-MM-DD format Format: date |
queryEndDate | string | optional | Sales-volume end date in YYYY-MM-DD format Format: date |
pageIndex | integer | optional | Page number, starting at 1 Default: 1 Minimum: 1 |
Request example
{
"productId": "5169493923",
"operation": "detail"
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
operation | any | required | Operation value used by this API operation. |
value | any | required | Value value used by this API operation. |
requestConsumed | integer | required | Request consumed value used by this API operation. Minimum: 0 |
operation: searchByName
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | optional | Operation value used by this API operation. Constant: searchByName |
value | array | optional | Value value used by this API operation. |
operation: salesVolume
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | optional | Operation value used by this API operation. Constant: salesVolume |
value | array | optional | Value value used by this API operation. |
value[] | array | required | Item in value. Minimum items: 3 Maximum items: 3 |
value[][0] | string | required | Item in value[]. Format: date |
value[][1] | number | required | Item in value[]. |
value[][2] | integer | required | Item in value[]. |
One of option 3
| Name | Type | Required | Description |
|---|---|---|---|
operation | any | optional | Operation value used by this API operation. Allowed: detail, trend |
value | object | optional | Value value used by this API operation. |
Response example
Direct response payload. No extra wrapper is added.
{
"operation": "detail",
"requestConsumed": 1,
"value": {
"Title": "Example Walmart product",
"Price": 1,
"ProductId": "5169493923"
}
}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.