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
POSTcreateTask

Create new task

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
recipientsIdsLIST
REQUIREDAn array containing zero or one IDs of the task's recipients
destinationIdSTRING
REQUIREDThe ID of the task's destination
apiKeyCREDENTIALS
REQUIREDApi key obtained from OnFleet
Optional Parameters
dependenciesLIST
OPTIONALOne or more IDs of tasks which must be completed prior to this task.
merchantSTRING
OPTIONALThe ID of the organization that will be displayed to the recipient of the task. Defaults to the creating organization. If you perform deliveries on behalf of a connected organization and want to display their name, logo, and branded notifications, provide their organization ID.
executorSTRING
OPTIONALThe ID of the organization that will be responsible for fulfilling the task. Defaults to the creating organization. If you delegate your deliveries to a third party, provide their organization ID.
completeBeforeDATEPICKER
OPTIONALA date Y-m-d H:m:s for the latest time the task should be completed.
completeAfterDATEPICKER
OPTIONALA date Y-m-d H:m:s for the earliest time the task should be completed.
notesSTRING
OPTIONALNotes for the task.
serviceTimeNUMBER
OPTIONALThe number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes.
pickupTaskBOOLEAN
OPTIONALWhether the task is a pickup task.
containerJSON
OPTIONALThe container to which to append this task. Defaults to the creator organization container.
autoAssignJSON
OPTIONALThe automatic assignment options for the newly created task. You may not provide a container if using automatic assignment.
quantityNUMBER
OPTIONALThe number of units to be dropped off while completing this task, for route optimization purposes.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication