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

Existencias

Existencias por ubicación, lote y serie, y niveles por producto (a la mano y disponible).

Operaciones

OperaciónMétodo y rutaAlcance
Listar existencias GET /stocks stocks:read
Consultar una fila de existencia GET /stocks/{id} stocks:read
Niveles de existencia por producto GET /stock-levels stocks:read

Objeto fila de existencia

  • id integer obligatorio
  • product_id integer obligatorio
  • product_name string | null
  • item_code string | null
  • qty number obligatorio
  • status string obligatorio

    in (en almacén) u out (salió).

  • serial_number string | null
  • batch_num string | null
  • position objeto | null
    5 campos de position
    • id integer
    • bin_code string | null
    • whs_code string | null
    • warehouse_id integer | null
    • warehouse_name string | null
  • expiry_date string (date) | null
  • inventory_status string | null
    Valores: available, quarantine, in_transit, staged, damaged, blocked
  • created_at string (date-time) | null
  • updated_at string (date-time) | null
Objeto fila de existencia
{
    "id": 5012,
    "product_id": 101,
    "product_name": "Aceite comestible 1 L",
    "item_code": "P-1001",
    "qty": 48,
    "status": "in",
    "serial_number": null,
    "batch_num": "L2609",
    "position": {
        "id": 210,
        "bin_code": "A-01-01-1",
        "whs_code": "CEDIS-GDL",
        "warehouse_id": 1,
        "warehouse_name": "CEDIS Guadalajara"
    },
    "expiry_date": "2027-03-31",
    "inventory_status": "available",
    "created_at": "2026-09-20T14:10:00.000000Z",
    "updated_at": "2026-10-06T15:58:21.000000Z"
}

Objeto nivel de existencia

  • product_id integer obligatorio
  • item_code string obligatorio
  • name string | null
  • warehouse string | null

    El almacén pedido; null para el total de la empresa.

  • on_hand number obligatorio

    Todo lo que está en almacén.

  • available number obligatorio

    Lo que se puede prometer o surtir.

Objeto nivel de existencia
{
    "product_id": 101,
    "item_code": "P-1001",
    "name": "Aceite comestible 1 L",
    "warehouse": "CEDIS-GDL",
    "on_hand": 48,
    "available": 46
}