Skip to content
Skunivo Help Center

Start

Skunivo is a headless inventory platform for applications that need reliable stock state, reservations, movements and operational inventory workflows without building the inventory core from scratch.

The public integration surface is built around:

  • A versioned REST API scoped to an organization.
  • API keys for server-side integrations.
  • The TypeScript-first Skunivo Node.js SDK generated from the public OpenAPI contract.
  • Webhooks for downstream synchronization.
  • Runnable examples for onboarding and smoke tests.

What You Need

Section titled “What You Need”
  • A Skunivo API base URL for your environment.
  • An organization id.
  • A skv_test_... or skv_live_... API key.
  • The scopes required by your integration, usually inventory:read and inventory:write.
  • Node.js 22 or newer when using the Skunivo Node.js SDK or examples.

Do not expose server-side API keys in browser code. Browser-facing applications should call your backend, and your backend should call Skunivo.

Section titled “Recommended Path”

For JavaScript and TypeScript integrations, start with the SDK-backed examples in this repository while the package remains in pre-release:

Terminal window
cd skunivo-public-api-examples
pnpm install
cp .env.example .env
pnpm start

The examples consume the local Apache 2.0 SDK package from ../sdks/skunivo-sdk-js. npm installation will be documented separately after package ownership and publishing policy are confirmed.

For direct HTTP integrations or non-JavaScript clients, use the public OpenAPI contract:

Terminal window
GET /openapi/skunivo-public-openapi.json

Core Concepts

Section titled “Core Concepts”
  • Products identify what can be stocked.
  • Locations identify where stock can exist.
  • Inventory owners and channels segment stock for operational ownership and selling channels.
  • Balances describe current inventory state.
  • Movements are the audit ledger behind inventory changes.
  • Reservations, transfers, inbounds and outbounds are operational workflows built on top of the ledger.

Next Pages

Section titled “Next Pages”