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

    Entities

    Main Entities#

    Task

    Task#

    Tasks represent actions assigned to Drivers/Agents. In delivery businesses, Tasks have 2 stages - pickups and deliveries. Tasks can also include key attributes like size, value, delivery time, or eligible Drivers/Agents, which may impact optimization.
    In field service businesses, Tasks usually refer to services rather than physical items. These often require only a delivery location (the job site), as there's nothing to pick up.
    Pickup
    Dropoff
    Items
    An action that needs to be performed by the Driver, where the Driver is navigating to a specific location to perform a pickup of Tasks.
    Drivers/Agents

    Drivers/Agents#

    Drivers/Agents are entities that perform Task execution. Tasks are delegated to them based on set criteria. A proper Driver configuration means that Drivers need to have a defined schedule, Driver app login credentials, their Start and End location, and a Vehicle assigned to them. Drivers cannot execute Tasks if they are not assigned a Vehicle.
    Vehicles

    Vehicles#

    Vehicles cannot operate without Drivers, which means that even though they are separate entities, they cannot be considered for optimization without both being properly configured and connected. Vehicle information is crucial for optimization because the type of Vehicle the Driver/Agent drives will determine both how quickly they arrive at the Task destination and which roads they can take to get there.
    For a Vehicle to be properly configured, it only needs to have the defined capacity so that eLogii knows how much it can carry in one run.
    Customers

    Customers#

    Customers are entities in eLogii that represent the end-users you deliver to (or offer services to) or other businesses you work with. You can store multiple locations for one customer.
    Route

    Route#

    Routes are the result of an optimization, so all the Tasks that have been through the process of optimization and assigned to a Driver are considered as routes.
    Routes can be created either by letting eLogii decide how to delegate Tasks or by manually assigning Tasks to Drivers.
    Depot

    Depot#

    A Depot is a central location from which your Drivers start and end their Routes. A few examples of Depots are your warehouse, a central kitchen, main headquarters, or the home address of a specific Driver.
    Currently, Depot is a mandatory configuration option in eLogii, and it must be defined before you can start optimizing Routes. However, depots do not need to be used as part of optimization. In case you don't use depots at all, you can simply add your company address, for example. or any other address, and not define Depots as start/end locations for your Tasks and Drivers.
    Users

    Users#

    User accounts enable your team members to log in to eLogii and perform various actions. The actions users can perform will depend on the role they are assigned. The roles users can have are the following:
    Admin
    Manager
    Operator
    Customer Support
    Warehouse Operator.
    Teams

    Teams#

    Teams represent a group of specific Users and/or Drivers together, as well as their corresponding Tasks and Customers. Drivers and Users can also be assigned to multiple Teams. Drivers and Users will be included in all the operations and Tasks related to all the Teams they are members of.
    Zones

    Zones#

    Zones represent areas of operation for which specific rules apply. For example, specific Teams and/or Drivers can operate within some Zones, or different requirements should apply to Tasks that fall under certain Zones.

    Actions and Comments#

    Optimization

    Optimization#

    Running an optimization in eLogii generates the most efficient route plan for your Tasks, whether for a single day or across multiple days.
    eLogii supports two types of optimizations:
    Multiday Routes - span multiple days.
    You can also customize the optimization to prioritize different goals, making it adaptable to various business requirements.
    Single-day Routes
    Multiday Routes
    Planned to take one day to complete.
    Task Rules

    Task Rules#

    Task rules allow users to set up parameters and rules that will prompt the system to make desired changes to Tasks once they are in the system, provided that they contain elements that adhere to the preset rules.
    Single-segment Optimization

    Single-segment Optimization#

    Single-segment optimization is used in case all Tasks originate from Depots, which means there are no pickup actions required, and there's no need to reload at the Depot.
    Proof of Delivery/POD

    Proof of Delivery/POD#

    A set of predefined actions that Drivers need to perform to complete the Task.
    Failed Actions

    Failed Actions#

    Actions that need to be performed when failing a Task.
    Geofence

    Geofence#

    An imaginary radius of the Task location set by the dashboard user, which allows or forbids further actions to be performed by the Driver when within the proximity. Practically speaking, if a geofence radius is set to 100 meters, the Driver is unable to change the Task state or collect PODs unless they are within the 100-meter radius of the Task location.
    eLogii relies on external geocoding providers such as Google and Here Maps, which have the biggest and most up-to-date databases.

    Task Elements#

    Reference

    Reference#

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

    External ID#

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

    Type#

    Type of Task (see Pickup and Dropoff in Main Entities section)
    0
    1
    2
    pickup (pick up from location and return to end location/depot)
    Allowed Week Days

    Allowed Week Days#

    Refers to the exact days of the week when the Task can be scheduled within the specified date range. The corresponding values are Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    Frequency

    Frequency#

    Describes the frequency of Task occurrence within the specified date range. For example, setting the frequency to 4 will create the Task 4 times within the defined time frame.
    frequencyDateRange - Date range for the frequency to apply.
    startDate - Start of the date range.
    endDate
    End of the date range.
    Time Windows

    Time Windows#

    Time windows in which the driver needs to arrive at this Task's location. The values are numbers representing minutes from the start of the day - e.g., 8:00 am is 8 * 60 = 480, 12:30 pm is 750. The values are expressed in minutes.
    Start
    End
    Represents the start of the time window. Values from 0 - 1440.
    Modified at 2025-11-12 16:33:16
    Previous
    Introduction
    Next
    FAQs
    Built with