https://api.nexscope.ai/kp/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/kp/productSearch |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
domain | string | obligatorio | Nombre de dominio de Amazon ID: `1`=EE.UU., `2`=UK, `3`=Alemania, `4`=Francia, `5`=Japón, `6`=Canadá, `8`=Italia, `9`=España, `10`=India, `11`=México. |
keyword | string | opcional | Título palabra clave; sin mayúsculas, los espacios representan la segmentación de la palabra Y, cuando la palabra clave en sí contiene espacios, debe envolverse en comillas dobles, y el prefijo `-` está respaldada por la exclusión; `&` será reemplazado por espacios, con un máximo de 50 palabras clave y un máximo de 1000 caracteres. |
rootCategory | integer[] | opcional | Identificación de categoría raíz, hasta 50. |
rootCategoryNames | string[] | opcional | Nombre de la categoría raíz, hasta 50; utilizado cuando `rootCategory` está vacío, el sistema busca automáticamente el ID de categoría correspondiente. |
categoriesInclude | integer[] | opcional | ID de subcategorías que deben incluir, hasta 50; solamente incluyen productos listados directamente en estas subcategorías. |
categoriesIncludeNames | string[] | opcional | Nombres de subcategorías que deben incluir, hasta 50; utilizados cuando `categoriesInclude` está vacío, soporta rutas de categoría completas separadas por `:` o `›`. |
categoriesExclude | integer[] | opcional | Subcategoría IDs a excluir, hasta 50. |
categoriesExcludeNames | string[] | opcional | Nombres de las subcategorías que deben excluirse, hasta 50; utilizados cuando `categoriesExclude` está vacía, soporta rutas de categoría completas. |
srAvgMonth | string | opcional | Mes histórico de clasificación de ventas, formato `YYYYMM`, en los últimos 36 meses. |
brand | string[] | opcional | Marca, o partido. |
color | string[] | opcional | Color, o partido. |
size | string[] | opcional | Tamaño, o partido. |
buyBoxIsAmazon | boolean | opcional | Si el vendedor Buy Box es Amazon. |
buyBoxIsFBA | boolean | opcional | Si la Caja de Compras es FBA. |
isHazMat | boolean | opcional | Si es mercancías peligrosas. |
singleVariation | boolean | opcional | Sólo se devuelve una variante; cuando se establece a `true`, sólo se devuelve una variante para productos multivariantes. |
productType | integer[] | opcional | Tipos de productos: `0`= Producto estándar, `1`= Producto descargable, `2`=Ebook, `5`=Variante Padre ASIN. Ejemplo: [
0,
1,
2
] |
history | integer | opcional | Si el valor de retorno contiene datos históricos/volumen histórico de ventas: `1`=obtener, `0`= no obtener. Ejemplo: 0 |
rating | integer | opcional | Si se desea obtener información sobre la calificación: `1`=obtener, `0`= no obtener. Ejemplo: 1 |
page | integer | opcional | Número de página, a partir de la 1. Ejemplo: 1 |
perPage | integer | opcional | El número máximo de resultados devueltos por página, mínimo 50, máximo 100. Ejemplo: 50 |
sort | object[] | opcional | Máximo de 3 collates; cada uno contiene `{"fieldName":"...","sortDirection":"asc\|desc"}`. Campos clasificables: `availableDate`, `currentSales`, `monthlySold`, `currentRating`, `currentCountReviews`, `currentBuyBoxShipping`, `currentNew`. |
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 | Número total de filas. |
perPage | integer | opcional | Cantidad por página. |
currentPage | integer | opcional | Número actual de página. |
totalCount | integer | opcional | Cantidad total. |
sourceType | string | opcional | Tipo de fuente: `kp`. |
type | string | opcional | Estilo de representación. |
columns | array | opcional | Columnas renderizadas. |
costToken | integer | opcional | Consumir token. |
products | array | opcional | Lista de productos, los campos de elementos se muestran en la tabla de abajo. |
asin | string | opcional | ASIN。 |
title | string | opcional | Título del producto. |
brand | string | opcional | marca. |
manufacturer | string | opcional | fabricante. |
model | string | opcional | modelo. |
price | number | opcional | Precio actual en moneda local. |
primePrice | number | opcional | Prime Price. |
currency | string | opcional | Moneda. |
salesRank | integer | opcional | Clasificación de ventas. |
salesRank30 | integer | opcional | Promedio de ventas rango en los últimos 30 días. |
salesRank90 | integer | opcional | El promedio de ventas en los últimos 90 días. |
salesRank180 | integer | opcional | Promedio de ventas en los últimos 180 días. |
monthlySalesUnits | integer | opcional | Volumen de ventas mensual. |
monthlySalesRevenue | number | opcional | Ventas mensuales. |
rating | number | opcional | Valoración actual (0,0-5,0). |
ratings | integer | opcional | Número de valoraciones. |
reviewCount | integer | opcional | Número de comentarios. |
availableDate | string | opcional | Plazo de validez (`yyyy-MM-dd HH:mm:ss`). |
lastUpdate | string | opcional | Última actualización (`yyyy-MM-dd HH:mm:ss`). |
imageUrl | string | opcional | Imagen URL (dirección de solicitud). |
productImageUrls | array | opcional | Lista de imágenes del producto. |
asinUrl | string | opcional | Amazon ASIN detalles URL. |
categoryTree | string | opcional | Árbol de categoría. |
categoryTreeId | string | opcional | Categoría de identificación del árbol. |
rootCategory | integer | opcional | Identificación de la categoría de raíz. |
subcategories | array | opcional | Lista de subcategorías, incluidos los `code` (ID de categoría), `rank` (categoría), `label` (nombre de la categoría). |
fulfillment | string | opcional | Método de entrega: `AMZ`, `FBA`, `FBM`. |
buyBoxSellerId | string | opcional | Comprar botón de identificación del vendedor. |
sellerNum | integer | opcional | Número de vendedores. |
parentAsin | string | opcional | Padre ASIN. |
variationNum | integer | opcional | Número de variantes. |
color | string | opcional | color. |
dimension | string | opcional | tamaño. |
dimensionsType | string | opcional | Tipo de talla. |
material | string | opcional | El material de un producto se refiere a los principales materiales utilizados en su construcción. |
weight | string | opcional | Peso (gramos). |
packageWeight | string | opcional | Peso de embalaje (gramos). |
packageLength | integer | opcional | Longitud del envase (mm). |
packageWidth | integer | opcional | Ancho del envase (mm). |
packageHeight | integer | opcional | Altura del envase (mm). |
packageDimensions | string | opcional | Tamaño del envase. |
packageQuantity | integer | opcional | La cantidad del artículo en el paquete, o 0 o -1 si no está disponible. |
itemLength | integer | opcional | Longitud del producto en milímetros, 0 o -1 si no está disponible. |
itemWidth | integer | opcional | Ancho del producto (mm), 0 o -1 si no está disponible. |
itemHeight | integer | opcional | Altura del producto en milímetros, 0 o -1 si no está disponible. |
isAdultProduct | boolean | opcional | Si es un producto para adultos. |
isHazmat | boolean | opcional | Si es mercancías peligrosas. |
referralFeePercentage | number | opcional | Porcentaje de la tasa de remisión. |
fbaFees | number | opcional | Cuota de cumplimiento de la FBA en moneda local. |
profit | number | opcional | Margen de beneficio (porcentaje, como 25,5 para el 25,5%). |
urlSlug | string | opcional | URL Babosa. |
sourceType | string | opcional | Tipo de fuente: `kp`. |
code | — | opcional | Categoría ID; el tipo de elemento estará sujeto al archivo fuente o a la documentación oficial anterior. |
rank | — | opcional | Clasificación; el tipo de elemento se basará en el archivo fuente o en la documentación oficial anterior. |
label | — | opcional | Nombre de la categoría; el tipo de elemento estará sujeto al archivo fuente o a la documentación oficial anterior. |
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 la ausencia de una clave API (code 11209), 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.