1. Drivers
eLogii
  • Introduction
  • Entities
  • FAQs
  • Query parameters
  • Webhooks
  • Tasks
    • Task Elements
    • createOrUpdateMany
      POST
    • Get tasks
      GET
    • Create tasks
      POST
    • Delete tasks
      POST
    • Update a task
      PUT
    • Get Proof of Delivery
      GET
    • Cancel tasks
      POST
    • Post Tasks Create Return
      POST
    • Move tasks to another date
      POST
    • postTasksReattempt
      POST
    • Start tracking a task (webhook)
      POST
  • Drivers
    • Driver Elements
    • Get drivers
      GET
    • Create multiple drivers
      POST
    • Update drivers
      POST
    • Delete drivers
      POST
  • Customers
    • Customer Elements
    • Get customers
      GET
    • Create customers
      POST
    • Update customers
      POST
    • Delete customers
      POST
  • Depots
    • Depot Elements
    • Get depots
    • Create depots
    • Update depots
    • Delete depots
  • Driver-schedule-exceptions
    • Driver-schedule-exception elements
    • Get all exceptions
    • Get schedule exception for a specific driver
    • Update a schedule exception
    • Create multiple schedule exceptions
    • Delete multiple schedule exceptions
  • Route-template-groups
    • Route-template-groups elements
    • Get route template groups
    • Create a route-template-group
    • Update a route template group
    • Delete multiple route template groups
    • Schedule for dates
  • Routes
    • Route Elements
    • Get routes
    • Clear route(s)
    • Lock route(s)
    • Unlock route(s)
    • Set planned ETAs
    • Setting the task order
  • Task-template-groups
    • Task-template-groups Elements
    • Get task-template-groups
    • Create task-template-groups
    • Get one task-template-group by _id
    • Update task-template-group
    • Delete one task-template-group
    • Delete multiple task-template-groups
    • Schedule task-template-groups for dates
    • Add tasks to group
  • Vehicles
    • Vehicle Elements
    • Create multiple vehicles
    • Get vehicles
    • Update multiple vehicles
    • Delete multiple vehicles
  • Zones
    • Zones Elements
    • getZones
    • postZones
    • putZones_id
    • deleteZones_id
  • Optimization
    • Optimization Elements
    • Run optimization for provided data set
    • Run optimization for one or multiple dates
    • Run optimization for one or multiple existing routes
    • Optimize tasks in a period (e.g. 1 month), where some of the tasks have varying intervals - e.g. weekly, every 2 weeks, monthly
    • Run optimization for a date range
  • Forms
    • Get all forms
    • Create and design a form
    • Update many forms
    • Delete many forms
  • Form submissions
    • Get all form submissions
    • Get a specific form's submissions
    • Update many form submissions
    • Delete many form submissions
  1. Drivers

Driver Elements

External ID#

externalId - Used for various purposes, usually as a tracking code for a driver, or to store internal driver-related information. It is not a unique value.

Reference#

reference - Reference from your external system. Additional custom data can be saved using the customData field.

User Information#

userInfo - contains information about user login credentials.
username - used to log in to the driver app in combination with the set password.
password - used to log in to the driver app in combination with the set username.

First Name#

firstName - Required field. Indicates the displayed name of the driver.

Last name#

lastName - Indicates the last name of the driver.

Photo#

photo - Contains the information about the profile photo of the driver.
url - Contains the URL of the driver’s profile photo.

Phone number#

mobile - Stores information about the phone number the driver uses for communication.
mobile2 - Stores information about the secondary phone number the driver uses for communication.

Email#

email - Stores the driver’s email address.

Vehicle#

vehicle - Stores the assigned vehicle’s ID.

Vehicle Information#

vehicleInfo - Stores additional information about the vehicle assigned.
uid - This is a unique code that eLogii assigns each vehicle upon creation.
name - Indicates the name of the vehicle.
category - indicates the whether the vehicle is a pedestrian, largeTruck, truck, largeVan, bicycle, motorcycle, car or pickup.
vehicleTypeUID - Unique code for the preset specifications for a particular subset of vehicle fleet.
vehicleTypeName - Indicates the name of the vehicle type.
capacity - Maximum capacity defined for the vehicle.
capabilities - Indicates the vehicle attributes set. They ensure that certain tasks requiring are only optimized to the relevant vehicles.
Cost -
perHour - Hourly vehicle cost.
perDay - Daily vehicle cost.
perKM - Vehicle cost per distance.

Start Location#

