moovexDocs

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

EnvironmentURL
Productionhttps://api.moovex.ai/api/v1
Staginghttps://api.staging.moovex.ai/api/v1

Authentication

All API requests require authentication. Include your access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

See Authentication for details on obtaining tokens.

Resources

Core Operations

ResourceDescription
ReservationsCreate and manage passenger bookings
TripsManage optimized trip routes
Trips TimelineTimeline view of trip stops

Fleet Resources

ResourceDescription
DriversManage driver records and assignments
VehiclesManage vehicle fleet
PassengersManage passenger records
ParentManage parent/guardian records

Configuration

ResourceDescription
ProfilesService profiles for different use cases
AttributesPassenger and vehicle attributes
SettingsRouting and assignment settings
Settings TemplatesReusable settings configurations
Driver SettingsDriver-specific settings
Custom RulesCustom business rules
ServicesService type definitions

Scheduling

ResourceDescription
ShiftsDefine shift templates
Shifts AppShift data for driver app
Driver ShiftsAssign shifts to drivers
Driver Shifts DriverDriver's own shift management
Driver Shifts SitesSite-level shift settings

Organization

ResourceDescription
SitesOrganizational units
SuppliersTransportation providers
AreasGeographic service zones
LocationsSaved locations
RolesUser roles and permissions

Shuttles

ResourceDescription
ShuttlesShuttle line definitions
Shuttle GroupsGroup shuttles for management

Pricing

ResourceDescription
FaresFare configurations
Fare GroupsGroup fares for management
RatesRate definitions

Data Management

ResourceDescription
Data UploadBulk data import

Response Format

All successful responses return JSON with the following structure:

{
  "records": [...],
  "page": 1,
  "limit": 20,
  "totalPages": 5,
  "totalResults": 100
}

For single resource requests, the response contains the resource object directly.

Error Handling

Errors return appropriate HTTP status codes with a JSON body:

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}
Status CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing token
403Forbidden - Insufficient permissions
404Not Found - Resource doesn't exist
500Internal Server Error

On this page