The Onfleet API is a RESTful web service for developers and integrations to programmatically interact with Onfleet’s data and real-time delivery management and analytics functionality.

59 subscribers
41 endpoints
The in-depth APIMemo review for this API hasn't been published yet — the data below comes straight from the public marketplace listing.

OnFleet endpoints

MethodEndpointDescription
POST findRecipientByPhone
/findRecipientByPhone
Search for recipient by phone
POST cloneTask
/cloneTask
The property sourceTaskId can be used to keep track of the source task from which the task was cloned.
POST completeTask
/completeTask
Note that, for active tasks, only notes can be updated, while completed tasks cannot be updated in any way.
POST getDelegateeDetails
/getDelegateeDetails
Retrieve the details of an organization with which you are connected.
POST createAdministrator
/createAdministrator
Creates a new administrator in your organization. An email will be sent for this administrator to confirm and configure their account.
POST createDestination
/createDestination
Destinations represent the location details for tasks, including exact coordinate and address information.
POST createDestinationFromRaw
/createDestinationFromRaw
Destinations represent the location details for tasks, including exact coordinate and address information.
POST createRecipient
/createRecipient
A recipient is an organization’s customer and a target for a task, that is, whom the task is being delivered to.
POST createTask
/createTask
Create new task
POST createTeam
/createTeam
Teams are named entities that bring together administrators and workers belonging to the same organization. Teams have hubs from where its workers may start and end their shifts.
POST createWebhook
/createWebhook
Webhooks make it possible for your application to be notified of important system events, as soon as these take place within Onfleet.
POST createWorker
/createWorker
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.
POST deleteAdministrator
/deleteAdministrator
Deletes an administrator in your organization.
POST deleteTask
/deleteTask
Active or completed tasks cannot be deleted.
POST deleteTeam
/deleteTeam
Delete single team
POST deleteWebhook
/deleteWebhook
Delete single webhook
POST deleteWorker
/deleteWorker
Delete single worker by Id
POST findRecipientByName
/findRecipientByName
Search for recipient by name
POST getOrganizationDetails
/getOrganizationDetails
Retrieve your own organization's details.
POST getSingleDestination
/getSingleDestination
Get single destionation by Id
POST getSingleRecipient
/getSingleRecipient
Get single recipient
POST getSingleTask
/getSingleTask
Returns a single task by its id
POST getSingleTaskByShortId
/getSingleTaskByShortId
Returns a single task by its short id
POST getSingleTeam
/getSingleTeam
Get single team information
POST getSingleWorker
/getSingleWorker
Get single worker by Id
POST getWorkersByLocation
/getWorkersByLocation
List all available workers by coordinates
POST insertTasksAtIndex
/insertTasksAtIndex
You may insert one or more tasks at a given index by providing the index as the first element in the array, followed by the task IDs.
POST listAdministrators
/listAdministrators
Lists administrators
POST listHubs
/listHubs
A hub is a depot for a team: the location from where all deliveries start for the team's workers, for the purposes of route optimization only; teams can have zero or one hubs. To…
POST listTasks
/listTasks
Returns a paginated collection of all tasks in your organization.
POST listTeams
/listTeams
List all available teams.
POST listWebhooks
/listWebhooks
Get all webhooks
POST listWorkers
/listWorkers
List all available workers
POST testAuth
/testAuth
Check that your API key is valid.
POST updateAdministrator
/updateAdministrator
Updates an administrator in your organization.
POST updateRecipient
/updateRecipient
Update existing recipient.
POST updateTask
/updateTask
Note that, for active tasks, only notes can be updated, while completed tasks cannot be updated in any way.
POST updateTasks
/updateTasks
You may also fully replace a container's tasks by omitting the index and providing a complete list of task IDs.
POST updateTeam
/updateTeam
Update existing team
POST updateWorker
/updateWorker
Update existing worker
POST webhookEvent
/webhookEvent
This method is called every time when webhook event happens

OnFleet pricing

PlanPriceRate limitQuotas
BASIC Free

More Logistics APIs

View all →
  • Informação de rastreamento de pacotes dos Correios e outras transportadoras com dados atualizados sobre a…

    LogisticsFreemium374 subscribers
  • Official Postal Ninja tracking API for developers

    LogisticsFreemium887 subscribers
  • Benefit from the flexibility of accessing data through a 'pay per pull' model or opt for a subscription…

    LogisticsFreemium785 subscribers
  • With access to real-time air schedules, routes, availability and pricing data, transport the CargoAi…

    LogisticsFreemium648 subscribers
  • Argentina CPA es una API especializada en la búsqueda de Provincias, Localidades y Códigos Postales de…

    LogisticsFreemium58 subscribers
  • Track packages from over 600 couriers worldwide. Get shipment info easily from official site.

    LogisticsFree1.7k subscribers