> ## Documentation Index
> Fetch the complete documentation index at: https://docs.filexpress.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Alertas de inventario

> Stock bajo (existencia ≤ mínimo), lotes por vencer en `days` días y lotes vencidos. Máximo 500 de cada tipo.

**Permiso requerido:** `inventory.read`



## OpenAPI

````yaml /api-reference/openapi.json get /inventory/alerts
openapi: 3.0.3
info:
  title: FileXpress API Externa
  version: 1.0.0
  description: >-
    API para integrar sistemas de terceros con FileXpress: facturación, RRHH,
    contabilidad, inventario, proyectos, cuentas por cobrar y pagar, tesorería,
    precios y promociones y caja.
servers:
  - url: https://api.filexpress.app/api/external
    description: Producción
security:
  - ApiKey: []
tags:
  - name: General
  - name: Facturación · Ventas
  - name: Facturación · Compras
  - name: Facturación · Clientes
  - name: Facturación · Proveedores
  - name: Facturación · Productos
  - name: Catálogos
  - name: RRHH · Empleados
  - name: RRHH · Asistencia
  - name: RRHH · Permisos
  - name: RRHH · Planillas
  - name: Contabilidad
  - name: Inventario
  - name: Proyectos
  - name: Cuentas por cobrar
  - name: Cuentas por pagar
  - name: Tesorería
  - name: Precios y promociones
  - name: Caja
paths:
  /inventory/alerts:
    get:
      tags:
        - Inventario
      summary: Alertas de inventario
      description: >-
        Stock bajo (existencia ≤ mínimo), lotes por vencer en `days` días y
        lotes vencidos. Máximo 500 de cada tipo.


        **Permiso requerido:** `inventory.read`
      parameters:
        - name: branch_id
          in: query
          required: true
          description: Sucursal (GET /branches). De otro negocio → 404.
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
        - name: days
          in: query
          required: false
          description: Ventana de vencimiento (1–365, por defecto 30).
          schema:
            type: integer
            minimum: 1
            maximum: 365
            default: 30
      responses:
        '200':
          description: Éxito
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      days:
                        type: integer
                      low_stock:
                        type: array
                        items:
                          $ref: '#/components/schemas/StockItem'
                      expiring_batches:
                        type: array
                        items:
                          $ref: '#/components/schemas/ProductBatch'
                      expired_batches:
                        type: array
                        items:
                          $ref: '#/components/schemas/ProductBatch'
                    required:
                      - days
                      - low_stock
                      - expiring_batches
                      - expired_batches
              example:
                status: true
                data:
                  days: 30
                  low_stock:
                    - product_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      branch_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      sku: BEB-001
                      barcode: '7401234567890'
                      name: Refresco 350ml
                      availability: 8
                      min_stock: 10
                      is_low_stock: true
                      unit_cost: 0.7
                  expiring_batches:
                    - id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                      branch_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      product:
                        id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                        sku: BEB-001
                        name: Refresco 350ml
                      batch_number: L-2026-09
                      expiration_date: '2026-10-20'
                      days_to_expire: 14
                      quantity: 48
                      available_quantity: 30
                      is_expired: false
                      is_removed: false
                  expired_batches: []
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: No encontrado o de otro negocio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Branch not found
        '422':
          description: Error de validación
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Validation errors
                errors:
                  days:
                    - The days must not be greater than 365.
        '429':
          $ref: '#/components/responses/E429'
components:
  schemas:
    StockItem:
      type: object
      properties:
        product_id:
          type: string
          format: uuid
        branch_id:
          type: string
          format: uuid
        sku:
          type: string
          nullable: true
        barcode:
          type: string
          nullable: true
        name:
          type: string
        availability:
          type: number
          description: Existencia.
        min_stock:
          type: number
          description: Existencia mínima (0 = sin mínimo).
        is_low_stock:
          type: boolean
        unit_cost:
          type: number
      required:
        - product_id
        - availability
    ProductBatch:
      type: object
      properties:
        id:
          type: string
          format: uuid
        branch_id:
          type: string
          format: uuid
        product:
          type: object
          properties:
            id:
              type: string
              format: uuid
            sku:
              type: string
              nullable: true
            name:
              type: string
          required:
            - id
            - sku
            - name
          nullable: true
        batch_number:
          type: string
        expiration_date:
          type: string
          format: date
          nullable: true
        days_to_expire:
          type: integer
          nullable: true
          description: Negativo si ya venció.
        quantity:
          type: number
        available_quantity:
          type: number
        is_expired:
          type: boolean
        is_removed:
          type: boolean
      required:
        - id
        - quantity
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errores por campo (solo en validación).
      required:
        - status
        - message
  responses:
    E401:
      description: API Key ausente o inválida
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integración sin el permiso requerido o desactivada
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Límite de peticiones excedido
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key de la integración (Integraciones → Nueva Integración).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.