https://api.nexscope.ai/kd/product/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/product/rank |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
category_ids | array | opcional | Category ID list filter |
category_ids[] | string | obligatorio | Filtro de lista de identificación de categoría |
commission_rate | number | opcional | Affiliate product commission rate, such as `0.15` |
creator_id | string | opcional | Expert ID filtering |
currency | string | opcional | Currency unit, such as `USD` |
dateRange | string | opcional | Time range, such as `last7Day`, `last30Day` |
is_affiliate | string | opcional | Whether it is an alliance product: `PUBLIC_PLAN` (yes) or `NON_AFFILIATE` (no) |
is_tts_product | integer | opcional | Whether the product is fully managed: `1` (fully managed) or `0` (not fully managed) |
language | string | opcional | Return language, for example `zh-CN`, `en-US` |
livestream_id | string | opcional | Returns the products associated with the specified live broadcast |
pageNumber | integer | opcional | Page number, range 1-5 |
pageSize | integer | opcional | Number of items per page, range 5-100 |
productId | string | obligatorio | TikTok product ID, such as `1729508370969629931`; the string can avoid the loss of large integer precision and can be obtained from the `product_id` of the list response |
region | string | opcional | Region/market code, such as `US` |
revenue_range | string | opcional | Transaction amount / GMV range, left closed and right open |
shop_id | string | opcional | Store ID filter |
sortField | object | opcional | Sorting specification object, the available fields are subject to those actually accepted by the gateway. |
unit_price_range | string | opcional | Product price range, left closed and right open |
video_id | string | opcional | Returns the products associated with the specified video |
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 (37 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
errcode | integer | opcional | Business status code, `200` indicates success |
data | array | opcional | List or detailed data; real response does not return `total` |
costToken | integer | opcional | The deduction token for this call is usually `14000` |
errmsg | string | opcional | Status message, `ok` on success |
product_id | string | opcional | Product ID (string format to avoid loss of large integer precision), can be used as `productId` to query details |
product_name | string | opcional | Título del producto |
unit_price | number | opcional | Unit price, currency depends on `region`, such as US is USD |
sales_volumn | integer | opcional | Sales volume (units); field name `sales_volumn`, not `volume` |
revenue | number | opcional | Total sales / GMV, equals `video_revenue` + `live_revenue` + `showcase_revenue` |
video_revenue | number | opcional | Video channel sales |
live_revenue | number | opcional | Live broadcast channel sales |
showcase_revenue | number | opcional | Window/display channel sales |
revenue_growth_rate | number | opcional | Sales growth rate (percentage, e.g. `27.94` represents 27.94%) |
commission_rate | number | opcional | Commission rate, direct percentage, such as `25.0` means 25%, not basis points |
launch_date | string | opcional | Date on shelves (`YYYY-MM-DD`) |
product_id | string | opcional | Unique product ID (string, to avoid loss of large integer precision) |
product_name | string | opcional | Product name |
product_region | string | opcional | The region/market where the product is located, such as `us` |
product_shop_id | string | opcional | Store ID |
pri_cate_id | string | opcional | First level category ID |
sec_cate_id | string | opcional | Secondary category ID |
ter_cate_id | string | opcional | Third-level category ID |
unit_price | number | opcional | Unit price in requested `currency` currency |
min_price | number | opcional | Lowest price in requested `currency` currency |
max_price | number | opcional | Highest price in requested `currency` currency |
revenue | number | opcional | Total sales/GMV by requested `currency` currency |
sales_volumn | integer | opcional | Sales volume, field spelled `volumn` |
commission_rate | number | opcional | Commission rate, direct percentage, `25.0` means 25% |
product_review_count | integer | opcional | Number of product reviews |
launch_date | string | opcional | Date on shelves (`YYYY-MM-DD`) |
delivery_type | string | opcional | Shipping method, such as `local` |
video_number | integer | opcional | Number of associated videos |
video_revenue | number | opcional | Sales generated by video in requested `currency` currency |
live_number | integer | opcional | Number of associated live broadcasts |
live_revenue | number | opcional | Sales generated by live streaming, in requested `currency` currency |
shopping_mall_revenue | number | opcional | Marketplace sales in requested `currency` currency |
creator_number | integer | opcional | Number of connected people |
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 una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), 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.