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. |
Code example
{
"marketplace": "us",
"queryMode": 1,
"queryType": 2,
"queryValue": "3743561"
}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
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.aPlus | any | optional | A plus value used by this API operation. |
data.asin | any | optional | Asin value used by this API operation. |
data.asinUrl | any | optional | Asin url value used by this API operation. |
data.availableDate | any | optional | Available date value used by this API operation. |
data.brand | any | optional | Brand value used by this API operation. |
data.bsrCategory | any | optional | Bsr category value used by this API operation. |
data.buyBoxSellerId | any | optional | Buy box seller id value used by this API operation. |
data.buyboxSeller | any | optional | Buybox seller value used by this API operation. |
data.buyboxSellerAddress | any | optional | Buybox seller address value used by this API operation. |
data.category | any | optional | Category value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.coupon | any | optional | Coupon value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.fbaDetail | any | optional | Fba detail value used by this API operation. |
data.fbaFees | any | optional | Fba fees value used by this API operation. |
data.hasBrandStore | any | optional | Has brand store value used by this API operation. |
data.hasVideo | any | optional | Has video value used by this API operation. |
data.imageUrl | any | optional | Image url value used by this API operation. |
data.isFBA | any | optional | Is fba value used by this API operation. |
data.listingSalesOfDaily | any | optional | Listing sales of daily value used by this API operation. |
data.listingSalesVolumeOfDaily | any | optional | Listing sales volume of daily value used by this API operation. |
data.monthlySalesRevenue | any | optional | Monthly sales revenue value used by this API operation. |
data.monthlySalesUnits | any | optional | Monthly sales units value used by this API operation. |
data.oldPrice | any | optional | Old price value used by this API operation. |
data.onlineDays | any | optional | Online days value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageCount | any | optional | Page count value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.parentAsin | any | optional | Parent asin value used by this API operation. |
data.platformFee | any | optional | Platform fee value used by this API operation. |
data.price | any | optional | Price value used by this API operation. |
data.productImageUrls | any | optional | Product image urls value used by this API operation. |
data.products | any | optional | Products value used by this API operation. |
data.profitAmount | any | optional | Profit amount value used by this API operation. |
data.profitRate | any | optional | Profit rate value used by this API operation. |
data.rating | any | optional | Rating value used by this API operation. |
data.ratings | any | optional | Ratings value used by this API operation. |
data.requestConsumed | any | optional | Request consumed value used by this API operation. |
data.salesPrice | any | optional | Sales price value used by this API operation. |
data.salesRank | any | optional | Sales rank value used by this API operation. |
data.sellerNum | any | optional | Seller num value used by this API operation. |
data.size | any | optional | Size value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.variationNum | any | optional | Variation num value used by this API operation. |
data.weight | any | optional | Weight value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.aPlus | boolean | optional | A+ or not. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.aPlus | null | optional | A plus value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | ASIN。 Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | null | optional | Asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asinUrl | string | optional | Amazon Listing detail page URL. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.asinUrl | null | optional | Asin url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.availableDate | string | optional | Shelf time, format `yyyy-MM-dd`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.availableDate | null | optional | Available date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | string | optional | brand. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brand | null | optional | Brand value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrCategory | array | optional | Small category ranking list, elements include `nodeId`, `name`, `rank`, `date` (`yyyyMMdd`). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrCategory | null | optional | Bsr category value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.buyBoxSellerId | string | optional | Buybox seller ID. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.buyBoxSellerId | null | optional | Buy box seller id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.buyboxSeller | string | optional | Buybox seller name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.buyboxSeller | null | optional | Buybox seller value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.buyboxSellerAddress | string | optional | The two-digit code of the Buybox seller's country/region; when Amazon is self-operated, it is `null`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.buyboxSellerAddress | null | optional | Buybox seller address value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.category | array | optional | Category `[category name, NodeId]`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.category | null | optional | Category value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Render the column. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | null | optional | Columns value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Time taken, unit ms. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | The number of tokens consumed. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.coupon | integer | optional | Coupon policy; non-negative value is the discount amount, negative value is the discount percentage. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.coupon | null | optional | Coupon value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.fbaDetail | array | optional | FBA Details. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.fbaDetail | null | optional | Fba detail value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.fbaFees | number | optional | FBA fees in local currency. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.fbaFees | null | optional | Fba fees value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.hasBrandStore | boolean | optional | Is there a brand store? Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.hasBrandStore | null | optional | Has brand store value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.hasVideo | boolean | optional | Is there a video. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.hasVideo | null | optional | Has video value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | string | optional | Main image URL. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | null | optional | Image url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isFBA | boolean | optional | Do Buybox sellers use FBA. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isFBA | null | optional | Is fba value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.listingSalesOfDaily | number | optional | Listing daily sales, in local currency; `-1` means it cannot be estimated. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.listingSalesOfDaily | null | optional | Listing sales of daily value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.listingSalesVolumeOfDaily | integer | optional | Listing daily sales volume; `-1` means it cannot be estimated. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.listingSalesVolumeOfDaily | null | optional | Listing sales volume of daily value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySalesRevenue | number | optional | Estimated monthly sales in local currency; `-1` means cannot be estimated. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySalesRevenue | null | optional | Monthly sales revenue value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySalesUnits | integer | optional | Listing monthly sales in the past 30 days; `-1` indicates that it cannot be estimated. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySalesUnits | null | optional | Monthly sales units value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.oldPrice | number | optional | Strikethrough price in local currency. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.oldPrice | null | optional | Old price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.onlineDays | integer | optional | Number of days on shelf. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.onlineDays | null | optional | Online days value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page number. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageCount | integer | optional | Total number of pages, up to 200 pages. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageCount | null | optional | Page count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.parentAsin | string | optional | Parent ASIN; `null` if no child. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.parentAsin | null | optional | Parent asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.platformFee | number | optional | Platform commission, in local currency. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.platformFee | null | optional | Platform fee value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.price | number | optional | Current price, before coupons, in local currency. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.price | null | optional | Price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productImageUrls | array | optional | All product image URLs. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productImageUrls | null | optional | Product image urls value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.products | array | optional | Product list; element fields are shown in the table below. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.products | null | optional | Products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.profitAmount | number | optional | Profit, calculated as received price - FBA fee - commission, in local currency. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.profitAmount | null | optional | Profit amount value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.profitRate | number | optional | Profit margin, for example `25.83` means 25.83%. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.profitRate | null | optional | Profit rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | number | optional | Current rating, range 0.0-5.0. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | null | optional | Rating value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.ratings | integer | optional | Number of ratings. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ratings | null | optional | Ratings value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.requestConsumed | integer | optional | The number of requests consumed. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.requestConsumed | null | optional | Request consumed value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesPrice | number | optional | Price after deducting coupons, in local currency. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesPrice | null | optional | Sales price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank | integer | optional | BSR category rankings. The lower the value, the better the ranking. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank | null | optional | Sales rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNum | integer | optional | Number of sellers. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNum | null | optional | Seller num value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.size | array | optional | Outer packaging dimensions `[longest side, second longest side, shortest side]`, unit cm. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.size | null | optional | Size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Product title. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Total number of results. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | Rendering style. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.variationNum | integer | optional | Number of variants. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.variationNum | null | optional | Variation num value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.weight | string | optional | Weight, unit g. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.weight | null | optional | Weight value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
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.