> ## 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. # Inventory alerts > Low stock (stock ≤ minimum), batches expiring within `days` days, and expired batches. Maximum 500 of each type. **Required permission:** `inventory.read` ## OpenAPI ````yaml /api-reference/openapi.en.json get /inventory/alerts openapi: 3.0.3 info: title: FileXpress External API version: 1.0.0 description: >- API for integrating third-party systems with FileXpress: billing, HR, accounting, inventory, projects, accounts receivable and payable, treasury, pricing and promotions, and cash. Current base URL: /api/external/v1. The legacy unversioned path (/api/external) will be removed on January 1, 2027; migrate to /api/external/v1 (same endpoints, only the base URL changes). The v2 API (/api/external/v2) exposes currencies and exchange rates, sales and purchases in foreign currency, taxes by id, payrolls with branch, and errors with a stable `code`; its operations carry the /v2 prefix in the path. We suggest migrating to the available v2 routes before March 30, 2027. servers: - url: https://api.filexpress.app/api/external/v1 description: Production security: - ApiKey: [] tags: - name: General - name: Billing · Sales - name: Billing · Purchases - name: Billing · Customers - name: Billing · Suppliers - name: Billing · Products - name: Catalogs - name: HR · Employees - name: HR · Attendance - name: HR · Labor rules - name: HR · Schedules - name: HR · Holidays - name: HR · Attendance results - name: HR · Leave requests - name: HR · Payrolls - name: Accounting - name: Inventory - name: Projects - name: Accounts receivable - name: Accounts payable - name: Treasury - name: Pricing and promotions - name: Cash - name: Points of sale - name: API v2 · General - name: API v2 · Currencies and rates - name: API v2 · Countries - name: API v2 · Sales - name: API v2 · Purchases - name: API v2 · Payrolls paths: /inventory/alerts: get: tags: - Inventory summary: Inventory alerts description: >- Low stock (stock ≤ minimum), batches expiring within `days` days, and expired batches. Maximum 500 of each type. **Required permission:** `inventory.read` parameters: - name: branch_id in: query required: true description: Branch (GET /branches). From another business → 404. schema: type: string format: uuid example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11 - name: days in: query required: false description: Expiration window (1–365, default 30). schema: type: integer minimum: 1 maximum: 365 default: 30 responses: '200': description: Success 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: Not found or belongs to another business content: application/json: schema: $ref: '#/components/schemas/Error' example: status: false message: Branch not found '422': description: Validation error 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: Stock. min_stock: type: number description: Minimum stock (0 = no minimum). 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: Negative if already expired. 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: Errors per field (validation only). required: - status - message responses: E401: description: Missing or invalid API Key content: application/json: example: status: false message: Invalid API Key. E403: description: Integration without the required permission or deactivated content: application/json: example: status: false message: This integration does not have the 'hr.employees' permission. required_scope: hr.employees E429: description: Rate limit exceeded 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: Integration API Key (Integrations → New Integration). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.