https://api.nexscope.ai/fm/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/fm/productSearch |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
keyword | string | opcional | Buscar palabras clave (comparación difusa de los títulos de los productos). |
region | string | opcional | Código de área de mercado. Valores opcionales: `US` (Estados Unidos), `GB` (UK), `MX` (México), `ES` (España), `DE` (Alemania), `IT` (Italia), `FR` (Francia), `ID` (Indonesia), `VN` (Vietnam), `MY` (Malasia), `TH` (Tailandia), `PH` (Filipinas), `BR` (Brasil), `JP` (Japón), `SG` (Singapur). |
category | string | opcional | Para los nombres de las categorías inglesas, el sistema coincide automáticamente con el ID de categoría TikTok; los nombres no ingleses necesitan ser traducidos al inglés primero. |
shopType | integer | opcional | Tipo de almacenamiento: `1`=almacén local, `2`= almacén transfronterizo. |
isTopSelling | boolean | opcional | Filtrar sólo los artículos más vendidos. |
isNewListed | boolean | opcional | Sólo filtrar nuevas listas. |
isSshop | boolean | opcional | Filtrar sólo TikTok completamente alojado (S-shop) elementos. |
isFreeShipping | boolean | opcional | Filtrar sólo los productos de envío gratis. |
isLocalWarehouse | boolean | opcional | Sólo los productos de filtro enviados desde los almacenes locales. |
unitsSoldRange | object | opcional | Filtrado de rango de ventas, formato: `{"min": 100, "max": 5000}`. |
commissionRateRange | object | opcional | Comisión tipo de filtro de rango, formato: `{"min": 0.05, "max": 0.20}` (decimal, `0.10`=10%). |
creatorCountRange | object | opcional | Filtrar el número de personas que transportan mercancías, formato: `{"min": 10, "max": 500}`. |
orderField | string | opcional | Campos de clasificación: `day7_units_sold` (ventas de 7 días), `day7_gmv` (7 días de vida en el mundo), `commission_rate` (tasa de comisión), `total_units_sold` (ventas totales), `total_gmv` (total del VMG), `creator_count` (número de clientes). El defecto es orden descendente. |
page | integer | opcional | Número de página. Ejemplo: 1 |
pageSize | integer | opcional | Número de artículos por página, máximo `10`. Ejemplo: 10 |
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 (38 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
total | integer | opcional | The total number of records that meet the criteria. |
products | array | opcional | Product information list, product object fields are shown in the table below. |
columns | array | opcional | Render column definitions. |
type | string | opcional | Rendering style type. |
costToken | integer | opcional | The number of tokens consumed. |
title | string | opcional | Título del producto |
productId | string | opcional | Product unique identification ID. |
region | string | opcional | Market area code. |
price | number | opcional | Product price. |
minPrice | number | opcional | lowest price. |
maxPrice | number | opcional | Highest price. |
currency | string | opcional | Currency code. |
totalSaleCnt | integer | opcional | Cumulative total sales. |
totalSale1dCnt | integer | opcional | 1 day sales. |
totalSale7dCnt | integer | opcional | 7 day sales. |
totalSale28dCnt | integer | opcional | 28 days sales. |
totalSale90dCnt | integer | opcional | 90 Day Sales. |
totalSaleGmvAmt | number | opcional | Cumulative total GMV. |
totalSaleGmv7dAmt | number | opcional | 7 days GMV. |
totalSaleGmv28dAmt | number | opcional | 28 days GMV. |
totalVideoCnt | integer | opcional | Number of videos with goods. |
totalLiveCnt | integer | opcional | Number of goods delivered live. |
totalIflCnt | integer | opcional | Bring the number of people with goods. |
productCommissionRate | number | opcional | Product commission ratio (decimal, `0.10`=10%). |
productRating | number | opcional | Valoración |
reviewCount | integer | opcional | Number of comments. |
skuCount | integer | opcional | SKU quantity. |
shopName | string | opcional | Store name. |
shopSellerId | string | opcional | Seller ID. |
shopTotalUnitsSold | integer | opcional | The total sales volume of the store. |
isCrossBorder | integer | opcional | Whether it is cross-border: `1`=cross-border, `0`=local. |
isSShopText | string | opcional | Whether to fully host the store (yes/no). |
freeShippingText | string | opcional | Whether shipping is free (yes/no). |
availableDate | string | opcional | Shelf time. |
categoryName | string | opcional | Product category name. |
salesTrendFlagText | string | opcional | Sales trend tag. |
tiktokUrl | string | opcional | TikTok merchandise link. |
imageUrl | string | opcional | Product image URL. |
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.