https://api.nexscope.ai/fm/productRankTopSellingEjecutar 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/productRankTopSelling |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
region | string | obligatorio | 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). Ejemplo: US |
dateInfo | object | obligatorio | Objeto de especificación de fecha, incluyendo dos campos: `type` y `value`. |
dateInfo.type | string | obligatorio | Granularidad del tiempo: `day` (día), `week` (semana), `month` (mes). |
dateInfo.value | string | obligatorio | Valores de la fecha: `day` está en el formato `YYYY-MM-DD`, `week` está en el formato `YYYY-week number` (como `2025-18`), `month` está en el formato `YYYY-MM`. |
category | string | opcional | El nombre de la categoría de producto (inglés) se corresponderá con el ID de categoría TikTok; la entrada no inglesa debe traducirse al inglés primero. |
orderby | object | opcional | El objeto de cotejo contiene dos campos: `field` y `order`. |
orderby.field | string | opcional | Campos de clasificación: `units_sold` (ventas), `gmv` (ventas), `total_units_sold` (ventas totales), `total_gmv` (ventas totales), `growth_rate` (tasa de crecimiento). |
orderby.order | string | opcional | Dirección de clasificación: `desc` (descendiendo) o `asc` (ascendente). Ejemplo: desc |
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 (39 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
errcode | integer | opcional | Código de la situación empresarial, `200` indica éxito. |
errmsg | string | opcional | Descripción del estado de negocio. |
page | integer | opcional | Número actual de página. |
pageSize | integer | opcional | El número actual de artículos por página. |
total | integer | opcional | Número de registros. |
products | array | opcional | Lista de productos vendidos en caliente, campos de objeto del producto se muestran en la tabla a continuación. |
columns | array | opcional | Columnas renderizadas. |
type | string | opcional | Estilo de representación. |
costTime | integer | opcional | Tiempo de interfaz (millisegundos). |
costToken | integer | opcional | Consumir token; algunas respuestas pueden ser omitidas. |
matchedCategoryIdPath | string | opcional | Ruta al ID de categoría emparejado; puede ser devuelto cuando `category` se pasa. |
matchedCategoryNamePath | string | opcional | Ruta de nombre de categoría emparejada; puede ser devuelta cuando `category` se pasa. |
title | string | opcional | Nombre del producto. |
productId | string | opcional | Identificación del producto. |
region | string | opcional | Código de área. |
price | number | opcional | Precio del producto. |
minPrice | number | opcional | Precio más bajo; sólo los productos de gama de precios son devueltos. |
maxPrice | number | opcional | Precio más alto; sólo se devuelven los productos de gama de precios. |
currency | string | opcional | Símbolo de moneda o logotipo. |
totalSaleCnt | integer | opcional | Ventas totales. |
totalSale1dCnt | integer | opcional | Volumen de ventas del último día (1 día). Se devuelve cuando `dateType=day`. |
totalSale7dCnt | integer | opcional | Volumen de ventas en los últimos 7 días (retorno cuando `dateType=week`). |
totalSale30dCnt | integer | opcional | Volumen de ventas en los últimos 30 días (retorno cuando `dateType=month`). |
totalSaleGmvAmt | number | opcional | Ventas totales. |
totalSaleGmv1dAmt | number | opcional | Ventas en el último 1 día (regresó cuando `dateType=day`). |
totalSaleGmv7dAmt | number | opcional | Ventas en los últimos 7 días (retorno cuando `dateType=week`). |
totalSaleGmv30dAmt | number | opcional | Ventas en los últimos 30 días (devueltos por `dateType=month`). |
growthRate | number | opcional | Tasa de crecimiento (porcentaje). |
shopName | string | opcional | Nombre de la tienda. |
shopTotalUnitsSold | integer | opcional | El volumen total de ventas de la tienda. |
shopSellerId | string | opcional | ID del vendedor de la tienda. |
categoryName | string | opcional | Categoría de producto. |
categoryIds | array | opcional | Ruta de identificación de categoría de producto (nivel uno a nivel tres). |
productCommissionRate | number | opcional | Relación de comisión de productos (puntos básicos, 1000=10%). |
imageUrl | string | opcional | Imagen del producto URL. |
coverUrl | array | opcional | Imagen de la cubierta del producto URL lista. |
shopAvatar | string | opcional | Almacenar avatar URL. |
sourceType | string | opcional | Tipo de fuente del producto. |
offShelvesText | string | opcional | Si se retira de los estantes ("Sí" = quitado de los estantes, "No" = a la venta). |
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.