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 |
Code example
{
"keyword": "yoga mat",
"marketplace": "US",
"maxPrice": 50,
"minPrice": 10,
"minUnits": 300,
"order": {
"desc": "true",
"field": "total_units"
},
"page": 1,
"size": 20
}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.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.availableDateString | any | optional | Available date string value used by this API operation. |
data.averagePrice | any | optional | Average price value used by this API operation. |
data.badge | any | optional | Badge value used by this API operation. |
data.badgeAmazonChoice | any | optional | Badge amazon choice value used by this API operation. |
data.badgeBestSeller | any | optional | Badge best seller value used by this API operation. |
data.badgeEbc | any | optional | Badge ebc value used by this API operation. |
data.badgeNewRelease | any | optional | Badge new release value used by this API operation. |
data.badgeVideo | any | optional | Badge video value used by this API operation. |
data.brand | any | optional | Brand value used by this API operation. |
data.brandUrl | any | optional | Brand url value used by this API operation. |
data.bsr | any | optional | Bsr value used by this API operation. |
data.bsrGrowthRate | any | optional | Bsr growth rate 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.currency | any | optional | Currency value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.deliveryPrice | any | optional | Delivery price value used by this API operation. |
data.dimension | any | optional | Dimension value used by this API operation. |
data.dimensionsType | any | optional | Dimensions type value used by this API operation. |
data.fba | any | optional | Fba value used by this API operation. |
data.fulfillment | any | optional | Fulfillment value used by this API operation. |
data.imageUrl | any | optional | Image url value used by this API operation. |
data.keyword | any | optional | Keyword value used by this API operation. |
data.listingQualityScore | any | optional | Listing quality score 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.monthlySalesUnitsGrowthRate | any | optional | Monthly sales units growth rate value used by this API operation. |
data.nodeId | any | optional | Node id value used by this API operation. |
data.nodeIdPath | any | optional | Node id path value used by this API operation. |
data.nodeLabel | any | optional | Node label value used by this API operation. |
data.nodeLabelPath | any | optional | Node label path value used by this API operation. |
data.packageDimensionType | any | optional | Package dimension type value used by this API operation. |
data.packageDimensions | any | optional | Package dimensions value used by this API operation. |
data.packageWeight | any | optional | Package weight value used by this API operation. |
data.page | any | optional | Page 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.price | any | optional | Price value used by this API operation. |
data.primePrice | any | optional | Prime price value used by this API operation. |
data.products | any | optional | Products value used by this API operation. |
data.profit | any | optional | Profit 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.ratingsRate | any | optional | Ratings rate value used by this API operation. |
data.sellerId | any | optional | Seller id value used by this API operation. |
data.sellerName | any | optional | Seller name value used by this API operation. |
data.sellerNation | any | optional | Seller nation value used by this API operation. |
data.sellerNum | any | optional | Seller num value used by this API operation. |
data.sku | any | optional | Sku 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.subcategories | any | optional | Subcategories 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.variant30DayRevenue | any | optional | Variant30 day revenue value used by this API operation. |
data.variant30DayUnits | any | optional | Variant30 day units value used by this API operation. |
data.variant30DayUpdatedAt | any | optional | Variant30 day updated at 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.asin | string | optional | Amazon 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 product 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 | Release time (timestamp) 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.availableDateString | string | optional | Release date (formatted string) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.availableDateString | null | optional | Available date string value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.averagePrice | number | optional | average price Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.averagePrice | null | optional | Average price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badge | object | optional | Identity summary object, including `bestSeller`, `amazonChoice`, `newRelease`, `video`, `ebc` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badge | null | optional | Badge value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeAmazonChoice | string | optional | Amazon's Choice logo (Y/N) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeAmazonChoice | null | optional | Badge amazon choice value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeBestSeller | string | optional | Best Seller logo (Y/N) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeBestSeller | null | optional | Badge best seller value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeEbc | string | optional | A+ page identification (Y/N) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeEbc | null | optional | Badge ebc value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeNewRelease | string | optional | New Release logo (Y/N) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeNewRelease | null | optional | Badge new release value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeVideo | string | optional | Video introduction logo (Y/N) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.badgeVideo | null | optional | Badge video 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.brandUrl | string | optional | Brand page URL Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.brandUrl | null | optional | Brand url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bsr | integer | optional | BSR Ranking Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bsr | null | optional | Bsr value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrGrowthRate | number | optional | BSR growth rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrGrowthRate | null | optional | Bsr growth rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Rendered column definitions 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 | Execution time reported by the upstream provider. 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 | Consume token 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.currency | string | optional | Currency Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.currency | null | optional | Currency value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data query month 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 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.deliveryPrice | number | optional | Seller shipping fee, -1 means none Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.deliveryPrice | null | optional | Delivery price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dimension | string | optional | Size Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dimension | null | optional | Dimension value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dimensionsType | string | optional | size type Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dimensionsType | null | optional | Dimensions type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.fba | number | optional | FBA shipping Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.fba | null | optional | Fba value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.fulfillment | string | optional | Shipping method (AMZ/FBA/FBM) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.fulfillment | null | optional | Fulfillment value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | string | optional | Product 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.keyword | any | optional | Keyword value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | string | optional | Keywords corresponding to filtering Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | null | optional | Keyword value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.keyword | null | optional | Keyword value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.listingQualityScore | number | optional | Listing quality score Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.listingQualityScore | null | optional | Listing quality score value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySalesRevenue | number | optional | monthly sales 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 | monthly sales 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.monthlySalesUnitsGrowthRate | number | optional | monthly sales growth rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.monthlySalesUnitsGrowthRate | null | optional | Monthly sales units growth rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeId | integer | optional | Node ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeId | null | optional | Node id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeIdPath | any | optional | Node id path value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeIdPath | string | optional | Node ID path Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeIdPath | null | optional | Node id path value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeIdPath | null | optional | Node id path value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabel | string | optional | Amazon category name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabel | null | optional | Node label value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelPath | string | optional | Category path Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabelPath | null | optional | Node label path value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.packageDimensionType | string | optional | Packaging size type Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageDimensionType | null | optional | Package dimension type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.packageDimensions | string | optional | Packing size Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageDimensions | null | optional | Package dimensions value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.packageWeight | string | optional | Packing weight Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageWeight | null | optional | Package weight value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. 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.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.price | number | optional | current price 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.primePrice | number | optional | Prime price, -1 means none Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.primePrice | null | optional | Prime price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.products | array | optional | Product list 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.profit | number | optional | Gross profit margin (%) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.profit | null | optional | Profit value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | number | optional | Rating 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 | Rating number 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.ratingsRate | number | optional | Review rate Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ratingsRate | null | optional | Ratings rate value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerId | string | optional | BuyBox seller ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerId | null | optional | Seller id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerName | string | optional | BuyBox seller name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerName | null | optional | Seller name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNation | string | optional | BuyBox seller nationality Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sellerNation | null | optional | Seller nation 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.sku | string | optional | SKU Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sku | null | optional | Sku 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 | any | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Source 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 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.subcategories | array | optional | List of subcategories, each containing `code`, `rank`, `label` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.subcategories | null | optional | Subcategories 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 matching products 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.variant30DayRevenue | number | optional | Subsidiary monthly sales Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.variant30DayRevenue | null | optional | Variant30 day revenue value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.variant30DayUnits | integer | optional | Monthly sales volume of daughter bodies (number of pieces) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.variant30DayUnits | null | optional | Variant30 day units value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.variant30DayUpdatedAt | string | optional | Subbody data update time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.variant30DayUpdatedAt | null | optional | Variant30 day updated at 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 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.