Developer Documentation

Vectis API Reference

Build powerful integrations with our RESTful API. Manage orders, inventory, packages, and shipments programmatically.

Explore Endpoints Integration Guide
20+
Public Endpoints
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. Get API Key

Contact support to obtain credentials:

# Email us at
support@stoalogistics.com
# You'll receive
X-API-Key: your-api-key

2. Make API Calls

Include API key in all requests:

curl -H "X-API-Key: your-api-key" \
https://{tenant}.vectisoms.app/api/orders

3. Create Orders

Push orders for fulfillment:

POST /api/orders
# With externalId for idempotency

4. Common Endpoints

Key endpoints for integration:

GET /api/inventory?sku=...
POST /api/orders
GET /api/packages?orderId=...
POST /api/fulfillment/packages/{id}/ship