Get Started in Minutes
Follow these simple steps to start integrating with the logistr API
API Reference
Loading API documentation from backend...
Endpoints
Client Management
Order Management
Field Documentation Loading
Field documentation not available for this endpoint.
Authentication
Secure your API calls with proper authentication
API Key Authentication
Server-to-server authentication
Use your API key in the request header for all API calls:
http
X-API-Key: your-api-key-hereJWT Authentication
Client portal authentication
Use JWT tokens for client portal access:
http
Authorization: Bearer your-jwt-token-hereSDK vs HTTP API
Choose the integration method that works best for your project
Node.js SDK
Recommended for Node.js applications
HTTP API
Universal integration for any language
✅ Advantages:
- • Works with any programming language
- • Direct control over all HTTP requests
- • No external dependencies required
- • Perfect for microservices architecture
- • Easy to debug and monitor
Common Integration Workflows
Step-by-step guides for typical integration scenarios
Client Management
Create and manage clients in your system
- 1. Create client with contact information
- 2. Set up business settings and permissions
- 3. Configure order automation rules
- 4. Enable portal access if needed
Order Processing
Complete order lifecycle management
- 1. Create pickup and delivery addresses
- 2. Create order with items and locations
- 3. Update order status as needed
- 4. Track completion and handle proof
Client Portal
Enable client self-service capabilities
- 1. Set up client authentication
- 2. Handle login and provider selection
- 3. Manage OTP verification
- 4. Access client profile and orders