Developer Documentation
Vectis API Reference
Build integrations with our REST API. Manage orders, products, inventory, and webhook subscriptions programmatically.
HMAC
Signed webhooks
OpenAPI 3.1
Specification
REST
Architecture
JSON
Response Format
Quick Start
Follow our Integration Guide for complete step-by-step instructions on connecting your systems.
1. Create an API client
Organization owners create API Clients in the Vectis account portal. (The Developer tab there also lists API Keys; for the Vectis API, use an API Client.)
# Vectis OMS
Vectis account portal (the Control Plane link in the app sidebar) → Organization Settings → Developer → API Clients → Create Client
# StoaPack
Dashboard → create an API key
2. Get a token and call the API
Exchange your client ID and secret for a one-hour token, then send it as a Bearer token:
curl -X POST https://api.vectisoms.app/oauth/token -d grant_type=client_credentials -d client_id=... -d client_secret=...
curl -H "Authorization: Bearer <access_token>" https://{tenant}.vectisoms.app/api/orders
For now, API client tokens are read-only on orders, products, and inventory.
3. Create Orders
Push orders for fulfillment:
POST /api/orders
# Send an Idempotency-Key header (kept 24 hours) to retry safely; externalId is not checked for duplicates
4. Common Endpoints
Key endpoints for integration:
GET /api/inventory?sku=...
POST /api/orders
GET /api/products/sku/{sku}
PATCH /api/inventory/{id}/adjust
For webhook event names (PascalCase, such as OrderCreated) and the required signing secret, see the Webhooks Guide.