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 |
|---|---|---|---|
category | string | opcional | The product category name (English) will be matched to the TikTok category ID; non-English input must be translated into English first. |
dateInfo | object | obligatorio | Date specification object, including two fields: `type` and `value`. |
dateInfo.type | string | obligatorio | Time granularity: `day` (day), `week` (week), `month` (month). |
dateInfo.value | string | obligatorio | Date values: `day` is in the format `YYYY-MM-DD`, `week` is in the format `YYYY-week number` (such as `2025-18`), `month` is in the format `YYYY-MM`. |
orderby | object | opcional | The collation object contains two fields: `field` and `order`. |
orderby.field | string | opcional | Sorting fields: `units_sold` (sales), `gmv` (sales), `total_units_sold` (total sales), `total_gmv` (total sales), `growth_rate` (growth rate). |
orderby.order | string | opcional | Sorting direction: `desc` (descending) or `asc` (ascending). Predeterminado: desc |
page | integer | opcional | Page number. Predeterminado: 1 |
pageSize | integer | opcional | Number of items per page, maximum `10`. Predeterminado: 10 |
region | string | obligatorio | Market area code. Optional values: `US` (United States), `GB` (UK), `MX` (Mexico), `ES` (Spain), `DE` (Germany), `IT` (Italy), `FR` (France), `ID` (Indonesia), `VN` (Vietnam), `MY` (Malaysia), `TH` (Thailand), `PH` (Philippines), `BR` (Brazil), `JP` (Japan), `SG` (Singapore). Permitidos: US, GB, MX, ES, DE, IT, FR, ID, VN, MY, TH, PH, BR, JP, SG Predeterminado: US |
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 estado de negocio: `200` indica éxito. |
errmsg | string | opcional | Business status description. |
page | integer | opcional | Current page number. |
pageSize | integer | opcional | The current number of items per page. |
total | integer | opcional | Number of records. |
products | array | opcional | List of hot-selling products, product object fields are shown in the table below. |
columns | array | opcional | Rendered columns. |
type | string | opcional | Rendering style. |
costTime | integer | opcional | Interface time spent (milliseconds). |
costToken | integer | opcional | Consume token; some responses may be omitted. |
matchedCategoryIdPath | string | opcional | Path to the matched category ID; may be returned when `category` is passed in. |
matchedCategoryNamePath | string | opcional | Matched category name path; may be returned when `category` is passed in. |
title | string | opcional | Product name. |
productId | string | opcional | Product ID. |
region | string | opcional | Area code. |
price | number | opcional | Product price. |
minPrice | number | opcional | Lowest price; only price range products are returned. |
maxPrice | number | opcional | Highest price; only price range products are returned. |
currency | string | opcional | Currency symbol or logo. |
totalSaleCnt | integer | opcional | Total sales. |
totalSale1dCnt | integer | opcional | Sales volume in the last 1 day (returned when `dateType=day`). |
totalSale7dCnt | integer | opcional | Sales volume in the past 7 days (returned when `dateType=week`). |
totalSale30dCnt | integer | opcional | Sales volume in the last 30 days (returned when `dateType=month`). |
totalSaleGmvAmt | number | opcional | Total sales. |
totalSaleGmv1dAmt | number | opcional | Sales in the last 1 day (returned when `dateType=day`). |
totalSaleGmv7dAmt | number | opcional | Sales in the last 7 days (returned when `dateType=week`). |
totalSaleGmv30dAmt | number | opcional | Sales in the last 30 days (returned for `dateType=month`). |
growthRate | number | opcional | Growth rate (percent). |
shopName | string | opcional | Store name. |
shopTotalUnitsSold | integer | opcional | The total sales volume of the store. |
shopSellerId | string | opcional | Store seller ID. |
categoryName | string | opcional | Product category. |
categoryIds | array | opcional | Product category ID path (level one to level three). |
productCommissionRate | number | opcional | Product commission ratio (basis points, 1000=10%). |
imageUrl | string | opcional | Product image URL. |
coverUrl | array | opcional | Product cover image URL list. |
shopAvatar | string | opcional | Store avatar URL. |
sourceType | string | opcional | Product source type. |
offShelvesText | string | opcional | Whether it is removed from the shelves ("Yes" = removed from the shelves, "No" = on sale). |
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.