theme
OnFleet
FREE
By stefan.skliarov
Updated a year ago

OnFleet API Documentation

Real-time delivery management and analytics functionality.

Learn more about this API
POSTcloneTask
POSTcompleteTask
POSTcreateAdministrator
POSTcreateDestination
POSTcreateDestinationFromRaw
POSTcreateRecipient
POSTcreateTask
POSTcreateTeam
POSTcreateWebhook
POSTcreateWorker
POSTdeleteAdministrator
POSTdeleteTask
POSTdeleteTeam
POSTdeleteWebhook
POSTdeleteWorker
POSTfindRecipientByName
POSTfindRecipientByPhone
POSTgetDelegateeDetails
POSTgetOrganizationDetails
POSTgetSingleDestination
POSTgetSingleRecipient
POSTgetSingleTask
POSTgetSingleTaskByShortId
POSTgetSingleTeam
POSTgetSingleWorker
POSTgetWorkersByLocation
POSTinsertTasksAtIndex
POSTlistAdministrators
POSTlistHubs
POSTlistTasks
POSTlistTeams
POSTlistWebhooks
POSTlistWorkers
POSTtestAuth
POSTupdateAdministrator
POSTupdateRecipient
POSTupdateTask
POSTupdateTasks
POSTupdateTeam
POSTupdateWorker
POSTwebhookEvent
POSTcreateWorker

Creating a new worker generates a temporary password which is sent to the worker’s phone by SMS along with download details for the worker iOS and Android mobile apps.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
teamsLIST
REQUIREDOne or more team IDs of which the worker is a member.
nameSTRING
REQUIREDThe worker’s complete name.
phoneSTRING
REQUIREDA valid phone number as per the worker’s organization’s country.
apiKeyCREDENTIALS
REQUIREDApi key obtained from OnFleet
Optional Parameters
capacityNUMBER
OPTIONALThe maximum number of units this worker can carry, for route optimization purposes.
vehicleJSON
OPTIONALThe worker’s vehicle; providing no vehicle details is equivalent to the worker being on foot.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication