1. Tasks
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. Tasks

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#

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

Allowed Week Days#

allowedWeekDays - 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#

timeWindows - 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 - Represents the start of the time window. Values from 0 - 1440.
end - Represents the end of the time window. Values from 0 - 2880.
The time window start time value must always be smaller than the time window end value.

Date#

date -Represents the day when the Task needs to be completed. YYYYMMDD is the acceptable readable format for import.

Date range#

dateRange - Represents the range of dates during which the Task can be performed.YYYYMMDD is the acceptable readable format for import.
startDate - signifies the start of the range.
endDate - signifies the end of the range.

Priority#

priority - This allows you to prioritize some Tasks over others in terms of which ones should be completed before others. The higher the number, the higher the priority. The range can be from 0 to 1000.

UID#

uid - Unique Task ID generated by eLogii on Task creation. No two Tasks can have the same UID.

Product code#

productCode - This is where you enter the product barcode number, which Drivers scan on pickup/delivery.

Internal comment#

internalComment - Comment related to a Task only visible to the operations team on eLogii. Drivers cannot see the internal comment in the Driver app.

Size#

Task size, specified as an object with values given for any/all configured dimensions (Configuration -> Dimensions). The Task size is up to the customer to define. Configuration of multiple dimensions is available to customers using the Professional plan or higher.

Items#

Usually, items are used to denote delivery items contained within one Task. One delivery can have a multitude of items that you can keep track of both in terms of their state and proof of delivery. Items are most commonly used in cases where there are multiple packages meant to be delivered to the same location.
uid - Auto-generated unique ID when an item gets created in eLogii.
id - User-provided identifier, used for matching which pickup items go to which dropoff task. If not provided, an auto-generated value will be used.
description - Provides a description that will be used in all places where items are listed. This field is most commonly used to specify the item’s name.
code - Barcode or 5-digit security code that has to match with scan/input from the driver
instructions - Any additional instructions to the driver, specific to this item.
Configuration
Options relating to pickup/delivery actions which will override the options set in Configuration.
actions
pickup - Actions for the entity (task or task item) at pickup
type
0
1
2
3
4
5
6
identity code
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it in order to proceed
delivery - Actions for the entity (task or task item) at delivery
type
0
1
2
3
4
5
6
identity code
warehouse - Actions for the entity (task or task item) at the warehouse
applyItemActionsToTaskWhenNoItems - Apply actions defined for task items to the task itself, when it contains no items

Assignments state enums#

unviable: -10
unassigned: 0
assigned: 10
assignedManually: 20

Customer#

Links this task to a predefined customer, for filtering, grouping, and analytics purposes
_id - Id of the customer
uid - UID of the customer
reference - reference attributed to the customer
externalId - external ID assigned to the customer

Skills#

skills - Specifies skills that a driver is required to have to be matched to this task

Capabilities#

capabilities - Specifies capabilities that a vehicle is required to have to be matched to this task

Tags#

tags - Task tags, which can be used for filtering, grouping and analytics purposes

Teams#

teams - Contains _ids of teams to which this task belongs. Teams let you group specific Users and/or Drivers along with their related Tasks and Customers. A Driver or User can belong to multiple Teams, and they will automatically be included in all operations and Tasks linked to each Team they’re part of.

Zones#

zones - Contains _ids of zones to which this task belongs. 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.

State#

state - Enum: -30 -20 -10 0 2 4 5 10 20 30 40 50 60
State of task:
-30: cancelled
-20: failed
-10: pickup failed
0: created / scheduled
4: sorted
5: loaded
10: en route to pickup
20: arrived to pickup
30: completed pickup
40: en route to delivery / service location
50: arrived to delivery / service location
60: completed

Setup duration#

setupDuration - Setup and service duration define how long a task takes at the pickup location (e.g., 10 min to drop off, 30 min for equipment replacement). The setup duration applies only to the first task at a location. Task-specific values override the default set in Configuration → Optimization in the Dashboard

Service Duration#

