API Contract¶

Welcome to the SaaS-Courier API documentation.

This section contains the complete API contract for the RoundAway Express platform.

Contents¶

Overview - Base URLs, error formats, implementation status
Authentication - Token-based auth, OAuth, email verification
Endpoints - Shipments, Bags, Flights, Courier APIs
WebSocket - Real-time updates and events
Public Tracking - Public tracking endpoint

Quick Start¶

# Login
curl -X POST https://api.saas-courier.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@courierflow.com", "password": "admin"}'

# Create Shipment
curl -X POST https://api.saas-courier.com/api/v1/shipments \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"sender_name": "Juan", ...}'

# Track Shipment (public)
curl https://api.saas-courier.com/api/v1/track/TRK-A1B2C3D4