• Installs:
  • Today: 0
  • All Time: 7013
Developer:userstefan.skliarov

OnFleet API Package

Real-time delivery management and analytics functionality.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

OnFleet

OnFleet Package

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.

  • Domain: OnFleet
  • Credentials: apiKey

How to get credentials:

  1. Please contact OnFleet directly for apiKey

Webhook credentials

Please use SDK to test this feature.

  1. Go to RapidAPI
  2. Log in or create an account
  3. Go to My apps
  4. Add new project with projectName to get your project Key
FieldTypeDescription
projectNamecredentialsYour RapidAPI project name
projectKeycredentialsYour RapidAPI project key

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

OnFleet.testAuth

Check that your API key is valid.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet

OnFleet.getOrganizationDetails

Retrieve your own organization's details.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet

OnFleet.getDelegateeDetails

Retrieve the details of an organization with which you are connected.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
organizationIdStringId of the organization

OnFleet.createAdministrator

Creates a new administrator in your organization. An email will be sent for this administrator to confirm and configure their account.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
nameStringThe administrator’s complete name.
emailStringThe administrator’s email address.
phoneStringThe administrator's phone number.
isReadOnlyStringWhether this administrator can perform write operations.

OnFleet.listAdministrators

Lists administrators

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet

OnFleet.updateAdministrator

Updates an administrator in your organization.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
administratorIdStringThe administrator’s id
nameStringThe administrator’s complete name.
emailStringThe administrator’s email address.
phoneStringThe administrator's phone number.
isReadOnlyStringWhether this administrator can perform write operations.

OnFleet.deleteAdministrator

Deletes an administrator in your organization.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
administratorIdStringThe administrator’s id

OnFleet.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.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
nameStringThe worker’s complete name.
phoneStringA valid phone number as per the worker’s organization’s country.
teamsListOne or more team IDs of which the worker is a member.
vehicleJSONThe worker’s vehicle; providing no vehicle details is equivalent to the worker being on foot.
capacityNumberThe maximum number of units this worker can carry, for route optimization purposes.

OnFleet.listWorkers

List all available workers

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
teamsListAn array of the team IDs that workers must be part of.
filterListAn array of fields to return, if all are not desired. For example, name, location.
statesListAn array of worker states, where 0 is off-duty, 1 is idle (on-duty, no active task) and 2 is active (on-duty, active task).

OnFleet.getWorkersByLocation

List all available workers by coordinates

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
coordinatesMapLongitude and latitude coma-separated
radiusNumberThe length in meters of the radius of the spherical area in which to look for workers. Defaults to 1000 if missing. Maximum value is 10000.

OnFleet.getSingleWorker

Get single worker by Id

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
workerIdStringId of the worker
filterListAn array of fields to return, if all are not desired. For example, name, location.

OnFleet.updateWorker

Update existing worker

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
workerIdStringId of the worker
nameStringThe worker’s complete name.
teamsListOne or more team IDs of which the worker is a member.
vehicleJSONThe worker’s vehicle; providing no vehicle details is equivalent to the worker being on foot.
capacityNumberThe maximum number of units this worker can carry, for route optimization purposes.

OnFleet.deleteWorker

Delete single worker by Id

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
workerIdStringId of the worker

OnFleet.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 create hubs, head over to the dashboard.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet

OnFleet.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.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
nameStringA unique name for the team.
workersListAn array of worker IDs.
managersListAn array of managing administrator IDs.
hubStringThe ID of the team's hub.

OnFleet.updateTeam

Update existing team

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
teamIdStringA unique id of the team
nameStringA unique name for the team.
workersListAn array of worker IDs.
managersListAn array of managing administrator IDs.
hubStringThe ID of the team's hub.

OnFleet.listTeams

List all available teams.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet

OnFleet.getSingleTeam

Get single team information

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
teamIdStringSingle team id

OnFleet.deleteTeam

Delete single team

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
teamIdStringSingle team id

OnFleet.createDestination

Destinations represent the location details for tasks, including exact coordinate and address information.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
addressNameStringA name associated with this address.
addressNumberStringThe number component of this address, it may also contain letters.
addressStreetStringThe name of the street.
addressApartmentStringThe suite or apartment number, or any additional relevant information.
addressCityStringThe name of the municipality.
addressStateStringThe name of the state, province or jurisdiction.
addressPostalCodeStringThe postal or zip code.
addressCountryStringThe name of the country.
coordinatesMapThe longitude, latitude coma-separated. If missing, the API will geocode based on the address details provided. Note that geocoding may slightly modify the format of the address properties.

OnFleet.createDestinationFromRaw

Destinations represent the location details for tasks, including exact coordinate and address information.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
unparsedStringA complete address specified in a single, unparsed string where the various elements are separated by commas.

OnFleet.getSingleDestination

Get single destionation by Id

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
destinationIdStringId of the destination

OnFleet.createRecipient