serviceDuration - Setup and service duration define how long a task takes at the pickup location (e.g., 10 min drop-off, 30 min equipment replacement). Service duration always adds to the total stop time, even if other tasks are at the same location. Task-specific values override the default in Configuration → Optimization on the Dashboard.

Order Value#

orderValue - The estimated value of the Task. For example, how much the delivery items cost, or how much the recipient needs to pay to receive the items.

Product Code#

productCode - Product identifier or value for barcode scanning

Configuration#

configuration - Configuration options for the pickup and delivery segment of the task. This influences which POD and failed actions will apply to tasks.
actions - Define the Proof of Delivery actions that will apply, and they are the following:
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task.
Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
meta -
failedActions - Overrides default configuration for security actions needed for this segment of the task (e.g., signature, photo, barcode scan...)
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task. - Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it in order to proceed
meta -
failedActionList - List of failed actions for a particular segment (pickup/delivery) of the task.
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task.
Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
meta
issues - Overrides default configuration for available options in case task cannot be completed (e.g., call recipient directly, return...)
contactSupport - Allows the driver to contact the configured support/operations team numbers through voice call/message in case of problems
enabled - whether the option is enabled
usePhone
useMessage
contactDirect - Allows the driver to call the specified contacts at pickup/dropoff in case of problems
enabled - whether the option is enabled
callPickupContact
callDeliveryContact
safePlace - Allows the driver to be instructed to leave the packages in a safe place instead
enabled - whether the option is enabled
instructions - Instructions for the driver for the safe place
failTask - Gives the driver the ability to mark the task as failed themselves, and continue to the next ones in their route
enabled - Whether the option is enabled
pickup
delivery
failedReasons - List of predefined reasons for Task failure.
pickup
delivery
customReason - Enabled drivers to enter a custom task failure reason.
pickup
delivery
reattempts - Enables the driver to reattempt a task.
enabled
endOfRoute
timeWindows
return - If the task has failed, this option dictates should a return should be automatically created, to which location (originating location, or a custom one), and which actions are needed at return
enabled
autoCreateReturnTask
taskFail - If reattempts are enabled for the task, the return task will not be created if the task fails
reattemptFail - Create a return task if reattempts fail
dateChange - If the task is picked up and the date is changed, create a return task for the task's original date
returnLocation - The default is the pickup location; however, that can be adjusted.
actions - POD actions
customActions - Custom POD actions for both pickup and delivery
pickup
type - Enum: 0 1 2 3 4 5 6 7 8.
Type of action:
0
1
2
3
4
5
6
identity code
typeText
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
meta
delivery
type - Enum: 0 1 2 3 4 5 6 7 8.
Type of action:
0
1
2
3
4
5
6
identity code
typeText
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
notifications - Notifications sent to pickup and/or delivery contact, or to depot contact.
delivery
pickup
depot
skipWebhooks - Enables preventing webhooks for this task from being triggered
support - Support information shown for the task.
companyName
customerPhone
customerEmail
alphanumericSenderID

Instructions#

instructions - Provides additional instructions to the driver that can be viewed from the driver app about the Task that’s being executed.

Notes#

notes - Additional Task information which is only visible through eLogii dash.

Locked#

locked - Indicates whether the task is locked to the currently assigned driver (usually by being assigned to a driver manually). Once a Task is assigned, it can be locked so that it doesn’t get transferred to a different route when reoptimizing. It will still be able to shift around within the route.

Rating#

rating - Contains rating information if the task was rated from the tracking screen
rate - Rating given
comment - Additional comment provided
timestamp

Custom data#

customData - Stores additional information about the Task. Custom data allows adding additional data fields for use throughout various entities within eLogii.

Failed Reason#

failedReason - If this task was marked failed by the assignee, it contains the entered/selected reason. A list of selectable reasons in the Driver app before failing the Task can be configured in eLogii, and later retrieved through the API.

Internal Comment#

internalComment - Provides a place to store any kind of internal comments about this task

Display#

