https://api.nexscope.ai/ss/productSearchEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/ss/productSearch |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
badgeAmazonsChoice | string | opcional | Amazon's Choice logo: `Y`, `N` or leave blank |
badgeBestSeller | string | opcional | Best Seller Logo: `Y`, `N` or leave blank |
badgeNewRelease | string | opcional | New Release ID: `Y`, `N` or leave blank |
chatId | string | opcional | Conversation id, maxLength 1000 |
dataSnapshotMonth | string | opcional | Product data snapshot year and month in `yyyyMM` format, or `nearly` representing the last 30 days of real-time data; maxLength 1000 Predeterminado: nearly |
dimensionType | string | opcional | Packaging size type, please see the description below for each site code |
excludeBrands | string | opcional | Exclude brands; maxLength 10240 |
excludeKeywords | string | opcional | Exclude keywords; maxLength 10240 |
excludeSellers | string | opcional | Exclude sellers; maxLength 10240 |
filterSubNode | boolean | opcional | Whether to filter subcategory nodes; only takes effect when nodeLabel or nodeIdPath has a value |
fulfillment | string | opcional | Delivery method: `AMZ`, `FBA`, `FBM`, multiple values separated by English commas |
hideUnlistedProduct | boolean | opcional | Whether to hide removed products Predeterminado: true |
includeBrands | string | opcional | Contains brand; maxLength 10240 |
includeSellers | string | opcional | Includes seller; maxLength 10240 |
keyword | string | opcional | Search keywords, it is recommended to use the target site language; maxLength 10240 |
listedWithinLastMonths | integer | opcional | Shelf time range (months), only `1`, `3`, `6`, `12`, `24` allowed |
marketplace | string | opcional | Only `US`, `UK`, `DE`, `FR`, `JP`, `CA`, `IT`, `ES`, `MX`, `IN` allowed Predeterminado: US |
matchType | integer | opcional | Matching method: `1` phrase matching, `2` fuzzy matching, `3` precise matching Predeterminado: 1 |
maxAmzUnit | integer | opcional | 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 |
maxBsr | integer | opcional | Top Category BSR Ranking |
maxBsrGrowthCount | integer | opcional | BSR highest growth number |
maxBsrGrowthRate | number | opcional | BSR maximum growth rate, unit % |
maxFba | number | opcional | Maximum FBA shipping fee (>= 0) |
maxListingQualityScore | number | opcional | Highest Listing page quality score (>= 0) |
maxPrice | number | opcional | Highest price (>= 0) |
maxProfit | number | opcional | Maximum gross profit margin, unit % (1–100) |
maxRating | number | opcional | Highest rating value (0–5) |
maxRatings | integer | opcional | Maximum number of ratings (0–10000) |
maxRatingsGrowthCount | integer | opcional | Highest number of new ratings per month (>= 0) |
maxRevenue | number | opcional | Highest monthly sales (>= 0) |
maxSellers | integer | opcional | Maximum number of sellers |
maxSubNodeBsrRank | integer | opcional | Subcategory BSR maximum ranking; requires `filterSubNode=true` |
maxUnits | integer | opcional | Highest monthly sales (>= 0) |
maxUnitsGrowthRate | number | opcional | Maximum monthly sales growth rate, unit % |
maxVariations | integer | opcional | Highest number of variants |
maxWeights | number | opcional | Maximum weight (>= 0) |
minAmzUnit | integer | opcional | 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 |
minBsr | integer | opcional | Category BSR lowest ranking |
minBsrGrowthCount | integer | opcional | BSR minimum growth number |
minBsrGrowthRate | number | opcional | BSR minimum growth rate, unit % |
minFba | number | opcional | Minimum FBA shipping (>= 0) |
minListingQualityScore | number | opcional | Minimum Listing page quality score (>= 0) |
minPrice | number | opcional | lowest price (>= 0) |
minProfit | number | opcional | Minimum gross profit margin, unit % (1–100) |
minRating | number | opcional | Lowest rating value (0–5) |
minRatings | integer | opcional | Minimum number of ratings (0–10000) |
minRatingsGrowthCount | integer | opcional | Minimum number of new ratings per month (>= 0) |
minRevenue | number | opcional | Minimum monthly sales (>= 0) |
minSellers | integer | opcional | Minimum number of sellers |
minSubNodeBsrRank | integer | opcional | Subcategory BSR lowest ranking; requires `filterSubNode=true` |
minUnits | integer | opcional | Minimum monthly sales volume (>= 0) |
minUnitsGrowthRate | number | opcional | Minimum monthly sales growth rate, unit % |
minVariations | integer | opcional | Minimum number of variants |
minWeights | number | opcional | Minimum weight (>= 0) |
nodeIdPath | string | opcional | Amazon category node ID; maxLength 1000 |
nodeLabel | string | opcional | Amazon category name; maxLength 1000 |
order | object | opcional | Sorting configuration; it is recommended to provide both `field` and `desc` when passing in |
order.desc | string | opcional | `"true"` descending order, `"false"` ascending order Predeterminado: true |
order.field | string | opcional | 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 Predeterminado: total_units |
page | integer | opcional | Page number, starting from 1 Predeterminado: 1 |
requestId | string | opcional | Push id, maxLength 1000 |
sellerNation | string | opcional | Seller's location code, multiple values separated by commas |
showVariation | string | opcional | Whether to query variants: `Y` or `N` Predeterminado: N |
size | integer | opcional | Number of items per page, 10–100 Predeterminado: 20 |
teamId | string | opcional | Team id, maxLength 1000 |
uid | string | opcional | User id, maxLength 1000 |
weightUnit | string | opcional | Weight unit: `g`, `kg`, `oz`, `lb`; must be specified when using weight filtering |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
No hay un ejemplo de respuesta publicado para esta API. Consulta los campos de respuesta siguientes.
Campos de respuesta
Referencia de campos de respuesta (64 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
total | integer | opcional | Total number of matching products |
products | array | opcional | Product list |
columns | array | opcional | Rendered column definitions |
keyword | string | opcional | Search keywords used (if any) |
nodeIdPath | string | opcional | Search category node |
nodeLabel | string | opcional | Amazon category name |
dataSnapshotMonth | string | opcional | Data query month |
sourceType | string | opcional | Source type, such as `amazon` |
type | string | opcional | rendering style |
message | string | opcional | Additional message or error message |
costToken | integer | opcional | Consume token |
asin | string | opcional | Amazon ASIN |
title | string | opcional | Título del producto |
asinUrl | string | opcional | Amazon product detail page URL |
imageUrl | string | opcional | Product image URL |
price | number | opcional | current price |
averagePrice | number | opcional | average price |
primePrice | number | opcional | Prime price, -1 means none |
currency | string | opcional | Currency |
monthlySalesUnits | integer | opcional | monthly sales |
monthlySalesRevenue | number | opcional | monthly sales |
monthlySalesUnitsGrowthRate | number | opcional | monthly sales growth rate |
bsr | integer | opcional | BSR Ranking |
bsrGrowthRate | number | opcional | BSR growth rate |
rating | number | opcional | Valoración |
ratings | integer | opcional | Rating number |
ratingsRate | number | opcional | Review rate |
profit | number | opcional | Gross profit margin (%) |
fba | number | opcional | FBA shipping |
sellerNum | integer | opcional | Number of sellers |
sellerId | string | opcional | BuyBox seller ID |
sellerName | string | opcional | BuyBox seller name |
sellerNation | string | opcional | BuyBox seller nationality |
brand | string | opcional | brand |
brandUrl | string | opcional | Brand page URL |
fulfillment | string | opcional | Shipping method (AMZ/FBA/FBM) |
availableDate | string | opcional | Release time (timestamp) |
availableDateString | string | opcional | Release date (formatted string) |
variationNum | integer | opcional | number of variants |
variant30DayUnits | integer | opcional | Monthly sales volume of daughter bodies (number of pieces) |
variant30DayRevenue | number | opcional | Subsidiary monthly sales |
variant30DayUpdatedAt | string | opcional | Subbody data update time |
weight | string | opcional | weight |
packageWeight | string | opcional | Packing weight |
dimension | string | opcional | Size |
packageDimensions | string | opcional | Packing size |
dimensionsType | string | opcional | size type |
packageDimensionType | string | opcional | Packaging size type |
listingQualityScore | number | opcional | Listing quality score |
deliveryPrice | number | opcional | Seller shipping fee, -1 means none |
nodeLabelPath | string | opcional | Category path |
nodeIdPath | string | opcional | Node ID path |
nodeId | integer | opcional | Node ID |
dataSnapshotMonth | string | opcional | Data query month |
badgeBestSeller | string | opcional | Best Seller logo (Y/N) |
badgeAmazonChoice | string | opcional | Amazon's Choice logo (Y/N) |
badgeNewRelease | string | opcional | New Release logo (Y/N) |
badgeVideo | string | opcional | Video introduction logo (Y/N) |
badgeEbc | string | opcional | A+ page identification (Y/N) |
badge | object | opcional | Identity summary object, including `bestSeller`, `amazonChoice`, `newRelease`, `video`, `ebc` |
subcategories | array | opcional | List of subcategories, each containing `code`, `rank`, `label` |
sku | string | opcional | SKU |
keyword | string | opcional | Keywords corresponding to filtering |
sourceType | string | opcional | Source type |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.