https://api.nexscope.ai/st/amazon/productQueryRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/st/amazon/productQuery |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | required | Amazon site codes: `us`, `gb`, `de`, `fr`, `in`, `ca`, `jp`, `es`, `it`, `mx`, `ae`, `au`, `br`, `sa`. UK uses `gb`. AU, BR, and IN do not support historical review. |
queryMode | integer | optional | Query method: `1` single condition, `2` multi-condition combination (AND). Example: 1 |
queryType | integer | optional | Single condition query type, range 1-16; invalid when `queryMode=2`. See table below. |
queryValue | string | optional | Query value, the format is determined by `queryType`; when `queryMode=2`, the JSON condition array string is passed in. |
page | integer | optional | Page numbers; maximum 100 products per page, maximum 200 pages. Example: 1 |
queryMonth | string | optional | Historical snapshot month, format `yyyy-MM`; query real-time data if not specified, supported from 2024-01. |
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 (49 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | optional | Response code, `200` indicates success. |
msg | string | optional | Respond to the message. |
total | integer | optional | Total number of results. |
page | integer | optional | Current page number. |
pageCount | integer | optional | Total number of pages, up to 200 pages. |
costTime | integer | optional | Time taken, unit ms. |
costToken | integer | optional | The number of tokens consumed. |
requestConsumed | integer | optional | The number of requests consumed. |
type | string | optional | Rendering style. |
columns | array | optional | Render the column. |
products | array | optional | Product list; element fields are shown in the table below. |
asin | string | optional | ASIN。 |
title | string | optional | Product title |
brand | string | optional | brand. |
asinUrl | string | optional | Amazon Listing detail page URL. |
imageUrl | string | optional | Main image URL. |
productImageUrls | array | optional | All product image URLs. |
parentAsin | string | optional | Parent ASIN; `null` if no child. |
variationNum | integer | optional | Number of variants. |
weight | string | optional | Weight, unit g. |
size | array | optional | Outer packaging dimensions `[longest side, second longest side, shortest side]`, unit cm. |
price | number | optional | Current price, before coupons, in local currency. |
oldPrice | number | optional | Strikethrough price in local currency. |
salesPrice | number | optional | Price after deducting coupons, in local currency. |
coupon | integer | optional | Coupon policy; non-negative value is the discount amount, negative value is the discount percentage. |
fbaFees | number | optional | FBA fees in local currency. |
fbaDetail | array | optional | FBA Details. |
platformFee | number | optional | Platform commission, in local currency. |
profitAmount | number | optional | Profit, calculated as received price - FBA fee - commission, in local currency. |
profitRate | number | optional | Profit margin, for example `25.83` means 25.83%. |
monthlySalesUnits | integer | optional | Listing monthly sales in the past 30 days; `-1` indicates that it cannot be estimated. |
monthlySalesRevenue | number | optional | Estimated monthly sales in local currency; `-1` means cannot be estimated. |
listingSalesVolumeOfDaily | integer | optional | Listing daily sales volume; `-1` means it cannot be estimated. |
listingSalesOfDaily | number | optional | Listing daily sales, in local currency; `-1` means it cannot be estimated. |
salesRank | integer | optional | BSR category rankings. The lower the value, the better the ranking. |
category | array | optional | Category `[category name, NodeId]`. |
bsrCategory | array | optional | Small category ranking list, elements include `nodeId`, `name`, `rank`, `date` (`yyyyMMdd`). |
rating | number | optional | Current rating, range 0.0-5.0. |
ratings | integer | optional | Number of ratings. |
availableDate | string | optional | Shelf time, format `yyyy-MM-dd`. |
onlineDays | integer | optional | Number of days on shelf. |
buyboxSeller | string | optional | Buybox seller name. |
buyBoxSellerId | string | optional | Buybox seller ID. |
buyboxSellerAddress | string | optional | The two-digit code of the Buybox seller's country/region; when Amazon is self-operated, it is `null`. |
isFBA | boolean | optional | Do Buybox sellers use FBA. |
sellerNum | integer | optional | Number of sellers. |
aPlus | boolean | optional | A+ or not. |
hasVideo | boolean | optional | Is there a video. |
hasBrandStore | boolean | optional | Is there a brand store? |
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.