Quickstart Setup

Use the quickstart setup to validate an integration against a Skunivo API environment.

Requirements

• Node.js 22 or newer.
• pnpm.
• A running Skunivo API.
• A valid organization id.
• A test or live API key with the required scopes.

Environment

From the coordinated Skunivo repository, install the public examples and create .env:

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

Set the required values:

SKUNIVO_BASE_URL=https://api.skunivo.com
SKUNIVO_API_KEY=skv_test_...
SKUNIVO_ORGANIZATION_ID=...

Optional segment ids can be provided when you want the quickstart to reuse existing inventory segments:

SKUNIVO_OWNER_ID=...
SKUNIVO_CHANNEL_ID=...

When the optional values are omitted, the quickstart creates demo owner and channel records.

Run The Quickstart

cd skunivo-public-api-examples
pnpm start

The quickstart builds the local pre-release SDK from ../sdks/skunivo-sdk-js, then creates demo products, locations, inventory segments and a stock receipt before reading balances and movements.

Each run creates uniquely named demo data and sends idempotency keys for write operations.

Run pnpm advanced-inventory for compositions, lots and serials. Run pnpm reports for CSV exports or SKUNIVO_REPORT_FORMAT=xlsx pnpm reports for XLSX. Report examples need reports:read, reports:export and plan access; the basic quickstart does not.

Validate Without API Access

Offline checks do not call the Skunivo API:

pnpm check
pnpm test

Use these checks to validate local example syntax and SDK consumption. pnpm start still requires a real API base URL, organization id and API key.