https://api.nexscope.ai/ss/competitor-lookupRun 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/competitor-lookup |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketplace | string | optional | Amazon site codes: `US`, `UK`, `DE`, `FR`, `JP`, `CA`, `IT`, `ES`, `MX`, `AU`, `TR`, `IN` Example: US |
keyword | string | optional | Search keywords, it is recommended to use the target site language |
asinList | string | optional | ASIN, multiple ASINs separated by English commas, up to 40; format: `^[A-Z0-9]+(,[A-Z0-9]+){0,39}$` |
sellerName | string | optional | Seller name filter |
brand | string | optional | Brand name filter |
nodeLabel | string | optional | Amazon category name, supports multi-level category names, and the levels are separated by English colon `:` |
nodeIdPath | string | optional | Amazon Category ID Path |
matchType | integer | optional | Matching method: `1` phrase matching, `2` fuzzy matching, `3` precise matching Example: 1 |
showVariation | string | optional | Whether to query the variant: `Y` yes, `N` no Example: N |
dataSnapshotMonth | string | optional | `nearly` represents the last 30 days of real-time data; historical snapshots can also be queried in the `yyyyMM` format, such as `202412` Example: nearly |
page | integer | optional | Page number, starting from 1 Example: 1 |
size | integer | optional | Number of items per page, return 10–100 pieces of data Example: 50 |
order | object | optional | Sorting configuration, fields are shown in the table below |
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` Example: total_units |
order.desc | string | optional | Sorting direction: `true` descending order, `false` ascending order Example: true |
Code example
{
"keyword": "wireless earbuds",
"marketplace": "US",
"matchType": 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.amzUnitDateString | any | optional | Amz unit date string value used by this API operation. |
data.asin | any | optional | Asin 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.bsrGrowthCount | any | optional | Bsr growth count 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.parent | any | optional | Parent 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.ratingsGrowth | any | optional | Ratings growth 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.amzUnitDateString | string | optional | Sub-body sales update date Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.amzUnitDateString | null | optional | Amz unit date string value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | Product 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.availableDate | string | optional | Release time (date format) 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 (string format) 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 details object, including `bestSeller`, `amazonChoice`, `newRelease`, `ebc`, `video` (all Y/N strings) 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 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.bsrGrowthCount | integer | optional | BSR growth number Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.bsrGrowthCount | null | optional | Bsr growth count 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 | 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 1
| Name | Type | Required | Description |
|---|---|---|---|
data.deliveryPrice | number | optional | Seller shipping fee 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 | Product 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 | 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 | 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 | string | optional | matching keywords Example: null |
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 volume (number of pieces) 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 | 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 1
| Name | Type | Required | Description |
|---|---|---|---|
data.nodeLabel | string | optional | Category name echo 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.parent | string | optional | Parent ASIN Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.parent | null | optional | Parent 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 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 | Competing 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.ratingsGrowth | integer | optional | Number of new ratings per month Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ratingsGrowth | null | optional | Ratings growth 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 | Subcategory rankings, each including `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 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.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 | Child data update time (timestamp) 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 | Product 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.