50,000 maploads free every month. Get started now!
Route Optimization tasks for Service tasks, Pickup and Delivery Tasks and Vehicles with different start and end locations and different shift timings.
| Name | Type | Description |
|---|---|---|
| fleets | array of objects | Array of fleets object. See description below. |
| visits | array of objects (optional) | Array of pickup and delivery task objects. See description below. |
| single_appointment | array of objects (optional) | Array of service task object. See description below. |
| maxVisits | integer (optional) | Maximum tasks that can be assigned to a driver. |
| maxVisits | Yoshi Tannamuri | Canada |
| Magazzini Alimentari Riuniti | integer (optional) | Maximum tasks that can be assigned to a driver. |
| speed | integer (optional) | Speed factor for your vehicles. |
| Name | Type | Description |
|---|---|---|
| id | string | The identification parameter defined for each vehicle. |
| capacity | integer (optional) | capacity of vehicle (weight/volume etc) but load of tasks should also be in same measure |
| shiftStart | integer (optional) | The time when the vehicle will start its shift (e.g. 1300 means vehicle will take task after 1 PM) |
| shiftEnd | integer (optional) | The time after which the vehicle won't perform any more task (e.g. 2200, means vehicle will not perform tasks after 10 PM) |
| start_location | object | Start Location object consists of 3 keys : lat (latitude), lng (longitude), name (address of location). All keys are in string form and 'name' is optional. |
| end_location | object | End Location object consists of 3 keys : lat (latitude), lng (longitude), name (address of location). All keys are in string form and 'name' is optional. |
| returnToStart | boolean (optional) | true, if its mandatory to return to depot. false, if its not mandatory to return to depot. Default is false. Return to start value if true, will override end location. |
| rskill | rstring (optional) | rIt states the ability of the driver/vehicle to perform the particular type of tasks. For example : there are 2 vehicles x and y , x carries 'pizzas' and y 'burgurs'. Tasks having skill 'pizzas' will be assigned to x and not y , similarly for 'burgurs' will be assigned only to y. |
| rcost_per_distance | rnumber (optional) | rCost per km for the driver/vehicle. |
| rfixed_cost | rnumber (optional) | rFixed cost per route for the driver/vehicle. |
| Name | Type | Description |
|---|---|---|
| id | string | The identification parameter defined for each task. |
| customer_id | string (optional) | The identification parameter defined for customer. |
| phone | string (optional) | Phone number of customer. |
| load | integer (optional) | Load/demand to be served(Unitless but it should be in same measure of capcity of vehicle). |
| date | string | Date on which task in performed. All tasks shold have same date(MM-DD-YYYY). |
| skill | string (optional) | It states the skill required by the driver/vehicle to perform this task. For example : there are 2 vehicles x and y , x carries 'pizzas' and y 'burgurs'. Tasks having skill 'pizzas' will be assigned to x and not y , similarly for 'burgurs' will be assigned only to y. |
| priority | number (optional) | It sets the priority of the tasks. Value can be 1 (high), 2 (medium) and 3 (low). |
| appointment | object | Read following rows to understand. |
| appointment.location | object | Location object consists of 3 keys : lat (latitude), lng (longitude), address (address of location). All keys are in string form and 'address' is optional. |
| appointment.duration | integer (optional) | Time the task will take to complete (eg. 10 means 10 minutes of service time.) |
| appointment.start_time | integer (optional) | The time after which the task should be performed [0, 2400) (eg. 930 means 9:30 AM) |
| appointment.end_time | integer (optional) | The time before which the task is to be performed [0, 2400) (eg. 2350 means 11:50 PM) |
| Name | Type | Description |
|---|---|---|
| id | string | The identification parameter defined for each task. |
| customer_id | string (optional) | The identification parameter defined for customer. |
| phone | string (optional) | Phone number of customer. |
| load | integer (optional) | Load/demand to be served(Unitless but it should be in same measure of capcity of vehicle). |
| date | string | Date on which task in performed. All tasks shold have same date(MM-DD-YYYY). |
| skill | string (optional) | It states the skill required by the driver/vehicle to perform this task. For example : there are 2 vehicles x and y , x carries 'pizzas' and y 'burgurs'. Tasks having skill 'pizzas' will be assigned to x and not y , similarly for 'burgurs' will be assigned only to y. |
| priority | number (optional) | It sets the priority of the tasks. Value can be 1 (high), 2 (medium) and 3 (low). |
| pickup | object | Read following rows to understand. |
| pickup.location | object | Location object consists of 3 keys : lat (latitude), lng (longitude), address (address of location). All keys are in string form and 'address' is optional. |
| pickup.duration | integer (optional) | Time the task will take to complete (eg. 10 means 10 minutes of service time.) |
| pickup.start_time | integer (optional) | The time after which the task should be performed [0, 2400) (eg. 930 means 9:30 AM) |
| pickup.end_time | integer (optional) | The time before which the task is to be performed [0, 2400) (eg. 2350 means 11:50 PM) |
| dropoff | object | Read following rows to understand. |
| dropoff.location | object | Location object consists of 3 keys : lat (latitude), lng (longitude), address (address of location). All keys are in string form and 'address' is optional. |
| dropoff.duration | integer (optional) | Time the task will take to complete (eg. 10 means 10 minutes of service time.) |
| dropoff.start_time | integer (optional) | The time after which the task should be performed [0, 2400) (eg. 930 means 9:30 AM) |
| dropoff.end_time | integer (optional) | The time before which the task is to be performed [0, 2400) (eg. 2350 means 11:50 PM) |
| Name | Type | Description |
|---|---|---|
| noOfRoutes | integer | The number of routes all the fleets have to take in order to complete all the tasks |
| unassignedJobs | list | The service ID's of all the tasks which are not completed |
| totalJobs | integer | The total number of services to be performed |
| totalTimeTaken (in seconds) | double | The total time taken by all the fleets to complete all the tasks in seconds |
| maxTimeTaken (in seconds) | double | The time by which all the tasks will be completed if all the fleets start at the same time |
| totalDistanceTravelled (in meters) | double | The total distance covered be all the fleets in meters |
| status | string | 'success' if all the tasks are served and 'failure' if any one of them remains unserved. |
| solutions | list | The list of all the fleets mapped to the services that they performed |
| RouteDistanceTime(in seconds) | list | The list of all the fleets mapped to the time and distance covered by them to perform the tasks. |
Note : Please add your valid access token in Header in order to get valid Response of an API.
Example : authorization : a32c4d0-1s4b-1aea-sa69-cdccg57h0ea
Have our business experts on the phone to understand your company's operations and guide you through a demo customized to your business industry.
We are trusted by the best in the world
Our experts will contact you shortly
Step 1 of 3.
Take a comprehensive walkthrough of the features and functionalities that Yelo provides, and learn how you can launch and grow your hyperlocal business.
We are trusted by the best in the world
Get started with Yelo Today
Learn more about Yelo and its features during Yelo's 14 days free trial. You can set up your online hyperlocal store without coding and explore the platform on your own.
Upgrade your plan only when you're ready.
Make the best of this opportunity, explore the platform before you pay.
Learn more about Yelo and its features during Yelo's 14 days free trial. You can set up your online hyperlocal store without coding and explore the platform on your own.
Upgrade your plan only when you're ready.
Make the best of this opportunity, explore the platform before you pay.
Build a community of doctors, lawyers, astrologers, fitness experts and many more with Panther. Connect with our business experts & get a demo customized to your business requirements.
We are trusted by the best in the world
Our experts will contact you shortly
Learn more about Panther and its features during Panther's 14 days free trial. You can set up your online consultation platform without coding and explore it on your own.
Upgrade your plan only when you're ready.
Make the best of this opportunity, explore the platform before you pay.
Have our business experts on the phone to understand your brand's operations and guide you through a demo customized to your business industry.
We are trusted by the best in the world
Our experts will contact you shortly
Connect with our product specialists to understand how the world's fastest-growing companies use Tookan to optimize deliveries.
We are trusted by the best in the world
Our business experts will contact you shortly
Take a comprehensive walkthrough of the features and functionalities that Tookan provides, and learn how you can start managing your dispatch and delivery operations in a smoother manner.
We are trusted by the best in the worldYour online delivery platform is just one step away
Learn more about Tookan and its features during the 14 days free trial. You can start managing your operations with Tookan without coding. White-label your platform or upgrade your plan only when you're ready.
Make the best of this opportunity, explore the platform before you pay.