Routing object

_id

string

A unique identifier of this routing result.

configuration

object[]

An object containing various configuration settings for the route optimization.

Show child attributes

configuration.name

boolean

A string representing the name of this configuration.

configuration.autoSpeed

boolean

A boolean value set to false, mean that the vehicle speed is not automatically determined.

configuration.defaultSpeed

integer

An integer representing the default speed of vehicles.

configuration.defaultVisitTime

integer

An integer representing the default time for each visit

configuration.clustering

boolean

A boolean value set to false, mean that clustering is not enabled

configuration.multitrip

boolean

A boolean value set to true, mean that it allows for multiple trips.

configuration.useAllVehicle

boolean

A boolean value set to true, mean that all available vehicles are used.

configuration.returnToBase

boolean

A boolean value set to true, mean that vehicles return to their base after completing visits.

configuration.capacityConstraint

array

An array containing capacity constraint names.

configuration.useOddEven

boolean

A boolean value indicating whether odd-even license plate restrictions should be enforced during route optimization. When set to true, vehicles will only be routed during time periods that match their odd/even classification.

configuration.oddEvenTime

object[]

An array of time windows during which odd-even restrictions are enforced. Each object contains startTime and endTime defining the restricted periods.

Show child attributes

configuration.oddEvenTime.startTime

string

Start time of the odd-even restriction period.

configuration.oddEvenTime.endTime

string

End time of the odd-even restriction period.

name

string

A string representing the name of this route optimization.

routingDate

string

The date for which the route optimization is performed.

resultCode

string

Unique values for result optimization data as an alternative identifier.

result

object[]

The result key contains success and failed optimized visits list

Show child attributes

result.routing

object[]

An array containing details of the routes.

Show child attributes

result.routing.volumePercentage

string

The volume percentage for this route.

result.routing.totalDistance

number

The total distance covered by this route.

result.routing.totalVolume

number

The total volume carried by this route.

result.routing.vehicleMaxWeight

number

The maximum weight capacity of the vehicle.

result.routing.fixedCost

integer

The cost factor for this route.

result.routing.workingTime

object[]

The time window during which this vehicle can work.

Show child attributes

result.routing.workingTime.startTime

integer

Minimum working time of vehicle to operate.

result.routing.workingTime.endTime

integer

Maximum working time of vehicle to operate.

result.routing.vehicleMaxVolume

number

The maximum volume capacity of the vehicle.

result.routing.speed

integer

The speed of the vehicle.

result.routing.vehicleId

string

The unique identifier for the vehicle.

result.routing.totalNodes

number

The total number of nodes (locations) visited in this route.

result.routing.finishTime

string

The time when this route finished.

result.routing.vehicleName

string

The name of the vehicle.

result.routing.totalVisits

integer

The total number of visits made in this route.

result.routing.totalTrips

integer

The total number of trips made by the vehicle in this route.

result.routing.vehicleMinVolume

number

The minimum volume capacity of the vehicle.

result.routing.totalWeight

number

The total weight carried by this vehicle in this route.

result.routing.trips

object[]

An array containing details of individual trips in this route. Each trip represents a visit or stop during the route.

Show child attributes

result.routing.trips.isHub

boolean

A boolean value indicating whether the dropped visit was a hub (starting/ending point).

result.routing.trips.weight

integer

The weight value seems to be 0, suggesting that there is no specific weight associated with this visit or hub in this context.

result.routing.trips.visitId

string

The visitId is likely a unique identifier for this visit or hub. It can be used to distinguish different visits or locations within the system.

result.routing.trips.waitingTime

string

The waitingTime indicates the time, in some unit (e.g., minutes), that one needs to wait at this hub or location before proceeding to the next destination or performing the next action.

result.routing.trips.eta

string

ETA stands for Estimated Time of Arrival.

result.routing.trips.volume

integer

The volume value seems to be 0, indicating that there is no specific volume associated with this visit or hub in this context. Volume could refer to the quantity of items or goods associated with this location.

result.routing.trips.order

integer

The order value also seems to be 0, suggesting that there is no specific order associated with this visit or hub. In the context of logistics or transportation, an order could refer to a sequence number of stops on a delivery route.

result.routing.trips.coordinate

integer

This represents the geographic coordinates (latitude and longitude) of the hub or location, placing it at approximately -6.17549 latitude and 106.79073 longitude.

result.routing.trips.etd

integer

ETD stands for Estimated Time of Departure. It indicates the estimated time when the visit or vehicle is expected to depart from this hub or location.

result.routing.trips.visitTime

integer

The visitTime appears to be set to 0, indicating that there is no specific visit time associated with this hub or visit in this context. Visit time typically refers to the time taken at a particular location for loading, unloading, or other actions.

result.routing.trips.travelTime

