Skip to main content
The Inventory API provides comprehensive inventory management features including item tracking, stock movements, recipe management with automatic deductions, and low stock alerts.

​
Features

  • Item Management: Create and manage inventory items with units and costs
  • Stock Tracking: Track current stock levels and minimum thresholds
  • Movement History: Record purchases, consumption, waste, and adjustments
  • Recipe Management: Link menu items to inventory ingredients with automatic deductions
  • Low Stock Alerts: Get notifications when items fall below minimum stock
  • Categories: Organize inventory items into categories

​
Authentication

Requires authentication and permissions:
  • inventory:read - View inventory data
  • inventory:create - Create items and movements
  • inventory:update - Update items

​
Base URL

https://api.restai.app/v1/inventory

​
Core Concepts

​
Inventory Items

Items represent raw materials, ingredients, or supplies. Each item has:
  • Name and unit of measurement (kg, L, units, etc.)
  • Current stock level (numeric)
  • Minimum stock threshold for alerts
  • Cost per unit for valuation
  • Optional category

​
Movements

All stock changes are recorded as movements:
  • purchase - Stock added via purchase
  • consumption - Stock used (manual or automatic via recipes)
  • waste - Stock lost or expired
  • adjustment - Manual stock corrections

​
Recipes

Recipes link menu items to their ingredients, enabling automatic inventory deductions when orders are placed.

​
Quick Start

Here’s a typical workflow:
  1. Create inventory items for your ingredients
  2. Create recipes linking menu items to ingredients
  3. Record purchase movements when restocking
  4. Monitor low stock alerts to know when to reorder
  5. Track movement history for audit trails

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us