A recipient is an organization’s customer and a target for a task, that is, whom the task is being delivered to.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
nameStringThe recipient’s complete name.
phoneStringA unique, valid phone number as per the recipient’s organization’s country.
notesStringNotes for this recipient: these are global notes that should not be task- or destination-specific.
skipSMSNotificationsBooleanWhether this recipient has requested to not receive SMS notifications. Defaults to false if not provided.
skipPhoneNumberValidationBooleanWhether to skip validation of this recipient's phone number. An E.164-like number is still required (must start with +), however the API will not enforce any country-specific validation rules.

OnFleet.updateRecipient

Update existing recipient.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
recipientIdStringThe recipient’s id
nameStringThe recipient’s complete name.
phoneStringA unique, valid phone number as per the recipient’s organization’s country.
notesStringNotes for this recipient: these are global notes that should not be task- or destination-specific.
skipSMSNotificationsBooleanWhether this recipient has requested to not receive SMS notifications. Defaults to false if not provided.
skipPhoneNumberValidationBooleanWhether to skip validation of this recipient's phone number. An E.164-like number is still required (must start with +), however the API will not enforce any country-specific validation rules.

OnFleet.findRecipientByPhone

Search for recipient by phone

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
phoneStringA unique, valid phone number as per the recipient’s organization’s country.

OnFleet.findRecipientByName

Search for recipient by name

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
nameStringThe recipient’s name.

OnFleet.getSingleRecipient

Get single recipient

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
recipientIdStringThe recipient’s id.

OnFleet.createTask

Create new task

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
merchantStringThe 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.
executorStringThe 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.
destinationIdStringThe ID of the task's destination
recipientsIdsListAn array containing zero or one IDs of the task's recipients
completeAfterDatePickerA date Y-m-d H:m :s for the earliest time the task should be completed.
completeBeforeDatePickerA date Y-m-d H:m :s for the latest time the task should be completed.
pickupTaskBooleanWhether the task is a pickup task.
dependenciesListOne or more IDs of tasks which must be completed prior to this task.
notesStringNotes for the task.
autoAssignJSONThe automatic assignment options for the newly created task. You may not provide a container if using automatic assignment.
containerJSONThe container to which to append this task. Defaults to the creator organization container.
quantityNumberThe number of units to be dropped off while completing this task, for route optimization purposes.
serviceTimeNumberThe number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes.

OnFleet.listTasks

Returns a paginated collection of all tasks in your organization.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
fromDatePickerThe starting time of the range.
toDatePickerIf missing, defaults to the current time. The ending time of the range. Tasks created or completed before this time will be included.
lastIdStringUsed to walk the paginated response, if there is one. Tasks created after this ID will be returned.

OnFleet.getSingleTask

Returns a single task by its id

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
taskIdStringId of the task

OnFleet.getSingleTaskByShortId

Returns a single task by its short id

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
taskShortIdStringShort id of the task

OnFleet.updateTask

Note that, for active tasks, only notes can be updated, while completed tasks cannot be updated in any way.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
taskIdStringId of the task
notesStringTask notes

OnFleet.completeTask

Note that, for active tasks, only notes can be updated, while completed tasks cannot be updated in any way.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
taskIdStringId of the task
successBooleanWhether the task's completion was successful.
notesStringAny completion notes for the task.

OnFleet.cloneTask

The property sourceTaskId can be used to keep track of the source task from which the task was cloned.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
taskIdStringId of the task

OnFleet.deleteTask

Active or completed tasks cannot be deleted.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
taskIdStringId of the task

OnFleet.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.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
containerTypeSelectType of the container to insert
entityIdStringId of the container of provided type
indexStringTo append to the end, use -1 as your index. To prepend, use 0. For example, if you want to insert two tasks at position 3 for a given worker, such that all currently assigned tasks at index >= 3 are shifted forward
tasksListArray of tasks to insert

OnFleet.updateTasks

You may also fully replace a container's tasks by omitting the index and providing a complete list of task IDs.

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
containerTypeSelectType of the container to insert
entityIdStringId of the container of provided type
tasksListArray of tasks to insert
considerDependenciesBooleanWhether to include the target task's dependency family (parent and child tasks) in the resulting assignment operation.

OnFleet.createWebhook

Webhooks make it possible for your application to be notified of important system events, as soon as these take place within Onfleet.

You can use our service as url:

https://webhooks.rapidapi.io/api/message/OnFleet/webhookEvent/{projectName}/{projectKey} * see credentials description above
FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
urlStringThe URL that Onfleet should issue a request against as soon as the trigger condition is met.
triggerNumberThe number corresponding to the trigger condition on which the webhook should fire: http://docs.onfleet.com/docs/webhooks
thresholdNumberFor trigger 1, the time threshold in seconds; for trigger 2, the distance threshold in meters.

OnFleet.listWebhooks

Get all webhooks

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet

OnFleet.deleteWebhook

Delete single webhook

FieldTypeDescription
apiKeycredentialsApi key obtained from OnFleet
webhookIdStringId of the webhook
x
circle
OnFleet
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view