Node Quickstart

The public examples project is the recommended runnable quickstart for JavaScript integrators.

It uses the local pre-release @skunivo/sdk package and is not a parallel client implementation.

Configure

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

Set:

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

Optional:

SKUNIVO_OWNER_ID=...
SKUNIVO_CHANNEL_ID=...

Run

pnpm start

pnpm start builds the local SDK from ../sdks/skunivo-sdk-js before running the flow.

The script runs a focused core inventory flow:

1. Create a product.
2. Create source and destination locations.
3. Create or reuse inventory owner and channel records.
4. Receive stock.
5. List balances and movements.

Advanced inventory and reporting stay separate so new integrations do not need extra scopes or report plan access:

pnpm advanced-inventory
pnpm reports
SKUNIVO_REPORT_FORMAT=xlsx pnpm reports

The advanced flow covers product composition, lot receipt, lot balances and serials. The report flow covers report reads, export creation and consumer-controlled CSV/XLSX file writing.

These runtime examples require a real API and appropriate test credentials. The reports example additionally requires reports:read, reports:export and an eligible plan. Documentation builds and tests do not run these flows automatically.

Offline Checks

Use offline checks before running against a real API:

pnpm check
pnpm test

These checks validate example syntax and SDK consumption without sending API requests.