API Documentation

REST API with JWT authentication, rate limits, and predictable JSON responses. Built for developers who need reliable inventory management integration.

Production Ready

API is live and stable

JWT Auth

Secure token-based auth

Rate Limited

Fair usage policies

Authentication
JWT-based authentication with Bearer tokens

1. Login to get token

POST /auth/login
Content-Type: application/json
{ "email": "user@example.com", "password": "your_password" }

2. Response includes tokens

{ "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...", "refresh_token": "uuid-here", "user_id": "uuid-here", "tenant_id": "uuid-here", "role": "manager" }
Core Endpoints
Main API endpoints for inventory management
GET /propertiesList

Get all properties for the authenticated tenant

POST /propertiesCreate

Create a new property

GET /properties/:idRead

Get property details by ID

Example: Create Item
Complete example of creating an item with the API

Request

POST /items
Authorization: Bearer <your_token>
Content-Type: application/json
{ "sku": "ITEM-001", "name": "Office Chair", "category": "Furniture", "material": "Leather", "color": "Black", "variant": "Executive", "volume_ml": 50000 }

Response

{ "id": "uuid-here", "tenant_id": "uuid-here", "sku": "ITEM-001", "name": "Office Chair", "category": "Furniture", "material": "Leather", "color": "Black", "variant": "Executive", "volume_ml": 50000, "created_at": "2024-08-25T10:00:00Z" }
Security & Rate Limits
Security measures and usage policies

Security Features

  • • JWT authentication with secure tokens
  • • Role-based access control (RBAC)
  • • Multi-tenant isolation
  • • HTTPS encryption
  • • SQL injection prevention
  • • Strict security headers

Rate Limits

  • • 1000 requests per hour per API key
  • • 100 requests per minute burst
  • • Fair usage policies
  • • Contact us for higher limits

Ready to integrate with Inventoo?