https://api.nexscope.ai/kp/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/kp/productSearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
domain | string | required | Amazon domain name ID: `1`=USA, `2`=UK, `3`=Germany, `4`=France, `5`=Japan, `6`=Canada, `8`=Italy, `9`=Spain, `10`=India, `11`=Mexico. |
keyword | string | optional | Title keyword; case-insensitive, spaces represent word segmentation AND, when the keyword itself contains spaces, it should be wrapped in double quotes, and the prefix `-` is supported for exclusion; `&` will be replaced by spaces, with a maximum of 50 keywords and a maximum of 1000 characters. |
rootCategory | integer[] | optional | Root category ID, up to 50. |
rootCategoryNames | string[] | optional | Root category name, up to 50; used when `rootCategory` is empty, the system automatically searches for the corresponding category ID. |
categoriesInclude | integer[] | optional | Subcategory IDs to include, up to 50; only include products listed directly in these subcategories. |
categoriesIncludeNames | string[] | optional | Subcategory names to include, up to 50; used when `categoriesInclude` is empty, supports full category paths separated by `:` or `›`. |
categoriesExclude | integer[] | optional | Subcategory IDs to exclude, up to 50. |
categoriesExcludeNames | string[] | optional | Names of subcategories to be excluded, up to 50; used when `categoriesExclude` is empty, supporting full category paths. |
srAvgMonth | string | optional | Historical sales ranking month, format `YYYYMM`, within the last 36 months. |
brand | string[] | optional | Brand, OR match. |
color | string[] | optional | Color, OR match. |
size | string[] | optional | Size, OR match. |
buyBoxIsAmazon | boolean | optional | Whether the Buy Box seller is Amazon. |
buyBoxIsFBA | boolean | optional | Whether the Buy Box is FBA. |
isHazMat | boolean | optional | Whether it is dangerous goods. |
singleVariation | boolean | optional | Only one variant is returned; when set to `true`, only one variant is returned for multi-variant products. |
productType | integer[] | optional | Product Types: `0`=Standard Product, `1`=Downloadable Product, `2`=Ebook, `5`=Variant Parent ASIN. Example: [
0,
1,
2
] |
history | integer | optional | Whether the return value contains historical data/historical sales volume: `1`=obtain, `0`=not obtain. Example: 0 |
rating | integer | optional | Whether to obtain rating information: `1`=obtain, `0`=not obtain. Example: 1 |
page | integer | optional | Page number, starting from 1. Example: 1 |
perPage | integer | optional | The maximum number of results returned per page, minimum 50, maximum 100. Example: 50 |
sort | object[] | optional | Maximum of 3 collations; each contains `{"fieldName":"...","sortDirection":"asc\|desc"}`. Sortable fields: `availableDate`, `currentSales`, `monthlySold`, `currentRating`, `currentCountReviews`, `currentBuyBoxShipping`, `currentNew`. |
Code example
{
"currentRatingGte": 4,
"domain": "1",
"keyword": "wireless charger",
"monthlySoldGte": 500
}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.brand | any | optional | Brand value used by this API operation. |
data.buyBoxSellerId | any | optional | Buy box seller id value used by this API operation. |
data.categoryTree | any | optional | Category tree value used by this API operation. |
data.categoryTreeId | any | optional | Category tree id value used by this API operation. |
data.color | any | optional | Color 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.currentPage | any | optional | Current page value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month 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.fbaFees | any | optional | Fba fees 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.isAdultProduct | any | optional | Is adult product value used by this API operation. |
data.isHazmat | any | optional | Is hazmat value used by this API operation. |
data.itemHeight | any | optional | Item height value used by this API operation. |
data.itemLength | any | optional | Item length value used by this API operation. |
data.itemWidth | any | optional | Item width value used by this API operation. |
data.label | any | optional | Label value used by this API operation. |
data.lastUpdate | any | optional | Last update value used by this API operation. |
data.manufacturer | any | optional | Manufacturer value used by this API operation. |
data.material | any | optional | Material value used by this API operation. |
data.model | any | optional | Model 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.packageDimensions | any | optional | Package dimensions value used by this API operation. |
data.packageHeight | any | optional | Package height value used by this API operation. |
data.packageLength | any | optional | Package length value used by this API operation. |
data.packageQuantity | any | optional | Package quantity value used by this API operation. |
data.packageWeight | any | optional | Package weight value used by this API operation. |
data.packageWidth | any | optional | Package width 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.parentAsin | any | optional | Parent asin value used by this API operation. |
data.perPage | any | optional | Per page 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.productImageUrls | any | optional | Product image urls 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.rank | any | optional | Rank 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.referralFeePercentage | any | optional | Referral fee percentage value used by this API operation. |
data.reviewCount | any | optional | Review count value used by this API operation. |
data.rootCategory | any | optional | Root category value used by this API operation. |
data.salesRank | any | optional | Sales rank value used by this API operation. |
data.salesRank180 | any | optional | Sales rank180 value used by this API operation. |
data.salesRank30 | any | optional | Sales rank30 value used by this API operation. |
data.salesRank90 | any | optional | Sales rank90 value used by this API operation. |
data.sellerNum | any | optional | Seller num 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.totalCount | any | optional | Total count 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.urlSlug | any | optional | Url slug 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 | 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 ASIN details 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 (`yyyy-MM-dd HH:mm:ss`). 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.buyBoxSellerId | string | optional | Buy button 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.categoryTree | string | optional | Category tree. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryTree | null | optional | Category tree value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryTreeId | string | optional | Category tree ID. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryTreeId | null | optional | Category tree id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.color | string | optional | color. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.color | null | optional | Color value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Rendered columns. 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.currentPage | integer | optional | Current page number. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.currentPage | null | optional | Current page 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.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.fbaFees | number | optional | FBA fulfillment fee 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.fulfillment | string | optional | Delivery 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 | Image URL (request address). 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.isAdultProduct | boolean | optional | Whether it is an adult product. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isAdultProduct | null | optional | Is adult product value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isHazmat | boolean | optional | Whether it is dangerous goods. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isHazmat | null | optional | Is hazmat value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.itemHeight | integer | optional | Product height in millimeters, 0 or -1 if not available. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.itemHeight | null | optional | Item height value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.itemLength | integer | optional | Product length in millimeters, 0 or -1 if not available. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.itemLength | null | optional | Item length value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.itemWidth | integer | optional | Product width (mm), 0 or -1 if not available. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.itemWidth | null | optional | Item width value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.label | string | optional | Category name; element type shall be subject to the source file or upstream official documentation. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.label | null | optional | Label value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.lastUpdate | string | optional | Last updated time (`yyyy-MM-dd HH:mm:ss`). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.lastUpdate | null | optional | Last update value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.manufacturer | string | optional | manufacturer. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.manufacturer | null | optional | Manufacturer value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.material | string | optional | The material of a product refers to the main materials used in its construction. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.material | null | optional | Material value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.model | string | optional | model. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.model | null | optional | Model 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 volume. 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.packageDimensions | string | optional | Packaging 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.packageHeight | integer | optional | Package height (mm). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageHeight | null | optional | Package height value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.packageLength | integer | optional | Package length (mm). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageLength | null | optional | Package length value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.packageQuantity | integer | optional | The quantity of the item in the package, or 0 or -1 if not available. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageQuantity | null | optional | Package quantity value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.packageWeight | string | optional | Packing weight (grams). 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.packageWidth | integer | optional | Package width (mm). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.packageWidth | null | optional | Package width 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.parentAsin | string | optional | Parent ASIN. 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.perPage | integer | optional | Quantity per page. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.perPage | null | optional | Per page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.price | number | optional | Current price 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.primePrice | number | optional | Prime Price. 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.productImageUrls | array | optional | List of product images. 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.profit | number | optional | Profit margin (percentage, such as 25.5 for 25.5%). 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.rank | string | optional | Ranking; element type shall be based on the source file or upstream official documentation. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rank | null | optional | Rank value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | number | optional | Current rating (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.referralFeePercentage | number | optional | Referral fee percentage. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.referralFeePercentage | null | optional | Referral fee percentage value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.reviewCount | integer | optional | Number of comments. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.reviewCount | null | optional | Review count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rootCategory | integer | optional | Root category ID. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rootCategory | null | optional | Root category value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank | integer | optional | Sales 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.salesRank180 | integer | optional | Average sales rank over the last 180 days. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank180 | null | optional | Sales rank180 value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank30 | integer | optional | Average sales rank over the past 30 days. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank30 | null | optional | Sales rank30 value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank90 | integer | optional | Average sales rank over the last 90 days. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesRank90 | null | optional | Sales rank90 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.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: `kp`. 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 | Subcategory list, including `code` (category ID), `rank` (ranking), `label` (category name). 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 rows. 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.totalCount | integer | optional | Total quantity. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalCount | null | optional | Total count 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.urlSlug | string | optional | URL Slug。 Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.urlSlug | null | optional | Url slug 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 (grams). 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.