https://api.nexscope.ai/kd/shop/rankEjecutar 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/kd/shop/rank |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
region | string | opcional | Código de región/mercado, como `US`; longitud máxima 1000 |
dateRange | string | opcional | Plazos, como `last7Day`, `last30Day`; longitud máxima 1000 |
pageNumber | integer | opcional | Número de página, valor 1-5; de retornos fuera de rango `errcode 501` |
pageSize | integer | opcional | Cantidad por página, valor 5-100 |
language | string | opcional | Lenguaje de retorno, como `zh-CN`, `en-US`; longitud máxima 1000 |
currency | string | opcional | Unidad monetaria, como `USD`; longitud máxima 1000 |
category_ids | string[] | opcional | Filtrado de la lista de ID de categoría; después de especificar, devuelve el importe de la transacción bajo la categoría correspondiente |
revenue_range | string | opcional | Cantidad de transacción / GMV rango, cerrado a la izquierda y abierto a la derecha |
shop_type | string | opcional | Tipo de almacenamiento: `BRAND` (marca) o `RETAILER` (retailer) |
sortField | object | opcional | Condiciones de clasificación; cuando no se ordena, pasar un objeto vacío `{}` |
shopId | string | obligatorio | TikTok almacenar ID único (cadena, para evitar la pérdida de gran precisión entero), como `7495514739648989419`, que puede obtenerse a partir de `shop_id` en la lista |
category_id | string | opcional | ID de categoría, que puede limitar aún más las dimensiones de categoría devueltas |
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 (30 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
errcode | integer | opcional | Código de la situación empresarial, `200` indica éxito |
data | array | opcional | Lista de la lista de almacenamiento o 1 elemento de la matriz de detalles |
costToken | integer | opcional | El token de deducción para esta llamada se fija en `14000` |
errmsg | string | opcional | Mensaje de estado, `ok` sobre el éxito |
rank | integer | opcional | Posición de clasificación, 1 es la más alta |
shop_name | string | opcional | Nombre de la tienda |
shop_id | string | opcional | Almacenar ID único (cadena, para evitar la pérdida de gran precisión del entero) |
shop_type | string | opcional | Tipo de tienda, como `BRAND` |
revenue | number | opcional | Total de ventas/VMG por pedido `currency` moneda |
sales_volumn | integer | opcional | Volumen de ventas, campo escrito `volumn` |
on_sell_product_count | integer | opcional | Número de artículos en venta |
unit_price | number | opcional | Precio unitario solicitado `currency` moneda |
revenue_growth_rate | number | opcional | Tasa de crecimiento de las ventas (%), puede ser positiva o negativa |
self_promotion_revenue | number | opcional | Ventas auto-operadas/auto-promocionadas |
affiliate_revenue | number | opcional | Ventas de distribución maestra |
shopping_mall_revenue | number | opcional | Ventas de centros comerciales |
shop_id | string | opcional | Almacenar ID único (cadena, para evitar la pérdida de gran precisión del entero) |
shop_name | string | opcional | Nombre de la tienda |
seller_type | string | opcional | Tipo de tienda/venta, como `BRAND`;utilizar `seller_type` para más detalles, no `shop_type` |
region | string | opcional | Región/mercado, como `US` |
revenue | number | opcional | Total de ventas/VMG por pedido `currency` moneda |
sales_volumn | integer | opcional | Volumen de ventas, campo escrito `volumn` |
product_number | integer | opcional | Número de artículos en venta |
unit_price | number | opcional | Precio unitario solicitado `currency` moneda |
self_account_revenue | number | opcional | Ventas auto-operadas/auto-transmitidas auto-promociones; uso `self_account_revenue` Para más detalles |
affiliate_revenue | number | opcional | Ventas de distribución maestra |
shoppingmall_revenue | number | opcional | Ventas de centros comerciales; no hay énfasis entre `shopping` y `mall` en el nombre del campo de detalle |
creator_number | integer | opcional | Número de colaboraciones con expertos |
video_number | integer | opcional | Número de vídeos asociados |
live_number | integer | opcional | Número de emisiones en directo asociadas |
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.