POST
https://api.nexscope.ai/woocommerce/productCategoriesEjecutar 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/woocommerce/productCategories |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
storeUrl | string | obligatorio | Público HTTPS tienda raíz o WordPress ruta de instalación. Ejemplo: https://example.com |
pageNum | integer | opcional | Número de página, por defecto 1. Ejemplo: 1 |
pageSize | integer | opcional | Tamaño de página, por defecto 20, máximo 100. Ejemplo: 20 |
keyword | string | opcional | Busca dentro de esta tienda; como máximo 200 caracteres. Ejemplo: shirt |
hideEmpty | boolean | opcional | Ocultar términos sin productos; por defecto, la configuración verdadera de la tienda. Ejemplo: true |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
{
"code": 0,
"cost": "-1",
"data": {
"cacheHit": false,
"categories": [
{
"count": 1,
"description": "",
"id": "1",
"imageUrl": "",
"name": "Color",
"parentId": "0",
"slug": "blue",
"url": ""
}
],
"fetchedAt": "1792972800000",
"hasMore": false,
"pageNum": 1,
"pageSize": 20,
"storeUrl": "https://example.com",
"total": 1,
"totalPages": 1
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 significa aceptado o exitoso; no cero es un error de plataforma. |
cost | string | obligatorio | Se pasó milisegundos, nunca créditos; -1 peticiones externas de la web. |
data | any | obligatorio | Valor de Data usado por esta operación de API. |
msg | string | null | obligatorio | Valor de Msg usado por esta operación de API. |
time | string | obligatorio | Hora local del servidor: aaaa-mm-dd HH:mm:ss. |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Epoch milisegundos. |
Opción 1 de cualquier alternativa — requiere storeUrl, fetchedAt, cacheHit, categories, pageNum, pageSize
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.cacheHit | boolean | obligatorio | Si la respuesta fue enviada desde el caché anónimo de 60 segundos. Ejemplo: false |
data.categories | array | obligatorio | Datos públicos normalizados. Faltan valores opcionales que son cadenas nulas o vacías. Ejemplo: [] |
data.categories[] | object | obligatorio | Elemento de data categories. |
data.categories[].count | any | opcional | Valor de Count usado por esta operación de API. |
data.categories[].description | string | obligatorio | Texto plano o público URL; vacía cuando no está disponible. Las imágenes no se obtienen. Ejemplo: |
data.categories[].id | string | obligatorio | Cadena de identificación con la pantalla de almacenamiento. Ejemplo: 1 |
data.categories[].imageUrl | string | obligatorio | Texto plano o público URL; vacía cuando no está disponible. Las imágenes no se obtienen. Ejemplo: |
data.categories[].name | string | obligatorio | Nombre de texto sencillo. Ejemplo: Color |
data.categories[].parentId | any | opcional | Valor de Parent id usado por esta operación de API. |
data.categories[].slug | string | obligatorio | Texto plano o público URL; vacía cuando no está disponible. Las imágenes no se obtienen. Ejemplo: blue |
data.categories[].url | string | obligatorio | Texto plano o público URL; vacía cuando no está disponible. Las imágenes no se obtienen. Ejemplo: |
data.fetchedAt | string | obligatorio | Obtener tiempo en milisegundos de época; preservado en los golpes de caché. Ejemplo: 1792972800000 |
data.hasMore | any | opcional | Valor de Has more usado por esta operación de API. |
data.pageNum | integer | obligatorio | Metadatos de paginación; los totales anteriores omitidos se vuelven nulos. Ejemplo: 1 |
data.pageSize | integer | obligatorio | Metadatos de paginación; los totales anteriores omitidos se vuelven nulos. Ejemplo: 20 |
data.storeUrl | string | obligatorio | Identidad de tienda normalizada. Ejemplo: https://example.com |
data.total | any | opcional | Valor de Total usado por esta operación de API. |
data.totalPages | any | opcional | Valor de Total pages usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.categories[].count | integer | opcional | El producto asociado cuenta, nulo cuando no está disponible. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.categories[].count | null | opcional | Valor de Count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.categories[].parentId | string | opcional | Id. de padre; 0 es un término raíz, null significa no disponible. Ejemplo: 0 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.categories[].parentId | null | opcional | Valor de Parent id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.hasMore | boolean | opcional | Nul cuando las páginas totales de aguas arriba no están disponibles. Ejemplo: false |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.hasMore | null | opcional | Valor de Has more usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.total | integer | opcional | Metadatos de paginación; los totales anteriores omitidos se vuelven nulos. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.total | null | opcional | Valor de Total usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.totalPages | integer | opcional | Metadatos de paginación; los totales anteriores omitidos se vuelven nulos. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.totalPages | null | opcional | Valor de Total pages usado por esta operación de API. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | null | obligatorio | Valor de Data usado por esta operación de API. |
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.