Desarrolladores API v1

Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

Catálogo e inventario

Productos

Catálogo de productos y sus categorías. El código (item_code) identifica al producto en documentos y existencias.

Operaciones

OperaciónMétodo y rutaAlcance
Listar productos GET /products products:read
Crear un producto POST /products products:write
Consultar un producto GET /products/{id} products:read
Actualizar un producto (PUT) PUT /products/{id} products:write
Actualizar un producto PATCH /products/{id} products:write
Eliminar un producto DEL /products/{id} products:write
Listar categorías GET /product-categories products:read
Consultar una categoría GET /product-categories/{id} products:read
Rutas de productos

Objeto producto

  • id integer obligatorio
  • item_code string obligatorio

    Código del producto en la instancia.

  • sku string obligatorio

    Igual a item_code.

  • name string obligatorio
  • barcode string | null
  • type string | null
  • image_url string | null
  • man_btch_num boolean

    Se maneja por lotes.

  • man_ser_num boolean

    Se maneja por números de serie.

  • sales_unit string | null
  • purchase_unit string | null
  • inventory_item boolean
  • created_at string (date-time) | null
  • updated_at string (date-time) | null
Objeto producto 
{
    "id": 101,
    "item_code": "P-1001",
    "sku": "P-1001",
    "name": "Aceite comestible 1 L",
    "barcode": "7501234567890",
    "type": "I",
    "image_url": null,
    "man_btch_num": true,
    "man_ser_num": false,
    "sales_unit": "PZA",
    "purchase_unit": "CJA",
    "inventory_item": true,
    "created_at": "2026-09-14T15:02:11.000000Z",
    "updated_at": "2026-10-05T18:40:03.000000Z"
}

Objeto categoría

  • id integer obligatorio
  • name string obligatorio
  • description string | null
  • created_at string (date-time) | null
  • updated_at string (date-time) | null
Objeto categoría 
{
    "id": 3,
    "name": "Abarrotes",
    "description": "Básicos de despensa",
    "created_at": "2026-09-14T15:00:00.000000Z",
    "updated_at": "2026-09-14T15:00:00.000000Z"
}