display - Contains display task information. This relates to how Tasks are displayed on the map in the eLogii dashboard.
backgroundColor - Specifies the background color of the task when being displayed on the operations map
borderColor - Specifies the border color of the task when being displayed on the operations map
routeTimelineColor - Specifies the color of the task on the route timeline

Tolerance#

earlinessTolerance - Indicates how early a driver can be to the task. Expressed in minutes.
latenessTolerance - Indicates how late a driver can be to the task. Expressed in minutes.

Warehouse Operations#

warehouseOperations - Information regarding warehouse operations. Warehouse Operations allows warehouse staff to manage their Tasks directly in the eLogii Dashboard. Workflows can be designed to match different needs; each one can have its own tailored workflow.
state - Warehouse operations state
workflows - Information regarding the workflows that items go through in warehouse operations.
assignee
assigneeName
assignedBay
actions
uid
type
state
parent
code
label
taskId
itemUID
workflow
workflowName
history - Relates to information on specific actions taken for tasks within the warehouse operations module.
data
actor - information on the user executing a specific action.
userId - the user UID
userLevel - the level of the user (e.g., admin, manager, etc.)
actorId - ID of the actor
deviceId - ID of the device used to perform the action
geolocation - geolocation of the actor
action - action performed
email - actor’s email address
event - event that occurred
timestamp - when the action occurred
receivedAt

Pickup#

Starting location of the Task. In field service use cases, this information can be omitted. For delivery use cases, it is mandatory.
location - Contains fields used to specify the location of the pickup. Pickup location is optional if this task is a delivery. If the configuration assumes a mandatory pickup step, and no pickup location is set, it will be set to your first configured depot location.
type - Type of task location:
0: predefined depot, used in conjunction with uid field for depot UID
1: predefined customer location, used in conjunction with uid field for customer location UID
2: custom location defined by address details and coordinates
3: last known driver location (applicable to driver start/end locations)
uid - Required for types 0 and 1 - unique identifier of the depot or customer location. UIDs are generated by eLogii on entity/location creation.
name - The name of the pickup location. E.g., Walmart, Tesco…
address - The exact address of the location.
addressLine2 - The 2nd address.
postCode - the exact location postcode.
city- The city where the address is located.
country - The country of the location address.
what3words - What3Words code of the location.
contactName - The name of the contact person for the pickup location.
contactPhone - The phone number of the contact person for the location.
contactEmail - The email of the contact person for the location.
setupDuration - Setup duration and service duration specify the time needed to complete the task once at the pickup location - e.g., it will take 10 minutes to drop off the delivery, or 30 minutes on site to replace the equipment. The setup duration time for an individual task will not be required if there are already other tasks at that location, only for the first task. Specifying this value for a task will override the default value, which can be managed from Configuration -> Optimization screen in the Dashboard app.
serviceDuration - Setup duration and service duration specify the time needed to complete the task once at the pickup location - e.g., it will take 10 minutes to drop off the delivery, or 30 minutes on site to replace the equipment. Service duration time for an individual task will be added to the total stop time, even if there are already other tasks at that location. Specifying this value for a task will override the default value, which can be managed from Configuration -> Optimization screen in the Dashboard app.
customerId - If the pickup location is tied to a customer location, the customer ID should be specified here.
customerUID - If the pickup location is tied to a customer location, the customer UID should be specified here.
coordinates - Format [longitude, latitude]. Required for type 2 - coordinates of location.
timeWindows - Time windows in which the driver needs to arrive at this task's pickup 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. Time windows need to have a start and an end time. (start and end)
configuration - Configuration options for the pickup and delivery segment of the task. This influences which POD and failed actions will apply to tasks.
actions - Define the Proof of Delivery actions that will apply, and they are the following:
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task.
Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
meta -
failedActions - Overrides default configuration for security actions needed for this segment of the task (e.g., signature, photo, barcode scan...)
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task. - Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it in order to proceed
meta -
failedActionList - List of failed actions for a particular segment (pickup/delivery) of the task.
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task.
Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
instructions - Provides additional pickup instructions to the driver.
rating - Contains rating information for this segment of the task
rate - Rating given by the recipient
comment - Additional comment provided
timestamp - date of the given rate

