API Reference
Complete Fleet Orchestrator API documentation
Overview
The Fleet Orchestrator API provides programmatic access to manage your fleet operations. All endpoints use JSON for request and response bodies.
Base URLs
| Environment | URL |
|---|---|
| Production | https://api.moovex.ai/api/v1 |
| Staging | https://api.staging.moovex.ai/api/v1 |
Authentication
All API requests require authentication. Include your access token in the Authorization header:
See Authentication for details on obtaining tokens.
Resources
Core Operations
| Resource | Description |
|---|---|
| Reservations | Create and manage passenger bookings |
| Trips | Manage optimized trip routes |
| Trips Timeline | Timeline view of trip stops |
Fleet Resources
| Resource | Description |
|---|---|
| Drivers | Manage driver records and assignments |
| Vehicles | Manage vehicle fleet |
| Passengers | Manage passenger records |
| Parent | Manage parent/guardian records |
Configuration
| Resource | Description |
|---|---|
| Profiles | Service profiles for different use cases |
| Attributes | Passenger and vehicle attributes |
| Settings | Routing and assignment settings |
| Settings Templates | Reusable settings configurations |
| Driver Settings | Driver-specific settings |
| Custom Rules | Custom business rules |
| Services | Service type definitions |
Scheduling
| Resource | Description |
|---|---|
| Shifts | Define shift templates |
| Shifts App | Shift data for driver app |
| Driver Shifts | Assign shifts to drivers |
| Driver Shifts Driver | Driver's own shift management |
| Driver Shifts Sites | Site-level shift settings |
Organization
| Resource | Description |
|---|---|
| Sites | Organizational units |
| Suppliers | Transportation providers |
| Areas | Geographic service zones |
| Locations | Saved locations |
| Roles | User roles and permissions |
Shuttles
| Resource | Description |
|---|---|
| Shuttles | Shuttle line definitions |
| Shuttle Groups | Group shuttles for management |
Pricing
| Resource | Description |
|---|---|
| Fares | Fare configurations |
| Fare Groups | Group fares for management |
| Rates | Rate definitions |
Data Management
| Resource | Description |
|---|---|
| Data Upload | Bulk data import |
Response Format
All successful responses return JSON with the following structure:
For single resource requests, the response contains the resource object directly.
Error Handling
Errors return appropriate HTTP status codes with a JSON body:
| Status Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource doesn't exist |
| 500 | Internal Server Error |