API de Categorias

Gestiona las categorias de productos con soporte para jerarquias anidadas.

Endpoints

GET

/categories

categories:read

Obtener una lista plana de todas las categorias.

GET

/categories/tree

categories:read

Obtener el arbol completo de categorias con subcategorias anidadas.

GET

/categories/:id

categories:read

Obtener una categoria por su ID.

POST

/categories

categories:write

Crear una nueva categoria. Establece parentId para crear una subcategoria.

PUT

/categories/:id

categories:write

Actualizar una categoria existente. Se admiten actualizaciones parciales.

DELETE

/categories/:id

categories:write

Eliminacion suave de una categoria. Los productos de esta categoria no se ven afectados.

Referencia de Campos

Campo	Tipo	Obligatorio	Descripción
id	string	No	Identificador unico de la categoria (solo lectura)
name	string	Sí	Nombre de la categoria
slug	string	No	Slug amigable para URL (se genera automaticamente si se omite)
description	string	No	Descripcion de la categoria
parentId	string	No	ID de la categoria padre para anidacion
imageUrl	string	No	URL de la imagen de la categoria
sortOrder	integer	No	Orden de visualizacion (menor = primero)
isActive	boolean	No	Si la categoria esta activa (predeterminado: true)
children	Category[]	No	Subcategorias anidadas (solo en el endpoint de arbol)
createdAt	datetime	No	Marca de tiempo ISO 8601 (solo lectura)
updatedAt	datetime	No	Marca de tiempo ISO 8601 (solo lectura)

Ejemplo

Obtener arbol de categorias

bash

curl "https://api.mercozy.com/api/v1/external/categories/tree" \
  -H "X-API-Key: mk_live_xxxxx"

Crear una categoria

bash

curl -X POST "https://api.mercozy.com/api/v1/external/categories" \
  -H "X-API-Key: mk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Electronics",
    "description": "Electronic devices and accessories",
    "sortOrder": 1,
    "isActive": true
  }'

Ejemplo de Respuesta (Arbol)

json

{
  "data": [
    {
      "id": "cat_abc123",
      "name": "Electronics",
      "slug": "electronics",
      "description": "Electronic devices and accessories",
      "parentId": null,
      "imageUrl": null,
      "sortOrder": 1,
      "isActive": true,
      "children": [
        {
          "id": "cat_def456",
          "name": "Smartphones",
          "slug": "smartphones",
          "description": "Mobile phones",
          "parentId": "cat_abc123",
          "imageUrl": null,
          "sortOrder": 1,
          "isActive": true,
          "children": []
        }
      ],
      "createdAt": "2025-12-15T10:30:00Z",
      "updatedAt": "2025-12-15T10:30:00Z"
    }
  ]
}