https://api.nexscope.ai/ss/productSearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ss/productSearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
chatId | string | optional | Conversation id, maxLength 1000 |
uid | string | optional | User id, maxLength 1000 |
requestId | string | optional | Push id, maxLength 1000 |
teamId | string | optional | Team id, maxLength 1000 |
keyword | string | optional | Search keywords, it is recommended to use the target site language; maxLength 10240 |
matchType | integer | optional | Matching method: `1` phrase matching, `2` fuzzy matching, `3` precise matching Example: 1 |
excludeKeywords | string | optional | Exclude keywords; maxLength 10240 |
marketplace | string | optional | Only `US`, `UK`, `DE`, `FR`, `JP`, `CA`, `IT`, `ES`, `MX`, `IN` allowed Example: US |
nodeLabel | string | optional | Amazon category name; maxLength 1000 |
nodeIdPath | string | optional | Amazon category node ID; maxLength 1000 |
filterSubNode | boolean | optional | Whether to filter subcategory nodes; only takes effect when nodeLabel or nodeIdPath has a value |
dataSnapshotMonth | string | optional | Product data snapshot year and month in `yyyyMM` format, or `nearly` representing the last 30 days of real-time data; maxLength 1000 Example: nearly |
minPrice | number | optional | lowest price (>= 0) |
maxPrice | number | optional | Highest price (>= 0) |
minProfit | number | optional | Minimum gross profit margin, unit % (1β100) |
maxProfit | number | optional | Maximum gross profit margin, unit % (1β100) |
minRevenue | number | optional | Minimum monthly sales (>= 0) |
maxRevenue | number | optional | Highest monthly sales (>= 0) |
minFba | number | optional | Minimum FBA shipping (>= 0) |
maxFba | number | optional | Maximum FBA shipping fee (>= 0) |
minUnits | integer | optional | Minimum monthly sales volume (>= 0) |
maxUnits | integer | optional | Highest monthly sales (>= 0) |
minAmzUnit | integer | optional | Minimum sub-body sales volume in the past 30 days; only `dataSnapshotMonth` is supported for queries in the past 30 days, the minimum value is 0 |
maxAmzUnit | integer | optional | The highest sub-body sales volume in the past 30 days; only the query in the past 30 days is supported, the minimum value is 0 |
minUnitsGrowthRate | number | optional | Minimum monthly sales growth rate, unit % |
maxUnitsGrowthRate | number | optional | Maximum monthly sales growth rate, unit % |
minBsr | integer | optional | Category BSR lowest ranking |
maxBsr | integer | optional | Top Category BSR Ranking |
minBsrGrowthRate | number | optional | BSR minimum growth rate, unit % |
maxBsrGrowthRate | number | optional | BSR maximum growth rate, unit % |
minBsrGrowthCount | integer | optional | BSR minimum growth number |
maxBsrGrowthCount | integer | optional | BSR highest growth number |
minSubNodeBsrRank | integer | optional | Subcategory BSR lowest ranking; requires `filterSubNode=true` |
maxSubNodeBsrRank | integer | optional | Subcategory BSR maximum ranking; requires `filterSubNode=true` |
minRating | number | optional | Lowest rating value (0β5) |
maxRating | number | optional | Highest rating value (0β5) |
minRatings | integer | optional | Minimum number of ratings (0β10000) |
maxRatings | integer | optional | Maximum number of ratings (0β10000) |
minRatingsGrowthCount | integer | optional | Minimum number of new ratings per month (>= 0) |
maxRatingsGrowthCount | integer | optional | Highest number of new ratings per month (>= 0) |
minListingQualityScore | number | optional | Minimum Listing page quality score (>= 0) |
maxListingQualityScore | number | optional | Highest Listing page quality score (>= 0) |
minVariations | integer | optional | Minimum number of variants |
maxVariations | integer | optional | Highest number of variants |
minWeights | number | optional | Minimum weight (>= 0) |
maxWeights | number | optional | Maximum weight (>= 0) |
weightUnit | string | optional | Weight unit: `g`, `kg`, `oz`, `lb`; must be specified when using weight filtering |
dimensionType | string | optional | Packaging size type, please see the description below for each site code |
minSellers | integer | optional | Minimum number of sellers |
maxSellers | integer | optional | Maximum number of sellers |
badgeBestSeller | string | optional | Best Seller Logo: `Y`, `N` or leave blank |
badgeAmazonsChoice | string | optional | Amazon's Choice logo: `Y`, `N` or leave blank |
badgeNewRelease | string | optional | New Release ID: `Y`, `N` or leave blank |
fulfillment | string | optional | Delivery method: `AMZ`, `FBA`, `FBM`, multiple values separated by English commas |
showVariation | string | optional | Whether to query variants: `Y` or `N` Example: N |
hideUnlistedProduct | boolean | optional | Whether to hide removed products Example: true |
listedWithinLastMonths | integer | optional | Shelf time range (months), only `1`, `3`, `6`, `12`, `24` allowed |
sellerNation | string | optional | Seller's location code, multiple values separated by commas |
includeSellers | string | optional | Includes seller; maxLength 10240 |
excludeSellers | string | optional | Exclude sellers; maxLength 10240 |
includeBrands | string | optional | Contains brand; maxLength 10240 |
excludeBrands | string | optional | Exclude brands; maxLength 10240 |
order | object | optional | Sorting configuration; it is recommended to provide both `field` and `desc` when passing in |
order.field | string | optional | Sorting fields: `total_units`, `total_amount`, `bsr_rank`, `price`, `rating`, `reviews`, `profit`, `reviews_rate`, `available_date`, `questions`, `total_units_growth`, `total_amount_growth`, `reviews_increasement`, `bsr_rank_cv`, `bsr_rank_cr`, `amz_unit`; passing an empty string means not to sort by the above business fields Example: total_units |
order.desc | string | optional | `"true"` descending order, `"false"` ascending order Example: true |
page | integer | optional | Page number, starting from 1 Example: 1 |
size | integer | optional | Number of items per page, 10β100 Example: 20 |
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 (64 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total number of matching products |
products | array | optional | Product list |
columns | array | optional | Rendered column definitions |
keyword | string | optional | Search keywords used (if any) |
nodeIdPath | string | optional | Search category node |
nodeLabel | string | optional | Amazon category name |
dataSnapshotMonth | string | optional | Data query month |
sourceType | string | optional | Source type, such as `amazon` |
type | string | optional | rendering style |
message | string | optional | Additional message or error message |
costToken | integer | optional | Consume token |
asin | string | optional | Amazon ASIN |
title | string | optional | Product title |
asinUrl | string | optional | Amazon product detail page URL |
imageUrl | string | optional | Product image URL |
price | number | optional | current price |
averagePrice | number | optional | average price |
primePrice | number | optional | Prime price, -1 means none |
currency | string | optional | Currency |
monthlySalesUnits | integer | optional | monthly sales |
monthlySalesRevenue | number | optional | monthly sales |
monthlySalesUnitsGrowthRate | number | optional | monthly sales growth rate |
bsr | integer | optional | BSR Ranking |
bsrGrowthRate | number | optional | BSR growth rate |
rating | number | optional | Rating |
ratings | integer | optional | Rating number |
ratingsRate | number | optional | Review rate |
profit | number | optional | Gross profit margin (%) |
fba | number | optional | FBA shipping |
sellerNum | integer | optional | Number of sellers |
sellerId | string | optional | BuyBox seller ID |
sellerName | string | optional | BuyBox seller name |
sellerNation | string | optional | BuyBox seller nationality |
brand | string | optional | brand |
brandUrl | string | optional | Brand page URL |
fulfillment | string | optional | Shipping method (AMZ/FBA/FBM) |
availableDate | string | optional | Release time (timestamp) |
availableDateString | string | optional | Release date (formatted string) |
variationNum | integer | optional | number of variants |
variant30DayUnits | integer | optional | Monthly sales volume of daughter bodies (number of pieces) |
variant30DayRevenue | number | optional | Subsidiary monthly sales |
variant30DayUpdatedAt | string | optional | Subbody data update time |
weight | string | optional | weight |
packageWeight | string | optional | Packing weight |
dimension | string | optional | Size |
packageDimensions | string | optional | Packing size |
dimensionsType | string | optional | size type |
packageDimensionType | string | optional | Packaging size type |
listingQualityScore | number | optional | Listing quality score |
deliveryPrice | number | optional | Seller shipping fee, -1 means none |
nodeLabelPath | string | optional | Category path |
nodeIdPath | string | optional | Node ID path |
nodeId | integer | optional | Node ID |
dataSnapshotMonth | string | optional | Data query month |
badgeBestSeller | string | optional | Best Seller logo (Y/N) |
badgeAmazonChoice | string | optional | Amazon's Choice logo (Y/N) |
badgeNewRelease | string | optional | New Release logo (Y/N) |
badgeVideo | string | optional | Video introduction logo (Y/N) |
badgeEbc | string | optional | A+ page identification (Y/N) |
badge | object | optional | Identity summary object, including `bestSeller`, `amazonChoice`, `newRelease`, `video`, `ebc` |
subcategories | array | optional | List of subcategories, each containing `code`, `rank`, `label` |
sku | string | optional | SKU |
keyword | string | optional | Keywords corresponding to filtering |
sourceType | string | optional | Source type |
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.