integer

The travelTime is also set to 0, suggesting that there is no specific travel time associated with this visit or hub. Travel time usually refers to the time taken to travel from one location to another.

result.routing.trips.distance

integer

Distance usually refers to the spatial separation between the locations

result.routing.trips.allowOddEven

boolean

A boolean value indicating whether odd-even restrictions allow this trip to be made. When true, the trip timing complies with the vehicle's odd-even classification and restriction windows.

result.routing.vehicleMinWeight

number

The minimum weight capacity of the vehicle

result.routing.assignee

string

The user of the assigned for this route.

result.routing.totalTravelTime

number

The total travel time for this route.

result.routing.vehicleTags

object[]

An array containing vehicle tags.

result.routing.isOddEven

boolean

A boolean value indicating whether this route is affected by odd-even license plate restrictions. When true, the vehicle's routing has been optimized considering odd-even time windows.

result.routing.oddEven

enum<string>

The odd-even category of the vehicle used in this route. Shows whether the vehicle has 'odd' or 'even' numbered license plate.

Available options:

odd,

even

result.dropped

object[]

An array of dropped visit details.

Show child attributes

result.dropped.isHub

string

A boolean value indicating whether the dropped visit was a hub (starting/ending point).

result.dropped.tags

object[]

Tags associated with the dropped visit.

result.dropped.coordinate

string

The coordinates (latitude and longitude) of the dropped visit.

result.dropped.capacity

object[]

An object representing the capacity constraints for the dropped visit.

result.dropped.timeWindow

object

The time window during which the visit was scheduled. Note: This field is not considered when timeWindows is provided.

Show child attributes

result.dropped.timeWindow.startTime

string

Minimum visit available time.

result.dropped.timeWindow.endTime

string

Maximum visit available time

result.dropped.timeWindows

object[]

Array of time windows during which the visit was scheduled. When this field is provided, the timeWindow field will be ignored.

Show child attributes

result.dropped.timeWindows.startTime

string

Minimum visit available time.

result.dropped.timeWindows.endTime

string

Maximum visit available time

result.dropped.visitTime

number

The visit time (duration of stay) for this dropped visit.

result.dropped.id

integer

The unique identifier for this visit.

result.dropped.name

string

The name of the dropped visit.

result.dropped.address

number

The address associated with the dropped.

result.dropped.reason

string

The reason for dropping this visit.

summary

object[]

An object containing summary information for this route optimization:

Show child attributes

summary.totalDistance

number

An integer representing the total distance covered in all routes.

summary.droppedVisits

number

An integer representing the number of dropped visits in all routes.

summary.totalVisits

number

An integer representing the total number of visits in all routes.

summary.totalVehicles

number

An integer representing the total number of vehicles used in all routes.

summary.maxFinishTime

string

A string representing the maximum finish time among all routes.

summary.usedVehicles

integer

An integer representing the number of vehicles used in all routes.

summary.totalVisitTime

integer

An integer representing the total time spent on visits in all routes.

summary.avgSpeed

number

An integer representing the average speed of vehicles in all routes.

summary.totalWaitingTime

number

An integer representing the total waiting time in all routes.

summary.minFinishTime

string

A string representing the minimum finish time among all routes.

summary.routedVisits

number

An integer representing the number of visits that were routed in all routes.

summary.avgFinishTime

string

A string representing the average finish time among all routes.

summary.unusedVehicles

number

An integer representing the number of unused vehicles in all routes.

summary.totalTravelTime

number

An integer representing the total travel time in all routes.

summary.capacityConstraint

object[]

An array containing capacity constraint details for weight and volume.

summary.totalSpentTime

number

An integer representing the total time spent in all routes.

status

string

A string indicating the status of the route optimization. There will only 3 type of status : ongoing, done, and failed. ongoing mean that routing executed in background and still on progress. done mean that route optimize has successfully executed and finish the process. failed mean that route optimize executed but failed cause of something wrong that you can see the reason at the message field.

message

string

A string that will only exists when routing process has failed and giving the reason of it.

hubCoordinate

string

A string representing the latitude and longitude of the hub.

hubId

object[]

A unique identifier representing the hub associated with this route optimization.

organizationId

string

A unique identifier representing the organization ID associated with this route optimization.

countryCode

string

A string representing the country code.

user

object[]

An object containing user-related who create this route information.

createdBy

string

A user ID, representing the user who created this routing.

createdFrom

integer

A string indicating the source from which the route optimization was created.

finishTime

string

A timestamp representing the date and time when the routing process finish. To measure the distance between processes can be done based on createdTime and finishTime.

createdTime

string

A timestamp representing the date and time when this route optimization was created.

updatedTime

string

A timestamp representing the date and time when this data was last updated.

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects