https://api.nexscope.ai/et/listProductRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/et/listProduct |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | optional | Product keywords (please translate into local language). Maximum length 1000 |
region | string | optional | Region, default `US`. Optional values: US (United States), ID (Indonesia), TH (Thailand), PH (Philippines), MY (Malaysia), VN (Vietnam), GB (UK), MX (Mexico), SG (Singapore), SA (Saudi Arabia), BR (Brazil), ES (Spain), JP (Japan), DE (Germany), IT (Italy), FR (France) Example: US |
categoryKeywordCN | string | optional | Product classification (please enter Chinese). Maximum length 1000 |
minTotalSaleCnt | integer | optional | Total sales (minimum value) |
maxTotalSaleCnt | integer | optional | Total sales (maximum) |
minTotalSale30dCnt | integer | optional | 30-day sales (minimum) |
maxTotalSale30dCnt | integer | optional | 30-day sales (maximum) |
minTotalSaleGmvAmt | string | optional | GMV (minimum value). Maximum length 1000 |
maxTotalSaleGmvAmt | string | optional | GMV (maximum value). Maximum length 1000 |
minTotalSaleGmv30dAmt | string | optional | GMV (30 days) (minimum). Maximum length 1000 |
maxTotalSaleGmv30dAmt | string | optional | GMV (30 days) (maximum). Maximum length 1000 |
minSpuAvgPrice | number | optional | SPU average price (minimum value) |
maxSpuAvgPrice | number | optional | SPU average price (maximum) |
minProductRating | number | optional | Product rating (minimum value) |
maxProductRating | number | optional | Product rating (maximum value) |
minReviewCount | integer | optional | Number of product reviews (minimum value) |
maxReviewCount | integer | optional | Number of product reviews (maximum) |
minProductCommissionRate | number | optional | Product commission ratio (minimum value), when the input value is a percentage, it will automatically be converted into a decimal, for example: 5%->0.05 |
maxProductCommissionRate | number | optional | Product commission ratio (maximum value), when the input value is a percentage, it will automatically be converted into a decimal, for example: 5%->0.05 |
minTotalIflCnt | integer | optional | Number of people carrying goods (minimum) |
maxTotalIflCnt | integer | optional | Number of people carrying goods (maximum) |
minTotalVideoCnt | integer | optional | Number of videos with goods (minimum) |
maxTotalVideoCnt | integer | optional | Number of videos with goods (maximum value) |
minTotalViewsCnt | integer | optional | Number of plays with goods (minimum value) |
maxTotalViewsCnt | integer | optional | Number of plays with goods (maximum value) |
minFirstCrawlDt | integer | optional | Product shelf time (minimum value), format YYYYMMDD (for example: 20200101 represents 2020-01-01) |
maxFirstCrawlDt | integer | optional | Product shelf time (maximum value), format YYYYMMDD |
saleDays | integer | optional | The number of days the product has been on sale, in days |
productSortField | integer | optional | Sorting fields: 1=total sales volume, 2=total merchandise transaction volume, 3=SPU average price, 4=7-day sales volume, 5=30-day sales volume, 6=7-day merchandise transaction volume, 7=30-day merchandise transaction volume. Default `1` Example: 1 |
sortType | integer | optional | Sorting method: 0=ascending order (asc), 1=descending order (desc). Default `1` Example: 1 |
pageNum | integer | optional | Pagination page number. Default `1` Example: 1 |
pageSize | integer | optional | Number of items per page. Default `50` Example: 50 |
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 |
|---|---|---|---|
total | integer | optional | Number of records |
products | array | optional | Product information list (see details below) |
columns | array | optional | Rendered columns |
type | string | optional | Rendering style |
costToken | integer | optional | Consume token |
productId | string | optional | Product unique identification ID |
productName | string | optional | Product name |
title | string | optional | Product name |
imageUrl | string | optional | Product image URL |
coverUrl | string | optional | Cover image URL list |
productImageUrls | array | optional | Product image URL list |
categoryName | string | optional | Product category name |
categoryIds | array | optional | Product category ID list |
region | string | optional | area code |
currency | string | optional | Currency |
price | number | optional | Product price |
minPrice | number | optional | lowest price |
maxPrice | number | optional | highest price |
spuAvgPrice | number | optional | SPU average price |
productRating | number | optional | product rating |
reviewCount | integer | optional | Number of comments |
ratings | integer | optional | Number of comments |
productCommissionRate | number | optional | Product commission ratio |
totalSaleCnt | integer | optional | total sales |
totalSale1dCnt | integer | optional | Total sales in 1 day |
totalSale7dCnt | integer | optional | Total sales within 7 days |
totalSale15dCnt | integer | optional | Total sales within 15 days |
totalSale30dCnt | integer | optional | Total sales within 30 days |
totalSale60dCnt | integer | optional | Total sales within 60 days |
totalSale90dCnt | integer | optional | Total sales in 90 days |
monthlySalesUnits | integer | optional | monthly sales |
totalSaleGmvAmt | number | optional | total sales |
totalSaleGmv1dAmt | number | optional | Total sales in 1 day |
totalSaleGmv7dAmt | number | optional | Total sales within 7 days |
totalSaleGmv15dAmt | number | optional | Total sales in 15 days |
totalSaleGmv30dAmt | number | optional | Total sales in 30 days |
totalSaleGmv60dAmt | number | optional | Total sales in 60 days |
totalSaleGmv90dAmt | number | optional | Total sales in 90 days |
firstCrawlDt | integer | optional | Release date |
availableDate | string | optional | Release time (timestamp) |
discount | string | optional | discount information |
freeShippingText | string | optional | Is it free shipping? |
offMarkText | string | optional | Is there a discount mark? |
salesFlagText | string | optional | How to bring goods |
salesTrendFlagText | string | optional | sales trend tag |
isSShopText | string | optional | Is it an S store? |
salePropsInfo | array | optional | Sales attribute information (product specifications) |
sourceType | string | optional | Product source |
asin | string | optional | Product ID |
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.