This article contains information on all CSV-importable entity elements and the type of information they store.
For API import, feel free to check out our API documentation.
Task Data Fields
This section lists and explains all the Task-related information that can be imported through CSV. If you're looking to update Tasks, be sure to check out this article.
Date and time
This section lists all the fields that store information on Task-related date and time requirements.
Field Name | Explanation |
date | Task date in YYYYMMDD number format. |
dateRangeStartDate | Start of the Task date range. Allowed input is YYYYMMDD. |
dateRangeEndDate | End of the Task date range. Allowed input is YYYYMMDD. |
allowedWeekDays | Stores information about which days Tasks can be executed on. Allowed inputs are Mon, Tue, Wed, Thu, Fri, Sat, Sun. |
frequency | number [ 1 .. 10 ]. Indicates how many times within the designated date range the Task should happen. |
timeWindows | These are time windows during which the Driver needs to arrive at this Task's delivery location. For example, 8:00-12:00 is added. |
pickupTimeWindows | These are time windows during which the Driver needs to arrive at this Task's pickup location. For example, 8:00-12:00 is added. |
timeWindowStart | Indicates the start time of the delivery segment of the Task |
timeWindowEnd | Indicates the end time of the delivery segment of the Task |
pickupTimeWindowStart | Indicates the start time of the pickup segment of the Task |
pickupTimeWindowEnd | Indicates the end time of the pickup segment of the Task |
Task ID
These fields store your Task ID information, which can be used as a reference point for updating Tasks via CSV as well.
Field Name | Explanation |
externalId | Task ID defined by users. |
reference | Usually, a reference from the user's external system. |
Location information
This section lists all the Task location information that can be imported. Users who use Single-Segment Optimization, or have the Field Service Mode enabled, do not need to populate columns for pickup values.
Field Name | Explanation |
pickupUID | Stores information about the pickup location. It's usually a Depot UID or a Customer Location UID. |
pickupAddress | Stores the pickup location address. Can contain the street number, name, postcode, city, and country in the same field. |
pickupLongitude | Contains the longitude of the pickup location. |
pickupLatitude | Contains the latitude of the pickup location. |
pickupCity | Contains the name of the city of pickup. |
pickupPostCode | The postcode of the pickup location. |
pickupCountry | The country of the pickup location. |
pickupAddressLine2 | Stores the secondary address |
pickupwhat3Words | Contains the what3words code for the pickup location. |
pickupName | Contains the name of the pickup location. It can store the name of the neighborhood or the business, for example. |
pickupContactName | Contains the name of the contact person for the pickup. |
pickupContactEmail | Contains the email of the pickup contact person. |
pickupContactPhone | Contains the phone number of the pickup contact person. |
dropoffUID | Stores information about the delivery location. It's usually a Depot UID or a Customer Location UID. |
dropoffAddress | Stores the delivery location address. Can contain the street number, name, postcode, city, and country in the same field. |
dropoffLongitude | Contains the longitude of the delivery location |
dropoffLatitude | Contains the latitude of the delivery location. |
dropoffCity | Contains the name of the city of the delivery location. |
dropoffCountry | Contains the name of the country of the delivery location. |
dropoffAddressLine2 | Stores the secondary address. |
dropoffwhat3Words | Contains the what3words code for the delivery location |
dropoffName | Contains the name of the delivery location. It can store the name of the neighborhood or the business, for example. |
dropoffContactName | Contains the name of the contact person for the delivery. |
dropoffContactEmail | Contains the email of the contact person for the delivery. |
dropoffContactPhone | Contains the phone number of the contact person for the delivery. |
General Task Information
This section lists all the general Task information that can be imported through a CSV file.
Field Name | Explanation |
internalComment | Comments about the Task. Can only be viewed from eLogii. |
productCode | Stores the barcode value used in barcode scanning. |
skills | Stores information on the required skills to complete the Task. Skills must first be created in eLogii before defining them on import. Tasks can have one or multiple skills, and their form must be identical to the one specified in eLogii. (e.g., Skill 1, Skill 2, Skill 3, etc) |
capabilities | Stores information on the required capabilities to complete the Task. Capabilities must first be created in eLogii before defining them on import. Tasks can have one or multiple capabilities, and their form must be identical to the one specified in eLogii. (e.g., Capability 1, Capability 2, Capability 3, etc) |
tags | Contains tags you would like to use for Tasks. No need to pre-create them. |
teams | Determines which Team can do the Task. The name of the team (in the form that it exists in eLogii) is specified in this field (e.g., Team 1, Team 2). |
pickupInstructions | Instructions that the Driver can see in the Driver app when performing the pickup. |
dropoffInstructions | Instructions that the Driver can see in the Driver app when performing the delivery. |
pickupServiceDuration | Determines how much time the Driver is required to spend at the pickup location. Expressed in minutes. |
serviceDuration | Determines how much time the Driver is required to spend at the delivery location. Expressed in minutes. |
earlinessTolerance | Determines how early the Driver can be at the location before the time window start time. Expressed in minutes. |
latenessTolerance | Determines how late the Driver can be at the location after the time window end time. Expressed in minutes. |
orderValue | Stores information about the Task value. Can be used in Cost and revenue calculation. |
defaultSizeUnit | The name of this field will depend on the preferred measurement units configured for the organization. For instance, if kilograms are the chosen unit, the field will be labeled "kilograms." If multiple units are used (e.g., kilograms and volume), the CSV must include a separate column for each unit to capture the relevant values. |
priority | Stores information about the Task priority. |
state | Task state can be pre-determined on import based on the provided values.
Enum: -30 -20 -10 0 2 4 5 10 20 30 40 50 60
State of Task based on enum:
|
Task Custom Fields
Task custom fields are used to store additional Task information if existing fields do not suffice. Custom fields should be created in eLogii before Task import.
Field Name | Explanation |
customData.Field Name | Field Name should be substituted with the exact corresponding Task custom field name. For example, if your Task custom field is called Job type, the name in the CSV for that field should be customData.Job type. |
Task Preassignment
Task preassignment to a specific Driver is done by using any of the listed Driver ID-related fields in the Task CSV file. It's also possible to determine the pre-assignment Group and order.
Field Name | Explanation |
driverUID | eLogii-generated Driver ID. Can be specified here to pre-assign Tasks immediately on import. |
driverReference | User-generated Driver ID. Can be specified here to pre-assign Tasks immediately on import. |
driverExternalId | User-generated Driver ID. Can be specified here to pre-assign Tasks immediately on import. |
preAssignmentOrder | The order in which the Task's delivery must be executed. Indicates the delivery order in the route. Number field. |
preAssignmentPickupOrder | The order in which the Task's pickup must be executed. indicates the pickup order in the route. Number field. |
preAssignmentGroup | Indicates the Task group. Tasks in the same group will always be assigned to the same route. Number field. |
Task Customer information
For more context on how to associate Customers and Tasks, please refer to this article.
Field Name | Explanation |
pickupCustomerUID | eLogii-generated Customer ID. Used to apply customer-related information to the pickup segment of the Task, such as Task defaults, service duration, etc. |
pickupCustomerReference | User-specified Customer ID. Used to apply customer-related information to the pickup segment of the Task, such as Task defaults, service duration, etc. |
pickupCustomerExternalId | User-specified Customer ID. Stores and applies customer-related information to the pickup segment of the Task, such as Task defaults, service duration, etc. |
customerUID | eLogii-generated Customer ID. Used to apply customer-related information to the delivery segment of the Task, such as Task defaults, service duration, etc. |
customerReference | User-specified Customer ID. Stores and applies customer-related information to the delivery segment of the Task, such as Task defaults, service duration, etc. |
customerExternalId | User-specified Customer ID. Stores and applies customer-related information to the delivery segment of the Task, such as Task defaults, service duration, etc. |
Task Items
Important Task Item naming convention: [n] - The value in the brackets is a placeholder, the naming convention is items[0] to indicate the first item within one Task, items[1] to indicate the 2nd item, items[2] for the third item within the same Task, and so on.
Field Name | Explanation |
items[n].description | This field stores the name of the item. |
items[n].size.dimension | Stores the dimensions of each item. Dimension is a placeholder - if you set up your preferred dimension as kilograms, the right way to specify the dimension of your first item would be items[0].size.kilograms, items[1].size.kilograms for the 2nd item and so on. |
items[n].quantity | Stores item quantity information. |
items[n].unitSize.dimension
| Stores how much each unit of the item weighs. Dimension is a placeholder - if you set up your preferred dimension as kilograms, the right way to specify the dimension of your first item unit would be items[0].unitSize.kilograms, items[1].unitSize.kilograms for the 2nd item, and so on. |
items[n].CustomData.Field Name | Field Name should be substituted with the exact corresponding Item custom field name. For example, if your Item custom field is called Item type, the name in the CSV for that field should be customData.Item type. |
Driver Data Fields
In case you're looking to update Drivers via CSV, please refer to this article.
Basic information
Field Name | Explanation |
firstName | Stores the Driver's first name. |
lastName | Stores the Driver's last name. |
username | Unique username used to log into the Driver app. |
password | Password for the Driver app login. |
skills | Stores information on the skills the Driver possesses. Skills must first be created in eLogii before defining them on import. Drivers can have one or multiple skills, and their form must be identical to the one specified in eLogii. (e.g., Skill 1, Skill 2, Skill 3, etc) |
tags | Contains tags you would like to use for Drivers. No need to pre-create them. |
depots | Contains the list of Depots the Driver can service. Usually, the Depot UID, Reference, External ID, or _id are populated here. |
teams | Determines which Team the Driver is a part of. The name of the team (in the form that it exists in eLogii) is specified in this field (e.g., Team 1, Team 2). |
zones | Determines which zones the Driver can perform Tasks in. The name of the Zones is specified in this field. |
Stores the Driver's email address. | |
mobile | Stores the Driver's phone number. |
mobile2 | Stores the Driver's secondary phone number. |
vehicle | Contains the UID, _id, External ID, or the reference of the Vehicle the Driver drives. |
startTasksInAnyOrder | Whether the Driver has permission to execute Tasks that are out of order. TRUE if yes, FALSE if no. |
speedFactor | Decimal factor that specifies how the speed of this Driver differs from the baseline. Example: 2.0 means 2x faster, while 0.5 means 2x slower.
Allowed values - number [ 0.01 .. 5 ]. |
Driver IDs
These IDs can be used for identifying the Driver to apply updates to when running a Driver data update or pre-assignment.
Field Name | Explanation |
reference | Usually, this reference is from the user's external system. Can be used for Task preassignment. |
externalId | Usually from the user's external system. Can be used for Task preassignment. |
Start/End location
This information relates to the Driver's start and end location. Essentially, where the Driver starts the route, and where they need to drive back to once they complete all their Tasks.
Field Name | Explanation |
startDepotUID | If Drivers start routes from the Depot, the start Depot UID is stored here. |
endDepotUID | If Drivers end routes in the Depot, it stores the end Depot UID. |
startLocationName | Location name. Will be displayed on the map. |
endLocationName | Location name. Will be displayed on the map. |
startAddress | Stores the start location address. Can contain the street number, name, postcode, city, and country in the same field. |
startAddressLine2 | Contains the secondary start address. |
startPostCode | Contains the postcode of the start location. |
startCity | Contains the name of the city of the start location. |
startCountry | The country of the start location. |
startwhat3Words | Stores the what3words location code. |
startLongitude | Contains the longitude of the start location. |
startLatitude | Contains the latitude of the start location. |
endAddress | Stores the end location address. Can contain the street number, name, postcode, city, and country in the same field. |
endAddressLine2 | Contains the secondary end address. |
endPostCode | Contains the postcode of the end location. |
endCity | Contains the name of the city of the end location. |
endCountry | The country of the end location. |
endwhat3Words | Stores the what3words location code. |
endLongitude | Contains the longitude of the end location. |
endLatitude | Contains the latitude of the end location. |
Regular Driver Schedule
This information relates to the Driver's work time. It's possible to define schedules for single-day runs and multiday runs.
| Explanation |
schedule.Day | Stores data on single-day schedules. Allowed input is h:mm-h:mm. For example, 8:00-16-00 indicates a working time from 8 AM to 4 PM. Day is a placeholder and should be substituted with the corresponding day of the week from the list to indicate work time for that day (column name schedule.Mon, schedule.Tue, etc.).
|
multiDaySchedule.Day | Stores data for multiday schedules. Allowed input is h:mm-h:mm. For example, 8:00-16-00 indicates a working time from 8 AM to 4 PM.
Day is a placeholder and should be substituted with the corresponding day of the week from the list to indicate work time for that day (column name schedule.Mon, schedule.Tue, etc.).
|
Driver Cost
Driver cost can be imported via CSV. This data will be used in cost and revenue calculations.
Field Name | Explanation |
cost.PerHour | Number value that indicates the Driver's hourly cost |
cost.PerDay | Number value that indicates the Driver's daily cost |
Driver Custom Fields
Field Name | Explanation |
customData.Field Name | Field Name should be substituted with the exact corresponding Driver custom field name. For example, if your Driver custom field is called Employment type, the name in the CSV for that field should be customData.Employment type. |
Schedule Exceptions Fields
Schedule exceptions are temporary overrides to the normal Driver Schedule.
Although temporary location and skill overrides can be set through the UI, this is not possible at the moment through CSV import.
Field Name | Explanation |
driver | Used to identify which Driver the exception applies to. Driver UID, External ID, Reference, or _id can be stated in this field. |
startDate | Valid format is YYYYMMDD. |
endDate | Valid format is YYYYMMDD. |
dayOff | TRUE if the Driver is unavailable. |
timeWindowStart | h:mm format. Indicates the temporary schedule start time. (e.g., 9:00) |
timeWindowEnd | h:mm format. Indicates the temporary schedule end time. (e.g., 17:00) |
Vehicle and Vehicle Type Data Fields
This section outlines all the data fields that can be imported for both Vehicles and Vehicle Types.
Since Vehicle Types act as templates, they include the same fields as individual Vehicles. By specifying the Vehicle Type ID (uid, reference, external ID, or _id of the imported Vehicle Type) vehicleType column within the Vehicle import CSV, you can apply these predefined settings to any new vehicle created.
Vehicle and Vehicle Type information
Field Name | Explanation |
name | Stores the name of the Vehicle. |
externalId | Usually, from the user's external system. Can be used for Task preassignment. |
reference | Usually, this reference is from the user's external system. Can be used for Task preassignment. |
vehicleType | Stores the UID, _id, Reference of External ID of the Vehicle Type, and applies the presets of that Vehicle type. |
category | Available Vehicle categories:
|
descroption | Stores additional information about the Vehicle. |
defaultSizeUnit | The name of this field will depend on the preferred measurement units configured for the organization. For instance, if kilograms are the chosen unit, the field will be labeled "kilograms." If multiple units are used (e.g., kilograms and volume), the CSV must include a separate column for each unit to capture the relevant values. |
capabilities | Stores information on the capabilities the Vehicle has. Capabilities must first be created in eLogii before defining them on import. Vehicles can have one or multiple capabilities, and their form must be identical to the one specified in eLogii. (e.g., Capability 1, Capability 2, Capability 3, etc) |
tags | Contains tags you would like to use for Vehicles. No need to pre-create them. |
teams | Determines which Team can drive the Vehicle. The name of the team (in the form that it exists in eLogii) is specified in this field (e.g., Team 1, Team 2). |
licensePlate | Stores information about the license plate. |
customData.Field Name | Field Name should be substituted with the exact corresponding Vehicle custom field name. For example, if your Vehicle custom field is called Tyre type, the name in the CSV for that field should be customData.Tyre type. |
Vehicle and Vehicle Type Cost
These costs will be taken into account in cost and revenue calculation.
Field Name | Explanation |
cost.perHour | Number value that indicates the Vehicle's hourly cost. |
cost.perDay | Number value that indicates the Vehicle's daily cost. |
cost.perKM | Number value that indicates the Vehicle's cost per km. |
cost.perDimension | Number value that indicates the Vehicle's cost per dimension. |
Customers
Basic Customer Information
Field Name | Explanation |
name | Stores the name of the customer. For example, the name of the individual or the name of the business/company. |
reference | Usually, this reference is from the user's external system. Used to apply customer presets to corresponding Tasks. |
externalId | Usually, from the user's external system. Used to apply customer presets to corresponding Tasks. |
contactName | Stores the name of the contact person. |
contactEmail | Stores the email of the contact person. |
contactPhone | Stores the phone number of the contact person. |
tags | Contains tags you would like to use for Customers. No need to pre-create them. |
taskCapabilities | The capabilities that will be applied to all Tasks associated with the customer on import. Capabilities must first be created in eLogii before defining them on import. Tasks can have one or multiple capabilities, and their form must be identical to the one specified in eLogii. (e.g., Capability 1, Capability 2, Capability 3, etc) |
taskSkills | The skills that will be applied to all Tasks associated with the customer on import. Skills must first be created in eLogii before defining them on import. Tasks can have one or multiple skills, and their form must be identical to the one specified in eLogii. (e.g., Skill 1, Skill 2, Skill 3, etc) |
taskTags | The tags that will be applied to all Tasks associated with the customer on import. |
taskPriority | The Task priority that will be applied to all Tasks associated with the customer on import. |
teams | Teams that can do the Tasks associated with the customer. The name of the team (in the form that it exists in eLogii) is specified in this field (e.g., Team 1, Team 2). |
taskEarlinessTolerance | Determines how early the Driver can be at the location before the time window start time. Expressed in minutes. |
taskLatenessTolerance | Determines how late the Driver can be at the location before the time window end time. Expressed in minutes. |
Customer Dashboard
Field Name | Explanation |
firstName | Stores the person's first name. |
lastName | Stores the person's last name. |
loginEmail | Stores the email used for dashboard login. |
loginPassword | Stores the password used for dashboard login. |
Customer Locations
Locations locations[n] naming convention - The value in the brackets is a placeholder, the naming convention is locations[0] to indicate the first location within one customer, locations[1] to indicate the 2nd location, locations[2] for the third location within the same customer, and so on.
Field Name | Explanation |
locations[n].name | The name of the location/store. |
locations[n].reference | The location reference. Usually, this reference is from the user's external system. Can be used to link Tasks to specific customer locations. |
locations[n].externalId | Usually, this is from the user's external system. Can be used to link Tasks to specific customer locations. |
locations[n].address | Can contain the street number, name, postcode, city, and country in the same field. |
locations[n].what3words | Contains the what3words code for the customer location. |
locations[n].postCode | The postcode of the customer location. |
locations[n].city | Contains the name of the city of the customer location. |
locations[n].country | The country of the customer location. |
locations[n].longitude | Contains the longitude of the customer location. |
locations[n].latitude | Contains the latitude of the customer location. |
locations[n].contactName | Contains the contact name for the specified location. |
locations[n].contactEmail | Contains the contact email for the specified location. |
locations[n].contactPhone | Contains the contact phone number for the specified location. |
locations[n].instructions | Contains the contact instructions for the specified location, which will be applied if the Task is linked to the specific customer location as either the pickup or the delivery. |
locations[n].serviceDuration | Determines how much time the Driver is required to spend at the customer location.Will be applied as either the pickup or delivery service duration, depending on whether the customer location has been linked to a task as either a pickup or a delivery location. Expressed in minutes. |
locations[n].setupDuration | Determines how much time the Driver is required to spend at the customer location.Will be applied as either the pickup or delivery setup duration, depending on whether the customer location has been linked to a task as either a pickup or a delivery location. Expressed in minutes. |
locations[n].schedule.Day.timeWindows | If the location is linked to a specific Task (as either the pickup or delivery point), the daily time windows provided will be used accordingly, as the pickup or delivery time windows, based on how the customer location is assigned within the Task.
The readable input is h:mm-h:mm. For example, for one location the input would look something like this: header name locations[0].schedule.Mon.timeWindows, value under header 9:00-16:00, for the same location next day: locations[0].schedule.Tue.timeWindows, value under header 9:00-15:00, and so on. |