Dropoff/Delivery#

End location of the Task.
location - Contains fields used to specify the location of the task. Location is optional if this task is a pickup (in which case pickup location must be set). If the configuration assumes a mandatory delivery step, and no location is set, it will be set to your first configured depot location.
location - Contains fields used to specify the location of the pickup. Pickup location is optional if this task is a delivery. If the configuration assumes a mandatory pickup step, and no pickup location is set, it will be set to your first configured depot location.
type - Type of task location:
0: predefined depot, used in conjunction with uid field for depot UID
1: predefined customer location, used in conjunction with uid field for customer location UID
2: custom location defined by address details and coordinates
3: last known driver location (applicable to driver start/end locations)
uid - Required for types 0 and 1 - unique identifier of the depot or customer location. UIDs are generated by eLogii on entity/location creation.
name - The name of the pickup location. E.g., Walmart, Tesco…
address - The exact address of the location.
addressLine2 - The 2nd address.
postCode - the exact location postcode.
city- The city where the address is located.
country - The country of the location address.
what3words - What3Words code of the location.
contactName - The name of the contact person for the pickup location.
contactPhone - The phone number of the contact person for the location.
contactEmail - The email of the contact person for the location.
setupDuration - Setup duration and service duration specify the time needed to complete the task once at the pickup location - e.g., it will take 10 minutes to drop off the delivery, or 30 minutes on site to replace the equipment. The setup duration time for an individual task will not be required if there are already other tasks at that location, only for the first task. Specifying this value for a task will override the default value, which can be managed from Configuration -> Optimization screen in the Dashboard app.
serviceDuration - Setup duration and service duration specify the time needed to complete the task once at the pickup location - e.g., it will take 10 minutes to drop off the delivery, or 30 minutes on site to replace the equipment. Service duration time for an individual task will be added to the total stop time, even if there are already other tasks at that location. Specifying this value for a task will override the default value, which can be managed from Configuration -> Optimization screen in the Dashboard app.
customerId - If the pickup location is tied to a customer location, the customer ID should be specified here.
customerUID - If the pickup location is tied to a customer location, the customer UID should be specified here.
coordinates - Format [longitude, latitude]. Required for type 2 - coordinates of location.
timeWindows - Time windows in which the driver needs to arrive at this task's pickup 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. Time windows need to have a start and an end time. (start and end)
configuration - Configuration options for the pickup and delivery segment of the task. This influences which POD and failed actions will apply to tasks.
actions - Define the Proof of Delivery actions that will apply, and they are the following:
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task.
Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
meta -
failedActions - Overrides default configuration for security actions needed for this segment of the task (e.g., signature, photo, barcode scan...)
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task. - Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it in order to proceed
meta -
failedActionList - List of failed actions for a particular segment (pickup/delivery) of the task.
identityCode - Automatically generated 5-digit asymmetric code that is sent to recipients via email / SMS notification, to be given to the driver to input and verify
code - Identifier to be matched by scanning the barcode, if barcode action is specified. Used if one of the actions in the actionsList is of type 1 (code)
actionList - List of actions for a particular segment (pickup/delivery) of the task.
Array [
type - Type of action: Enum: 0 1 2 3 4 5 6 7 8. 0: identity code, 1: barcode / manual input code, 2: signature, 3: photo, 4: comment, 5: confirmation, 6: cash on delivery
typeText -
required - Default: false. Indicate whether this action is shown to the driver as optional or whether it's required to complete it to proceed
instructions - Provides additional pickup instructions to the driver.
rating - Contains rating information for this segment of the task
rate - Rating given by the recipient
comment - Additional comment provided
timestamp - date of the given rate
Modified at 2025-12-05 08:31:52
Previous
Webhooks
Next
createOrUpdateMany
Built with