Build integrations with the Osmosys API

Connect your ERP, BI tools, and automation workflows to Osmosys. Query inventory items, track batches, and pull stock reports through a secure REST API.

Quick start

# List inventory items
curl -H "Authorization: Bearer osmk_live_<your-key>" \
     https://api.osmosyscloud.com/v1/inventory/items

REST / JSON OpenAPI 3.1 v1 Stable API Key Auth

Authentication

Authenticate with an API key as a Bearer token. Each key is scoped to a tenant with specific permissions.

Cursor Pagination

All list endpoints use opaque cursor-based pagination. Use nextCursor and hasMore to traverse results.

Error Handling

Errors follow RFC 7807 Problem Details with field-level validation errors on 400 responses.

Available Endpoints 7 endpoints

GET /v1/inventory/items List inventory items GET /v1/inventory/items/{itemCode} Get item by code GET /v1/inventory/items/{itemCode}/batches List batches for an item GET /v1/inventory/reports/stock-levels Stock levels report GET /v1/inventory/reports/expiring-items Expiring items report GET /v1/capabilities Endpoint discovery GET /v1/health Health check

API Reference

Full endpoint documentation with schemas, parameters, and response examples.