startLocation - Contains fields used to specify the start location of the driver, i.e. the starting point of their route.
type -Enums that indicate the type of location
0
1
2
3
Predefined depot, used in conjunction with uid field for depot UID.
uid - Required for types 0 and 1 – unique identifier of the depot or customer location
name - Shows the displayed name of the location
address - Contains the address of the location
addressLine2 - Contains the 2nd address of the location
postCode - Contains the location post code
city - Contains the location city
country - Contains the country of the location
what3words - Contains the what3words location coordinates of the location
coordinates - Contains the location coordinates. Format: [longitude, latitude]
contactName - Stores the contact name
contactPhone - Stores the contact phone number
contactEmail - stores the contact email address
setupDuration - Setup and service duration define the time needed to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Setup duration only applies to the first task at a location. Any value set here overrides the default set in Configuration → Optimization.
serviceDuration - Setup and service duration define how long it takes to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Service duration is always added to the total stop time, even if other tasks exist at the same location. Any value set here overrides the default set in Configuration → Optimization.
customerId - contains the customer id.
customerUID - contains the customer UID.

End location#

endLocation - Contains fields used to specify the end location of the driver.
type -Enums that indicate the type of location
0
1
2
3
Predefined depot, used in conjunction with uid field for depot UID.
uid - Required for types 0 and 1 – unique identifier of the depot or customer location
name - Shows the displayed name of the location
address - Contains the address of the location
addressLine2 - Contains the 2nd address of the location
postCode - Contains the location post code
city - Contains the location city
country - Contains the country of the location
what3words - Contains the what3words location coordinates of the location
coordinates - Contains the location coordinates. Format: [longitude, latitude]
contactName - Stores the contact name
contactPhone - Stores the contact phone number
contactEmail - stores the contact email address
setupDuration - Setup and service duration define the time needed to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Setup duration only applies to the first task at a location. Any value set here overrides the default set in Configuration → Optimization.
serviceDuration - Setup and service duration define how long it takes to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Service duration is always added to the total stop time, even if other tasks exist at the same location. Any value set here overrides the default set in Configuration → Optimization.
customerId - contains the customer id
customerUID - contains the customer UID

Depots#

depots - Contains a list of _ids of depots this driver can serve.

Skills#

skills - Skills enable you to make sure certain tasks requiring specific skills are only matched with the relevant driver / drivers with the skill.

Zone#

zones - Contains list of _ids of zones this driver is assigned to. If assigned to a specific Zone, Drivers will only be able to perform tasks that fall under the assigned zones.

Tags#

tags - User-generated entity labels used for filtering and analytics.

Teams#

teams - If assigned to a specific team /teams, drivers will only be assigned to tasks that can be handled by the assigned teams.

Notes#

notes - Contains additional Driver-related information.

Speed Factor#

speedFactor - Decimal factor that specifies how the driver’s speed differs from the baseline.
📌
Example: 2.0 = 2x faster, 0.5 = 2x slower.

Route Stop Limit#

routeStopLimit - Limits the maximum number of stops a route for this driver can contain, excluding the start and end location. It can be used on both engines.

Route Distance Limit#

routeDistanceLimit - Limits the maximum total route distance for this driver. Available on both engines.

Route Duration Limit#

routeDurationLimit - Limits the maximum total route duration for this driver. Advanced engine-exclusive feature.

Route Travel Limit#

routeTravelLimit - Limits the maximum total travel time during this driver’s route. Available on the Base engine.

Overtime Tolerance#

overtimeTolerance - Specifies the allowed time after the end of the driver’s schedule that routes can extend to if more optimal.

Device Data#

deviceData - Contains the information on the driver's device used for app login.

Settings#

settings - contains information regarding specific actions on a driver level
startTasksInAnyOrder - Whether the driver can execute tasks in any order they want (by default False)
enableLoadedState - Whether the driver can set a Loaded state for a Task (False by default)

Flags#

flags - Driver-specifics.
isExcludedFromOpti- Whether or not the driver should be eligible for route optimization. Default: false
isAutoOptiDisabled - Default: false
isAutoRoutingDisabled - Default: false
isUnconstrained -Whether or not the driver has no constraints. Default: false
isBusy- Default: false
isAccountDisabled - Default: false
isTestDriver - Default: false
hasAvatar - Default: false
isAvatarAwaitingApproval - Default false

Cost#

cost - Stores information on the driver’s hourly/daily rate.
perHour - Hourly driver cost.
perDay - Daily driver cost.

Rating#

rating - Stores information about individual driver ratings per executed task.
taskId - Required field. Contains the ID of the task that has the driver’s rating.
taskUID - Required field. Contains the UID of the task that has the driver’s rating.
rate - Contains the given rating. Default: 0
comment - Additional comment provided by the customer when rating the driver.
timestamp - Information about when the rating was given.

Custom Data#

customData - Holds additional reference, external IDs, or any other desired data.

