Clasificación del Catálogo
Para facilitar la búsqueda de productos, el análisis de ventas y la asignación automática de márgenes y tipos de IVA, BaseGes ERP organiza los artículos en una estructura jerárquica de hasta tres niveles:
- Familias (
/families): Gran categoría comercial (ej."01 Iluminación","02 Climatización"). - Subfamilias (
/subfamilies): Subcategoría dependiente de una familia (ej."0101 Bombillas LED","0201 Splits Pared"). - Grupos (
/groups): Agrupación funcional o de compras transversal.
1. Familias (/families)
GET /families
Devuelve el listado paginado de familias registradas en el ERP.
Parámetros de Consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
page | integer | Número de página (predeterminado 1). |
pageSize | integer | Familias por página (predeterminado 50, máx 100). |
code | string | Filtro exacto por código de familia. |
description | string | Filtro por descripción. |
search | string | Búsqueda parcial en código de familia (Code / tFamilias1) y descripción (Description / tFamilias2). Para subfamilias y grupos incluye también los códigos y descripciones de las entidades padre. |
Subfamilias de una Familia
GET /families/{code}/subfamilies
Obtiene únicamente las subfamilias que pertenecen de forma directa a la familia indicada por {code}.
2. Subfamilias (/subfamilies)
GET /subfamilies
Listado global de todas las subfamilias del catálogo.
GET /subfamilies?page=1&pageSize=50 HTTP/1.1
Host: localhost:5000
X-Api-Key: tu-api-key-secreta
3. Grupos de Artículos (/groups)
GET /groups
Consulta las agrupaciones complementarias utilizadas por el departamento de compras y ventas de BaseGes.
Ejemplo de Respuesta (200 OK)
{
"items": [
{
"code": "GRP01",
"description": "Material de Alta Rotación"
},
{
"code": "GRP02",
"description": "Consumibles de Taller"
}
],
"page": 1,
"pageSize": 50,
"totalCount": 2,
"totalPages": 1,
"hasPreviousPage": false,
"hasNextPage": false
}