Route colors#

routeColors - Contains information about the driver’s route color.

Schedule#

Single-day Route Schedule
schedule - For routes that are meant to be completed within 1 day. Contains the start and end time of a driver for each day of the week. The allowed format on the dashboard is hh:mm-hh:mm (e.g, 8:00-17:00) however this is indicated in minutes in the payload.
Mon
Tue
Wed
Thur
Fri
Sat
Sun
timeWindows
start -Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880

Multiday Route Schedule#

multiDaySchedule - For routes that are meant to be completed within multiple days. Contains the start and end time of a driver for each day of the week. The allowed format on the dashboard is hh:mm-hh:mm (e.g, 8:00-17:00), however this is expressed in minutes in the payload.
maxMultiDayRouteDays - The maximum number of days a driver can be on the road.

Schedule Exceptions#

Schedule exceptions are temporary schedule overrides that are applied to drivers’ schedules within a specific period. After that period passes, the driver’s schedule will follow the default setup..
reference - text value which can be used to query a schedule exception.
driver - Contains driver information.
id - driver ID which can be found on the driver's profile.
uid-This is a unique code that eLogii assigns each driver upon creation and can be found on the driver's profile.
reference- The driver reference also available on the driver's profile.
dateRange - The span over which the exception takes effect. Required field.
startDate - required field. Marks the start date of the exception. Format YYYYMMDD
endDate - required field. Marks the end date of the exception. Format YYYYMMDD
description - Information about what the exception is for.
dayOff - Whether the exceštion means the driver won’t be working. Default: false. if true, the driver will be temporarily disabled from optimization.
overrides - Specific overrides which will temporarily be applied.
schedule - Schedule overrides
timeWindows
start -Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880
breaks
timeWindow
start - Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880
offset - Break offset from route start.
start - Expressed in minutes. 0…1440
end - Expressed in minutes. 0…2880
duration - The duration of the break. (in minutes)
skills - Temporary override of the skills the driver possesses.
maxMultiDayRouteDays - The maximum number of days the driver can be on the road when doing multiday routes.
startLocation - Contains fields used to specify the start location of the driver, i.e. the starting point of their route.
type - Enum indicating the type of task location:
0
1
2
3
Predefined depot, used in conjunction with uid field for depot UID.
uid - Required for types 0 and 1 – unique identifier of the depot or customer location
address - Contains the address of the location
addressLine2 - Contains the 2nd address of the location
postCode - Contains the location post code
city - Contains the location city
country - Contains the country of the location
what3words - Contains the what3words location coordinates of the location
coordinates - Contains the location coordinates. Format: [longitude, latitude]
contactName - Stores the contact name
contactPhone - Stores the contact phone number
contactEmail - stores the contact email address
setupDuration - Setup and service duration define the time needed to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Setup duration only applies to the first task at a location. Any value set here overrides the default set in Configuration → Optimization.
serviceDuration - Setup and service duration define how long it takes to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Service duration is always added to the total stop time, even if other tasks exist at the same location. Any value set here overrides the default set in Configuration → Optimization.
customerId - contains the customer id
customerUID - contains the customer UID
meta - Contains metadata.
comments
userId
text
timestamp
originalCoordinates Format [longitude, latitude]
overriden
endLocation - Contains fields used to specify the end location of the driver, i.e., the starting point of their route.
type - Enum indicating the type of task location:
0
1
2
3
Predefined depot, used in conjunction with uid field for depot UID.
uid - Required for types 0 and 1 – unique identifier of the depot or customer location.
name - Shows the displayed name of the location.
address - Contains the address of the location.
addressLine2 - Contains the 2nd address of the location.
postCode - Contains the location post code.
city - Contains the location city
country - Contains the country of the location
what3words - Contains the what3words location coordinates of the location
coordinates - Contains the location coordinates. Format: [longitude, latitude]
contactName - Stores the contact name
contactPhone - Stores the contact phone number
contactEmail - stores the contact email address
setupDuration - Setup and service duration define the time needed to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Setup duration only applies to the first task at a location. Any value set here overrides the default set in Configuration → Optimization.
serviceDuration - Setup and service duration define how long it takes to complete a task at the pickup location (e.g., 10 minutes to drop off a delivery or 30 minutes to replace equipment). Service duration is always added to the total stop time, even if other tasks exist at the same location. Any value set here overrides the default set in Configuration → Optimization.
customerId - contains the customer id
customerUID - contains the customer UID
meta - Contains metadata.
comments
userId
text
timestamp
originalCoordinates Format [longitude, latitude]
overriden
Modified at 2025-11-24 18:36:02
Previous
Start tracking a task (webhook)
Next
Get drivers
Built with