Introduction

Zeo route planner helps fleet owners create and optimise routes for their drivers. Fleet owners or small businesses who do local last mile deliveries can keep track of delivery status, drivers' live location and send real time updates to the customers. Zeo's mobile apps for delivery drivers are equipped with seamless integrations with all popular navigation tools including waze, tomtom, Google maps, etc. Driver has all important details at his finger tips including notes, customer details and parcel count. Zeo handles dynamic address addition and deletion and reroutes the sequence to provide the most optimised route. With Zeo fleet owners save upto 200$ per month per driver and get access to high quality reports like proof of delivery, signatures and delivery time stamps

Authentication

ZeoRoutePlanner uses API keys to allow access to the API. You can register a new API key at our platform (https://zeorouteplanner.com/app/team/settings/genrate-token).

ZeoRoutePlanner expects for the API key to be included in all API requests to the server in a params that looks like the following:

api_key: api_key

You must replace api_key with your personal API key.

Store Owner Api's

Create Stops

curl --location --request POST '{{base_url}}/api/v5/route_stop' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key": "api_key",
    "stops": [
        {
            "address": "Gwalior Madhaya Predesh",
            "latitude": 0,
            "longitude": 0.0,
            "notes": "dsf",
            "optimize_status": "normal",
            "stop_duration": 5,
            "stop_date": "2022-03-10",
            "parcel_count": 2,
            "arrive_start": "now",
            "arrive_end": "anytime",
            "earliest": 0,
            "latest": 0,
            "driver_id": "",
            "stop_type": "delivery",
            "customer_name": "nishu",
            "customer_mobile_number": "+911234567890",
            "customer_email": "",
            "metadata": [{}]
        }
    ]
}'

{
    "code": 200,
    "status": true,
    "message": "Stops added successfully"
}

This endpoint retrieves all drivers.

HTTP Request

POST {{base_url}}/api/v5/route_stop

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
stops	[{}]	Stops Array

Stops Object Parameters

Parameter	Default	Description
address	""	Stop address
latitude	""	Address Latitude
longitude	""	Address Longitude
notes	""	Any message to add
optimize_status	"normal"
stop_duration		"Stay at stop"
arrive_start	""	"now"
arrive_end	""	"anytime"
earliest	""
latest	""
stop_type	""	(delivery/pickup)
customer_name	""	Customer Name
customer_mobile_number	""	Customer Contact No
driver_id	""	Driver Id
stop_date	""	Stop Date
parcel_count	1	Parcel Count
metadata	[]	Custom Field

Get All Drivers

curl --location -g --request GET '{{base_url}}/api/v5/drivers?api_key=api_key'

{
  "code": 200,
  "status": true,
  "message": "success",
  "data": {
    "drivers": [
      {
        "id": 44914,
        "email": "0f12ebdd@gmail.com",
        "name": "nishu jain",
        "address": null,
        "phone_no": "8959294300",
        "active": true
      }
    ]
  }
}

This endpoint retrieves all drivers.

HTTP Request

GET {{base_url}}/api/v5/drivers

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key

Create Driver

curl --location -g --request POST '{{base_url}}/api/v5/drivers' \
--header 'Content-Type: application/json' \
--data-raw '{
  "api_key": "api_key",
  "email": "nishu.jain396@gmail.com",
  "address": "Netaji Subhash Marg, Lal Qila, Chandni Chowk, New Delhi, Delhi 110006",
  "password": "12345678",
  "name": "nishu jain",
  "phone_no": " "
}'

{
  "code": 200,
  "status": true,
  "message": "Driver created successfully",
  "data": {
    "driver": {
      "id": 44953,
      "email": "testthird1@gmail.com",
      "name": "test",
      "address": "Netaji Subhash Marg, Lal Qila, Chandni Chowk, New Delhi, Delhi 110006",
      "phone_no": "+918959294300",
      "active": true
    }
  }
}

This endpoint create driver.

HTTP Request

POST {{base_url}}/api/v5/drivers

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
email	""	Driver Email
address	""	Driver Address
password	""	Password for driver account
name	""	Name of driver
phone_no	""	Contact no of

Update Driver

curl --location -g --request PUT '{{base_url}}/api/v5/drivers/:driver_id' \
--header 'Content-Type: application/json' \
--data-raw '{
  "api_key": "api_key",
  "name": "nishu jain",
    "address": "",
  "phone_no": "8959294300"
}'

{
  "code": 200,
  "status": true,
  "message": "Driver updated successfully",
  "data": {
    "driver": {
      "id": 44953,
      "name": "nishu jain",
      "phone_no": "8959294300",
      "address": "dlehi",
      "email": "testthird1@gmail.com",
      "active": true
    }
  }
}

This endpoint update driver details.

HTTP Request

PUT {{base_url}}/api/v5/drivers/:driver_id

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
address	""	Driver Address
name	""	Name of driver
phone_no	""	Contact no of driver
driver_id	""	Driver id we get from all driver api's

Delete Driver

curl --location -g --request DELETE '{{base_url}}/api/v5/drivers/:driver_id' \
--header 'Content-Type: application/json' \
--data-raw '{
  "api_key": "api_key"
}'

{
  "code": 200,
  "status": true,
  "message": "Driver deleted successful"
}

This endpoint delete driver.

HTTP Request

DELETE {{base_url}}/api/v5/drivers/:driver_id

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
driver_id	""	Driver id we get from all driver api's

Create Route

curl --location -g --request POST '{{base_url}}/api/v5/routes' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "start_address"  :   "Monroe, NC, USA",
   "start_latitude"   : 0.0,
   "start_longitude"   :0.0,
   "end_address"  :   "Monroe, NC, USA",
   "end_latitude"   : 0.0,
   "end_longitude"   :0.0,
   "route_name"  :   "July 2020 Roadtrip",
   "driver_id": "44968",
   "orginal": true,
   "route_date": "",
   "stops"  : [
    {
    "address": "Gwalior Madhaya Predesh", 
    "latitude":106.672053, 
    "longitude":0.0, 
    "notes":"dsf", 
    "optimize_status":"normal",
    "stop_duration":5, 
    "parcel_count": "",
    "arrive_start":"now", 
    "arrive_end":"anytime", 
    "earliest":0, 
    "latest":0, 
    "stop_type":"delivery", 
    "customer_name":"nishu",
    "customer_mobile_number":"+911234567890",
    "metadata": [{}]
    }
  ]
}'

{
  "code": 200,
  "status": true,
  "message": "success",
  "data": {
    "route": {
        "id": 103110,
        "start_address": "new york",
        "end_address": "new york",
        "start_latitude": 40.7128,
        "start_longitude": 74.006,
        "end_latitude": 40.7128,
        "end_longitude": 74.006,
        "created_at": "2021-07-21T04:07:41.000Z",
        "route_name": "test",
        "route_stops": [
          {
            "id": 222472903,
            "address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
            "latitude": 25.9330248,
            "longitude": -80.2445472,
            "notes": "GOod",
            "optimize_status": "normal",
            "stop_duration": 10,
            "customer_name": "",
            "customer_mobile_number": "",
            "street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
            "city": "Miami-Dade County",
            "state": "Florida",
            "country": "Estados Unidos",
            "postal_code": "33056",
            "customer_email": "",
            "order_number": "",
            "order_status": "route_created",
            "h_no": "",
            "locality": ""
         }
      ]
    }
  }
}

This endpoint create route.

HTTP Request

POST {{base_url}}/api/v5/routes

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
driver_id	""	Driver id we get from all driver api's
start_address	""	Route Start address
start_latitude	""	Start address Latitude
start_longitude	""	Start address Longitude
end_address	""	Route End address
end_latitude	""	End address Latitude
end_longitude	""	End address Longitude
route_name	""	Name of the Route
driver_id	""	Driver Id to assign route
orginal	""
stops	[]	Stops between routes
route_date	''	Route Date

Stops Object Parameters

Parameter	Default	Description
address	""	Stop address
latitude	""	Address Latitude
longitude	""	Address Longitude
notes	""	Any message to add
optimize_status	"normal"
stop_duration		"Stay at stop"
arrive_start	""	"now"
arrive_end	""	"anytime"
earliest	""
latest	""
stop_type	""	(delivery/pickup)
customer_name	""	Customer Name
customer_mobile_number	""	Customer Contact No
parcel_count	1	Parcel Count
metadata	[{}]	Custom Field

Get Route Info

curl --location -g --request GET '{{base_url}}/api/v5/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "driver_id": 44968
}'

{
  "code": 200,
  "status": true,
  "message": "success",
  "data": {
    "route": {
      "id": 103110,
      "start_address": "new york",
      "end_address": "new york",
      "start_latitude": 40.7128,
      "start_longitude": 74.006,
      "end_latitude": 40.7128,
      "end_longitude": 74.006,
      "created_at": "2021-07-21T04:07:41.000Z",
      "route_name": "test",
      "route_stops": [
        {
          "id": 222472903,
          "address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
          "latitude": 25.9330248,
          "longitude": -80.2445472,
          "notes": "GOod",
          "optimize_status": "normal",
          "stop_duration": 10,
          "customer_name": "",
          "customer_mobile_number": "",
          "street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
          "city": "Miami-Dade County",
          "state": "Florida",
          "country": "Estados Unidos",
          "postal_code": "33056",
          "customer_email": "",
          "order_number": "",
          "order_status": "route_created",
          "h_no": "",
          "locality": ""
        }
      ]
    }
  }
}

This endpoint GET route information.

HTTP Request

GET {{base_url}}/api/v5/routes/:route_id

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
route_id	""	Route id we get from route list
driver_id	""	Driver Id of the route

Get Route Optimized Info

curl --location -g --request GET '{{base_url}}/api/v5/routes/:route_id/optimize_route' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "driver_id": 44968
}'

{
    "code": 200,
    "status": true,
    "message": "success",
    "data": {
        "optimized": true,
        "legs": [
            {
                "distance": {
                    "text": "0 km",
                    "value": 0
                },
                "duration": {
                    "text": "",
                    "value": 0
                },
                "end_address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
                "start_address": "new york",
                "start_location": {
                    "lat": 25.9330248,
                    "lng": -80.2445472
                },
                "end_location": {
                    "lat": 25.9330248,
                    "lng": -80.2445472
                },
                "stop_id": "222473116",
                "optimize_status": "normal",
                "stop_type": "delivery",
                "arr_time": 0,
                "end_time": 600,
                "optimize_order": 1,
                "stop_order": null,
                "share_stop_id": null,
                "address_typed": {},
                "overview_polyline": "cah}CnwwhN"
            },
            {
                "distance": {
                    "text": "0 km",
                    "value": 0
                },
                "duration": {
                    "text": "10 mins",
                    "value": 600
                },
                "end_address": "new york",
                "start_address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
                "start_location": {
                    "lat": 25.9330248,
                    "lng": -80.2445472
                },
                "end_location": {
                    "lat": 25.9330248,
                    "lng": -80.2445472
                },
                "stop_id": null,
                "optimize_status": "normal",
                "stop_type": "normal",
                "arr_time": 600,
                "end_time": 0,
                "optimize_order": 2,
                "stop_order": 2000,
                "share_stop_id": 0,
                "address_typed": {
                    "delivery_count": 0
                },
                "overview_polyline": "cah}CnwwhN"
            }
        ]
    }
}

This endpoint GET route information.

HTTP Request

GET {{base_url}}/api/v5/routes/:route_id/optimize_route

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
driver_id	""	Driver Id of the route

Delete Route

curl --location -g --request DELETE '{{base_url}}/api/v5/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "driver_id": 44968
}'

{
  "code": 200,
  "status": true,
  "message": "Route deleted successfully"
}

This endpoint delete route.

HTTP Request

DELETE {{base_url}}/api/v5/routes/:route_id

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
route_id	""	Route id we get from route list
driver_id	""	Driver Id of the route

Get All Driver Routes

curl --location -g --request GET '{{base_url}}/api/v5/routes' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "limit": 10,
   "offset": 10,
   "driver_id": "driver_id"
}'

{
  "code": 200,
  "status": true,
  "message": "success",
  "data": {
    "routes": [
      {
        "id": 103110,
        "start_address": "new york",
        "end_address": "new york",
        "start_latitude": 40.7128,
        "start_longitude": 74.006,
        "end_latitude": 40.7128,
        "end_longitude": 74.006,
        "created_at": "2021-07-21T04:07:41.000Z",
        "route_name": "test",
        "route_stops": [
          {
            "id": 222472903,
            "address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
            "latitude": 25.9330248,
            "longitude": -80.2445472,
            "notes": "GOod",
            "optimize_status": "normal",
            "stop_duration": 10,
            "customer_name": "",
            "customer_mobile_number": "",
            "street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
            "city": "Miami-Dade County",
            "state": "Florida",
            "country": "Estados Unidos",
            "postal_code": "33056",
            "customer_email": "",
            "order_number": "",
            "order_status": "route_created",
            "h_no": "",
            "locality": ""
          }
        ]
      }
    ],
    "total_routes": 1
  }
}

This endpoint fetch all routes.

HTTP Request

GET {{base_url}}/api/v5/routes

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
limit	50	Records to return
offset	0	Next records to return
driver_id		Driver id

Get All Store Owner Routes

curl --location -g --request GET '{{base_url}}/api/v5/routes/all_routes' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "limit": 10,
   "offset": 10,
   "start_date": dd-mm-yyyy,
   "end_date": dd-mm-yyyy
}'

{
  "code": 200,
  "status": true,
  "message": "success",
  "data": {
    "routes": [
      {
        "id": 103110,
        "start_address": "new york",
        "end_address": "new york",
        "start_latitude": 40.7128,
        "start_longitude": 74.006,
        "end_latitude": 40.7128,
        "end_longitude": 74.006,
        "created_at": "2021-07-21T04:07:41.000Z",
        "route_name": "test",
        "route_stops": [
          {
            "id": 222472903,
            "address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
            "latitude": 25.9330248,
            "longitude": -80.2445472,
            "notes": "GOod",
            "optimize_status": "normal",
            "stop_duration": 10,
            "customer_name": "",
            "customer_mobile_number": "",
            "street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
            "city": "Miami-Dade County",
            "state": "Florida",
            "country": "Estados Unidos",
            "postal_code": "33056",
            "customer_email": "",
            "order_number": "",
            "order_status": "route_created",
            "h_no": "",
            "locality": ""
          }
        ]
      }
    ],
    "total_routes": 1
  }
}

This endpoint fetch all routes.

HTTP Request

GET {{base_url}}/api/v5/routes/all_routes

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
limit	50	Records to return
offset	0	Next records to return
start_date	nil	Route start date (dd-mm-yyyy)
end_date	nil	Route end date (dd-mm-yyyy)

Get Route create for driver by store owner

curl --location --request POST '{{base_url}}/api/v5/routes/import_orders' \
--header 'Content-Type: multipart/form-data' \
--form 'start_address=""' \
--form 'end_address=""' \
--form 'driver_email="\"\""' \
--form 'api_key="\"\""' \
--form 'file=@"/path/to/file"'

{
    "code": 200,
    "status": true,
    "message": "success",
    "data": {
        "route": {
            "id": 104244,
            "start_address": "Delhi",
            "end_address": "Delhi",
            "start_latitude": 28.7040592,
            "start_longitude": 77.1024902,
            "end_latitude": 28.7040592,
            "end_longitude": 77.1024902,
            "created_at": "2021-09-27T06:18:29.000Z",
            "route_name": "2021-Sep-09",
            "route_stops": [
                {
                    "id": 16921825,
                    "address": "Delhi",
                    "latitude": 28.7040592,
                    "longitude": 77.1024902,
                    "notes": "test",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "ayush",
                    "customer_mobile_number": "7838479870",
                    "street": "",
                    "city": "",
                    "state": "Delhi",
                    "country": "India",
                    "postal_code": "",
                    "customer_email": "ayush@gmail.com",
                    "order_number": null,
                    "order_status": "route_created",
                    "h_no": "",
                    "locality": ""
                }
            ]
        }
    }
}

This endpoint used for creating route for driver.

HTTP Request

POST {{base_url}}/api/v5/routes/import_orders

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key (Go to page Website url login into store owner account then Go to page Settings pageselect get api token and generate api_key)
start_address	""	start address of route
end_address	""	end address of route
driver_email	""	email of driver
file	""	upload file in xlsx format you can download by clicking on the link(Sample file link)

Pickup Deliveries

Create Route

curl -X POST \
  {{base_url}}/api/v6/routes/ \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: 5c922b4b-faf5-ea12-5660-518110acc248' \
  -d '{
  "api_key": "**************",
  "driver_id": 11111111111111,
  "start_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
  "start_latitude":19.1190749,
  "start_longitude":72.8951151,
  "end_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
  "end_latitude":19.1190749,
  "end_longitude":72.8951151,
  "route_name":"04-Jan-2022",
  "stops":[
    {
      "id":1633502641818,
      "address":"Taj Mahal pikcup",
      "latitude":18.9225854,
      "longitude":72.83315429999999,
      "notes":"parsal in the left site",
      "stop_type":"pickup",
      "customer_name":"any",
      "customer_mobile_number":"0123456789",
      "customer_email":"example@gmail.com",
      "share_stop_id":0,
      "address_typed":{
        "delivery_count":1
      },
      "stop_duration": 2,
      "stop_order": 1,
      "metadata": [{}]
    },
    {
      "id":0,
      "address":"Taj Mahal pickup link delivery",
      "latitude":18.9225854,
      "longitude":72.83315429999999,
      "notes":"parsal in the left site",
      "stop_type":"delivery",
      "customer_name":"any",
      "customer_mobile_number":"0123456789",
      "customer_email":"example@gmail.com",
      "share_stop_id":1633502641818,
      "address_typed":{
        "delivery_count":0
      },
      "stop_duration": 2,
      "stop_order": 2
    },
    {
      "id":0,
      "address":"Taj Mahal seperate delivery",
      "latitude":18.9225854,
      "longitude":72.83315429999999,
      "notes":"parsal in the left site",
      "stop_type":"delivery",
      "customer_name":"any",
      "customer_mobile_number":"0123456789",
      "customer_email":"example@gmail.com",
      "share_stop_id":0,
      "address_typed":{
        "delivery_count":0
      },
      "stop_duration": 2,
      "stop_order": 2
    }
  ]
}'

{
    "code": 200,
    "status": true,
    "message": "success",
    "data": {
        "route": {
            "id": 103169,
            "route_name": "04-Jan-2022",
            "start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
            "end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
            "start_latitude": 19.1190749,
            "start_longitude": 72.8951151,
            "end_latitude": 19.1190749,
            "end_longitude": 72.8951151,
            "created_at": "2022-01-11T11:48:16.000Z",
            "route_stops": [
                {
                    "id": 222473230,
                    "address": "Taj Mahal seperate delivery",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "parsal in the left site",
                    "optimize_status": "normal",
                    "stop_duration": 2,
                    "customer_name": "any",
                    "customer_mobile_number": "0123456789",
                    "street": "",
                    "city": "",
                    "state": "",
                    "country": "",
                    "postal_code": "",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "example@gmail.com",
                    "order_number": null,
                    "order_status": null,
                    "stop_order": 2,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 0
                },
                {
                    "id": 222473231,
                    "address": "Taj Mahal pickup",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "parsal in the left site",
                    "optimize_status": "normal",
                    "stop_duration": 2,
                    "customer_name": "any",
                    "customer_mobile_number": "0123456789",
                    "street": "",
                    "city": "",
                    "state": "",
                    "country": "",
                    "postal_code": "",
                    "address_typed": {
                        "delivery_count": 1
                    },
                    "customer_email": "example@gmail.com",
                    "order_number": null,
                    "order_status": null,
                    "stop_order": 1,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 0
                },
                {
                    "id": 222473232,
                    "address": "Taj Mahal pickup linked delivery",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "parsal in the left site",
                    "optimize_status": "normal",
                    "stop_duration": 2,
                    "customer_name": "any",
                    "customer_mobile_number": "0123456789",
                    "street": "",
                    "city": "",
                    "state": "",
                    "country": "",
                    "postal_code": "",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "example@gmail.com",
                    "order_number": null,
                    "order_status": null,
                    "stop_order": 2,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 222473231
                }
            ]
        }
    }
}

This endpoint create route.

HTTP Request

POST {{base_url}}/api/v6/routes

Query Parameters

Parameter	DataType	Default	Description
driver_id	int (*)		Need driver_id for creating a route
start_address	string (*)		Address from where route start
start_latitude	decimal	0	Required either start_address OR start_latitude,start_longitude
start_longitude	decimal	0	Required either start_address OR start_latitude,start_longitude
end_address	string		End location of the route
end_latitude	decimal		Required either end_address OR end_latitude,end_longitude
end_longitude	decimal		Required either end_address OR end_latitude,end_longitude
route_name	string (*)	current date(dd/mm/yy)	Route name
stops	array of objects (*)		Stops information in the array of object

Stops Object Parameters

Parameter	DataType	Default	Description
id	INT (*)	0	1. If stop_type is delivery no need to send id 2. If stop_type pickup then need to send 20 digit id
stop_order	int (*)	0	Add order of stop
share_stop_id	int	0	1. If stop_type is pickup leave it as default 2. If stop_type is delivery and don't want to link with pickup leave it as default 3. If you want to link with any pickup then put id of that pickup stop id
stop_type	string	delivery	values should be delivery and pickup
address	string		Required either address OR latitude,Longitude
latitude	decimal	0	Required either address OR latitude,Longitude
longitude	decimal	0	Required either address OR latitude,Longitude
notes	string		Stop related information
stop_duration	int	2	Specifies the duration of the stop in minutes, i.e. how long it takes at the customer site.
customer_name	string		Customer Info
customer_mobile_number	string		Customer Info
customer_email	string		Customer Info
address_typed	{}	{}	1. If stop_type is pickup then key is delivery_count and value is in int total number of delivery is linked with this pickup 2. if stop_type is delivery leave it as default

Update Route

curl -X POST \
  {{base_url}}/api/v6/routes/:route_id \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: 5c922b4b-faf5-ea12-5660-518110acc248' \
  -d '{
  "api_key": "**************",
  "driver_id": 11111111111111,
  "start_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
  "start_latitude":19.1190749,
  "start_longitude":72.8951151,
  "end_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
  "end_latitude":19.1190749,
  "end_longitude":72.8951151,
  "route_name":"04-Jan-2022",
  "stops":[
    {
      "id":1633502641818,
      "address":"Taj Mahal pikcup",
      "latitude":18.9225854,
      "longitude":72.83315429999999,
      "notes":"parsal in the left site",
      "stop_type":"pickup",
      "customer_name":"any",
      "customer_mobile_number":"0123456789",
      "customer_email":"example@gmail.com",
      "share_stop_id":0,
      "address_typed":{
        "delivery_count":1
      },
      "stop_duration": 2,
      "stop_order": 1
    },
    {
      "id":0,
      "address":"Taj Mahal pickup link delivery",
      "latitude":18.9225854,
      "longitude":72.83315429999999,
      "notes":"parsal in the left site",
      "stop_type":"delivery",
      "customer_name":"any",
      "customer_mobile_number":"0123456789",
      "customer_email":"example@gmail.com",
      "share_stop_id":1633502641818,
      "address_typed":{
        "delivery_count":0
      },
      "stop_duration": 2,
      "stop_order": 2
    },
    {
      "id":0,
      "address":"Taj Mahal seperate delivery",
      "latitude":18.9225854,
      "longitude":72.83315429999999,
      "notes":"parsal in the left site",
      "stop_type":"delivery",
      "customer_name":"any",
      "customer_mobile_number":"0123456789",
      "customer_email":"example@gmail.com",
      "share_stop_id":0,
      "address_typed":{
        "delivery_count":0
      },
      "stop_duration": 2,
      "stop_order": 2
    }
  ]
}'

{
    "code": 200,
    "status": true,
    "message": "success",
    "data": {
        "route": {
            "id": 103169,
            "route_name": "04-Jan-2022",
            "start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
            "end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
            "start_latitude": 19.1190749,
            "start_longitude": 72.8951151,
            "end_latitude": 19.1190749,
            "end_longitude": 72.8951151,
            "created_at": "2022-01-11T11:48:16.000Z",
            "route_stops": [
                {
                    "id": 222473230,
                    "address": "Taj Mahal seperate delivery",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "parsal in the left site",
                    "optimize_status": "normal",
                    "stop_duration": 2,
                    "customer_name": "any",
                    "customer_mobile_number": "0123456789",
                    "street": "",
                    "city": "",
                    "state": "",
                    "country": "",
                    "postal_code": "",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "example@gmail.com",
                    "order_number": null,
                    "order_status": null,
                    "stop_order": 2,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 0
                },
                {
                    "id": 222473231,
                    "address": "Taj Mahal pickup",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "parsal in the left site",
                    "optimize_status": "normal",
                    "stop_duration": 2,
                    "customer_name": "any",
                    "customer_mobile_number": "0123456789",
                    "street": "",
                    "city": "",
                    "state": "",
                    "country": "",
                    "postal_code": "",
                    "address_typed": {
                        "delivery_count": 1
                    },
                    "customer_email": "example@gmail.com",
                    "order_number": null,
                    "order_status": null,
                    "stop_order": 1,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 0
                },
                {
                    "id": 222473232,
                    "address": "Taj Mahal pickup linked delivery",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "parsal in the left site",
                    "optimize_status": "normal",
                    "stop_duration": 2,
                    "customer_name": "any",
                    "customer_mobile_number": "0123456789",
                    "street": "",
                    "city": "",
                    "state": "",
                    "country": "",
                    "postal_code": "",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "example@gmail.com",
                    "order_number": null,
                    "order_status": null,
                    "stop_order": 2,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 222473231
                }
            ]
        }
    }
}

This endpoint update route.

HTTP Request

POST {{base_url}}/api/v6/routes/:route_id

Query Parameters

Parameter	DataType	Default	Description
driver_id	int (*)		Need driver_id for creating a route
start_address	string (*)		Address from where route start
start_latitude	decimal	0	Required either start_address OR start_latitude,start_longitude
start_longitude	decimal	0	Required either start_address OR start_latitude,start_longitude
end_address	string		End location of the route
end_latitude	decimal		Required either end_address OR end_latitude,end_longitude
end_longitude	decimal		Required either end_address OR end_latitude,end_longitude
route_name	string (*)	current date(dd/mm/yy)	Route name
stops	array of objects (*)		Stops information in the array of object

Stops Object Parameters

Parameter	DataType	Default	Description
id	INT (*)	0	1. If stop_type is delivery no need to send id 2. If stop_type pickup then need to send 20 digit id
stop_order	int (*)	0	Add order of stop
share_stop_id	int	0	1. If stop_type is pickup leave it as default 2. If stop_type is delivery and don't want to link with pickup leave it as default 3. If you want to link with any pickup then put id of that pickup stop id
stop_type	string	delivery	values should be delivery and pickup
address	string		Required either address OR latitude,Longitude
latitude	decimal	0	Required either address OR latitude,Longitude
longitude	decimal	0	Required either address OR latitude,Longitude
notes	string		Stop related information
stop_duration	int	2	Specifies the duration of the stop in minutes, i.e. how long it takes at the customer site.
customer_name	string		Customer Info
customer_mobile_number	string		Customer Info
customer_email	string		Customer Info
address_typed	{}	{}	1. If stop_type is pickup then key is delivery_count and value is in int total number of delivery is linked with this pickup 2. if stop_type is delivery leave it as default

Get Route Info

curl --location -g --request GET '{{base_url}}/api/v6/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "driver_id": 44968
}'

{
    "code": 200,
    "status": true,
    "message": "success",
    "data": {
        "route": {
            "id": 104248,
            "start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
            "end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
            "start_latitude": 19.1190749,
            "start_longitude": 72.8951151,
            "end_latitude": 19.1190749,
            "end_longitude": 72.8951151,
            "created_at": "2021-12-30T07:32:10.000Z",
            "route_name": "06-Oct-2021",
            "route_stops": [
                {
                    "id": 16921846,
                    "address": "Taj Mahal Tower, Mumbai, PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra, India",
                    "latitude": 18.9225854,
                    "longitude": 72.8331543,
                    "notes": "",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "",
                    "customer_mobile_number": "",
                    "street": "PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra 400001, India",
                    "city": "Mumbai",
                    "state": "Maharashtra",
                    "country": "India",
                    "postal_code": "400001",
                    "address_typed": {
                        "delivery_count": 2
                    },
                    "customer_email": "",
                    "order_number": null,
                    "order_status": null,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 0
                },
                {
                    "id": 16921847,
                    "address": "Juhu Beach, Mumbai, Maharashtra",
                    "latitude": 19.1095171,
                    "longitude": 72.8241298,
                    "notes": "",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "",
                    "customer_mobile_number": "",
                    "street": "Juhu Beach, Juhu, Mumbai, Maharashtra 400049, India",
                    "city": "Mumbai Suburban",
                    "state": "Maharashtra",
                    "country": "India",
                    "postal_code": "400049",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "",
                    "order_number": null,
                    "order_status": null,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 16921846
                },
                {
                    "id": 16921848,
                    "address": "JW Marriott Mumbai Juhu, Juhu Road, Juhu Tara, Juhu, Mumbai, Maharashtra, India",
                    "latitude": 19.1018504,
                    "longitude": 72.8262233,
                    "notes": "",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "",
                    "customer_mobile_number": "",
                    "street": "Juhu Rd, Juhu Tara, Juhu, Mumbai, Maharashtra 400049, India",
                    "city": "Mumbai Suburban",
                    "state": "Maharashtra",
                    "country": "India",
                    "postal_code": "400049",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "",
                    "order_number": null,
                    "order_status": null,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 16921846
                },
                {
                    "id": 16921849,
                    "address": "Hotel Sea Princess, Juhu Road, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra, India",
                    "latitude": 19.09326,
                    "longitude": 72.8281264,
                    "notes": "",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "",
                    "customer_mobile_number": "",
                    "street": "Juhu Rd, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra 400049, India",
                    "city": "Mumbai Suburban",
                    "state": "Maharashtra",
                    "country": "India",
                    "postal_code": "400049",
                    "address_typed": {
                        "delivery_count": 2
                    },
                    "customer_email": "",
                    "order_number": null,
                    "order_status": null,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 0
                },
                {
                    "id": 16921850,
                    "address": "Standard Chartered Mumbai 23-25 M G Road, Mumbai Branch, 23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra, India",
                    "latitude": 18.9339261,
                    "longitude": 72.8313813,
                    "notes": "",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "",
                    "customer_mobile_number": "",
                    "street": "23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra 400001, India",
                    "city": "Mumbai",
                    "state": "Maharashtra",
                    "country": "India",
                    "postal_code": "400001",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "",
                    "order_number": null,
                    "order_status": null,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 16921849
                },
                {
                    "id": 16921851,
                    "address": "Horniman Circle Garden, Homji Street, Kala Ghoda, Fort, Mumbai, Maharashtra, India",
                    "latitude": 18.93197,
                    "longitude": 72.8350343,
                    "notes": "",
                    "optimize_status": "normal",
                    "stop_duration": 5,
                    "customer_name": "",
                    "customer_mobile_number": "",
                    "street": "Horniman Circle Garden, 11, Homji St, Kala Ghoda, Fort, Mumbai, Maharashtra 400001, India",
                    "city": "Mumbai",
                    "state": "Maharashtra",
                    "country": "India",
                    "postal_code": "400001",
                    "address_typed": {
                        "delivery_count": 0
                    },
                    "customer_email": "",
                    "order_number": null,
                    "order_status": null,
                    "h_no": "",
                    "locality": "",
                    "share_stop_id": 16921849
                }
            ]
        }
    }
}

This endpoint GET route information.

HTTP Request

GET {{base_url}}/api/v6/routes/:route_id

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
route_id	""	Route id we get from route list
driver_id	""	Driver Id of the route

Delete Pickup Delivery Route

curl --location -g --request DELETE '{{base_url}}/api/v6/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "driver_id": 44968
}'

{
  "code": 200,
  "status": true,
  "message": "Route deleted successfully"
}

This endpoint delete route.

HTTP Request

DELETE {{base_url}}/api/v6/routes/:route_id

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
route_id	""	Route id we get from route list
driver_id	""	Driver Id of the route

Get Route Optimized Info

curl --location -g --request GET '{{base_url}}/api/v6/routes/:route_id/optimize_route' \
--header 'Content-Type: application/json' \
--data-raw '{
   "api_key"  :   "api_key",
   "driver_id": 44968
}'

{
    "code": 200,
    "status": true,
    "message": "success",
    "data": {
        "optimized": true,
        "legs": [
            {
                "distance": {
                    "text": "11 km",
                    "value": 11545
                },
                "duration": {
                    "text": "22 mins 55 secs",
                    "value": 1375
                },
                "end_address": "Hotel Sea Princess, Juhu Road, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra, India",
                "start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
                "start_location": {
                    "lat": 19.1190749,
                    "lng": 72.8951151
                },
                "end_location": {
                    "lat": 19.09326,
                    "lng": 72.8281264
                },
                "stop_id": "16921855",
                "optimize_status": "normal",
                "stop_type": "pickup",
                "arr_time": 1375,
                "end_time": 1675,
                "optimize_order": 1,
                "stop_order": 4,
                "share_stop_id": 0,
                "address_typed": {
                    "delivery_count": 2
                },
                "overview_polyline": "ieusByg|{L|@Dj@N\\Nb@d@`@h@HRF`@MnAFvBL\\|APhA[NK^LXCj@WvBUh@EZXb@BbACh@K`AdAhAvAZjBDx@z@xAhD|ElA~Dz@nAn@LhBf@rCv@`BP|DX~BL`A?n@GrCy@l@Cx@@dBHv@NbAf@hFnCr@h@e@r@}@dA_DjCyBdBiB|Ak@n@_@j@k@xAQz@Gv@SvHEl@Mv@YhAg@bBsBvHu@|C_IlYw@hDkAhGgCtNs@nEo@jDn@t@f@bAb@hAPbAbAxK^dDAbABj@AjAM`AcAdD]tAMz@]tCOzAmBlIcCjJ?j@JT\\ZvUxCMfAQx@C^m@vBm@vAqAvB{EzGzDvB~BhAbUbHXPj@jGcAxMCpBb@xN@~AKlApCj@jBZpBNjNClAI@R}E`OyC~QoDtWaC|O?LFXJLPFZBlI]lHy@nCg@tFk@pBOT?^FXRHR\\hBBHFFD@X?~B[dCYHCHGFO@SEaA@WFQHKXMT@vEYxG[x@ADf@"
            },
            {
                "distance": {
                    "text": "21 km",
                    "value": 21458
                },
                "duration": {
                    "text": "34 mins 46 secs",
                    "value": 2086
                },
                "end_address": "Taj Mahal Tower, Mumbai, PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra, India",
                "start_address": "Hotel Sea Princess, Juhu Road, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra, India",
                "start_location": {
                    "lat": 19.09326,
                    "lng": 72.8281264
                },
                "end_location": {
                    "lat": 18.9225854,
                    "lng": 72.8331543
                },
                "stop_id": "16921852",
                "optimize_status": "normal",
                "stop_type": "pickup",
                "arr_time": 3461,
                "end_time": 3761,
                "optimize_order": 2,
                "stop_order": 1,
                "share_stop_id": 0,
                "address_typed": {
                    "delivery_count": 2
                },
                "overview_polyline": "gdpsBufo{LEg@~C?`@DZLZTh@j@h@Xb@JtNx@`BXz@FrBEn@?t@SnDZHEHONg@^kDhAyHfBuIf@mCx@}LdLLbCFvIB~r@pAtBF~CTtIfAbA@zAC~AW|JwCxBk@~EyAzD{AfBi@pAa@tJsC|Ai@rK`@p@?fAE~@Sv@_@vCcB^QXK~E]xBg@xGq@lAGrRC`JGzAUlTkIrPuGzEuA|AYbHo@bIMpFNbERpI\\fUtCxGx@zDb@`APh@`@hEgBv@_@rBqDd@e@f@SbAQ`B?TCpA[j@YXMZWf@w@bOaXNo@KUCWBWHULQRKZGZBXNNTHX?XFTLLnA~@`MpIjHlE~@v@rHlE~LvGbBj@zEjApBv@nBdA`CzAdA~@n@r@p@f@l@Zn@Pv@Nr@ZrCj@fGz@|Cv@`B\\|Dh@l@PpANlE?nABbAZ|DbBfB`@fALrOh@~@Hn@RlCvAl@Vn@Jb@?zDWzCI`C?rBJrTrAnBTbBXbFdAvEdA|LhBbGl@tATfAJr@A|AI|AMxB[|BOf@H|Bf@n@NrAx@lAdAv@\\t@JvEBfFI`HQR?d@Fp@ExCFvAHvGjAr@J`@JhETdFHhBHvC@h@DvB\\f@BlD@jAExBa@t@IlAG^G\\ObAkA\\Q`@GxE_@tDS~AUXO\\[`AgAb@]f@[p@U`JaB~@K`AAjAGdAOl@Md@OjBq@~@a@t@Sn@Ef@?tCTbC`@nFtAbAb@`@L\\DZ?|WwArBEfBAxBh@vBt@nEfA|Cp@dBl@p@\\~LfIVTTb@TXh@HTNbCMpHKjICxH@tACz@Qt@]bAeAXg@?Q@QFOJMLGPEN?N@rB{@|C_CfA{@J?@BJFt@dANNN@J?tAgALGVA~E|ATRYAoE}AUEKDiAx@"
            },
            {
                "distance": {
                    "text": "1 km",
                    "value": 1314
                },
                "duration": {
                    "text": "6 mins 4 secs",
                    "value": 364
                },
                "end_address": "Horniman Circle Garden, Homji Street, Kala Ghoda, Fort, Mumbai, Maharashtra, India",
                "start_address": "Taj Mahal Tower, Mumbai, PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra, India",
                "start_location": {
                    "lat": 18.9225854,
                    "lng": 72.8331543
                },
                "end_location": {
                    "lat": 18.93197,
                    "lng": 72.8350343
                },
                "stop_id": "16921857",
                "optimize_status": "normal",
                "stop_type": "delivery",
                "arr_time": 3825,
                "end_time": 4125,
                "optimize_order": 3,
                "stop_order": 6,
                "share_stop_id": 16921855,
                "address_typed": {
                    "delivery_count": 0
                },
                "overview_polyline": "aznrBmgp{Lc@XICoAgBKG_GtEi@l@S^@TCPOXMJQFS?[IOMIMCQ?Q@QFOGUEa@[gASq@q@o@[QiASyAKmDc@uEsAmAc@s@a@y@i@_BuAi@OoF_@"
            },
            {
                "distance": {
                    "text": "1 km",
                    "value": 1082
                },
                "duration": {
                    "text": "6 mins 33 secs",
                    "value": 393
                },
                "end_address": "Standard Chartered Mumbai 23-25 M G Road, Mumbai Branch, 23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra, India",
                "start_address": "Horniman Circle Garden, Homji Street, Kala Ghoda, Fort, Mumbai, Maharashtra, India",
                "start_location": {
                    "lat": 18.93197,
                    "lng": 72.8350343
                },
                "end_location": {
                    "lat": 18.9339261,
                    "lng": 72.8313813
                },
                "stop_id": "16921856",
                "optimize_status": "normal",
                "stop_type": "delivery",
                "arr_time": 4218,
                "end_time": 4518,
                "optimize_order": 4,
                "stop_order": 5,
                "share_stop_id": 16921855,
                "address_typed": {
                    "delivery_count": 0
                },
                "overview_polyline": "isprB{up{LcAIVKzAJn@v@Pn@Ar@I^QZWV[N_@Ha@A[E[OGJSFkHu@sBjKqBxIxBS|B["
            },
            {
                "distance": {
                    "text": "20 km",
                    "value": 20984
                },
                "duration": {
                    "text": "35 mins 42 secs",
                    "value": 2142
                },
                "end_address": "JW Marriott Mumbai Juhu, Juhu Road, Juhu Tara, Juhu, Mumbai, Maharashtra, India",
                "start_address": "Standard Chartered Mumbai 23-25 M G Road, Mumbai Branch, 23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra, India",
                "start_location": {
                    "lat": 18.9339261,
                    "lng": 72.8313813
                },
                "end_location": {
                    "lat": 19.1018504,
                    "lng": 72.8262233
                },
                "stop_id": "16921854",
                "optimize_status": "normal",
                "stop_type": "delivery",
                "arr_time": 6360,
                "end_time": 6660,
                "optimize_order": 5,
                "stop_order": 3,
                "share_stop_id": 16921852,
                "address_typed": {
                    "delivery_count": 0
                },
                "overview_polyline": "y_qrB_zo{LrDc@Yk@Y[w@c@cK}GoAm@qA_@cJuB_Cy@kBa@eB?uBD_ThAoBHe@?SAu@WaA]qFwA_AQ_AOuCSc@Am@Du@R}@^mBr@e@Nm@LgANmAF_AB_AH_J~Am@Tg@Xc@\\_AfA_@\\]N_BVwDRyE^]FYNeAhAa@Ra@FmAFs@H{B`@mADoDAg@CwB]g@EwCAkBIeFIiEUoAM_HoAsBK{EGaDLoJNcACuCC{@M{@a@mAcAsAw@i@Q_Cg@a@E}BLsBXaBNaAFsABiAKsAUgE_@{@Q}LkBuEiAaFeAeBWmBUqTsAsBK_C?{CH{DVg@Aq@Ko@WmCwAm@S}@GqOi@kAMiBa@}DeB_AYmAEqE?qAOs@@}Dk@wBa@sA]oB_@iAQaC]uCk@w@GgASe@Qu@]u@k@i@m@gAcAiC_BcB}@uBy@_B]_D}@_A[}Aw@aH{Du@q@aC{AqDsBgAg@mHkE_MkImBmAQCSDSASE]\\_FpIiHlM[n@O`@Kb@EhBGVKJKBMAu@k@c@Wa@Wu@K_A?_ANc@Rc@`@sBrDyG`DcB_AyMcBmBSsCc@_M_BeW}@aILaHn@{AXwEtAiK|DgDvAmTnIaBV{]Fy@DeHv@_CLOHaCXmARi@RqDtBe@NaATiBFiLc@OB_C|@mDjAyJvCoC`A}C|@wD~@_IjC_B^gAHcBB}@CmJkAqF]sNMmFKg\\w@wIFaCMcDAqFMm@vIU|BaC|Ly@bFi@|DKvAIZOJUAoD[u@Ro@?sBD{@GaBYuNy@c@Ki@Yi@k@[U[Ma@EyE@yGZwEX[TORCXDnAEREFSNyGdAS@OCMIIM_@sBEIQOYKuDVqIdAw@L}@HB\\XHHF@LAHEHw@J"
            },
            {
                "distance": {
                    "text": "1 km",
                    "value": 1040
                },
                "duration": {
                    "text": "7 mins 48 secs",
                    "value": 468
                },
                "end_address": "Juhu Beach, Mumbai, Maharashtra",
                "start_address": "JW Marriott Mumbai Juhu, Juhu Road, Juhu Tara, Juhu, Mumbai, Maharashtra, India",
                "start_location": {
                    "lat": 19.1018504,
                    "lng": 72.8262233
                },
                "end_location": {
                    "lat": 19.1095171,
                    "lng": 72.8241298
                },
                "stop_id": "16921853",
                "optimize_status": "normal",
                "stop_type": "delivery",
                "arr_time": 6828,
                "end_time": 7128,
                "optimize_order": 6,
                "stop_order": 2,
                "share_stop_id": 16921852,
                "address_typed": {
                    "delivery_count": 0
                },
                "overview_polyline": "_zqsB_}n{Le@HM?MGEGCOBKRME]cBVkBL}H^QEyDb@wHXMRE\\Bj@GLOPYHqA?]DUXAfBmC~@WRJdA"
            },
            {
                "distance": {
                    "text": "9 km",
                    "value": 9969
                },
                "duration": {
                    "text": "26 mins 34 secs",
                    "value": 1594
                },
                "end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
                "start_address": "Juhu Beach, Mumbai, Maharashtra",
                "start_location": {
                    "lat": 19.1095171,
                    "lng": 72.8241298
                },
                "end_location": {
                    "lat": 19.1190749,
                    "lng": 72.8951151
                },
                "stop_id": null,
                "optimize_status": "normal",
                "stop_type": "normal",
                "arr_time": 8422,
                "end_time": 0,
                "optimize_order": 7,
                "stop_order": 2000,
                "share_stop_id": 0,
                "address_typed": {
                    "delivery_count": 0
                },
                "overview_polyline": "ogssBenn{LKeAVSlC_A@gBKBAaAGaA@u@CQX@JUCY{@Bg@E[GeEwByFgDs@m@kAsAu@UdBqDsC@_ICyKBU?DeSJgCEoGLuC@y@E{EGe@MmDIYGc@KuD@mDG]GsEAwGBeD@Y|@cE`@wBL{@\\sFr@{EB_@?]GwABkCP_Cf@iBvCuGpBeDv@kDn@{DrEyQp@gDVeBV{BZiBnAuEPw@Fo@@}@GoAkA{M[{CY_A[w@g@u@UUWc@pH_c@z@kDhEuOxBsIj@oBxDoNJy@Dy@JcFHgB\\gBXs@l@mAb@g@r@s@zCgChEgDhAyASKSUiFwC_@Mu@Qy@GkAEi@@i@F}@XmAVm@Hq@@qAE{Gc@cAOwC{@mBe@_@IEU{@oAmA_EiD}E{@yAEy@[kBiAwAaAeAi@JcABc@C[Yi@DwBTk@VYB_@MOJiAZ}AQM]GwBLoAGa@ISa@i@c@e@]Ok@O}@E"
            }
        ]
    }
}

{
    "code": 200,
    "status": true,
    "message": "Some stops is not settled in route optimization",
    "data": {
        "optimized": false,
        "legs": [],
        "route_stops": [
          {
            "id": 17019017,
            "address": "New York",
            "latitude": 40.7128,
            "longitude": 74.006,
            "optimized": false,
            "errors": [
                "Could not found nearest road"
            ]
          }
        ]
    }
}

This endpoint GET route information.

HTTP Request

GET {{base_url}}/api/v6/routes/:route_id/optimize_route

Query Parameters

Parameter	Default	Description
api_key	""	Api Access key
driver_id	""	Driver Id of the route

WebHooks

ZeoRoutePlanner allows you to use webhook we can notify you about the events. You can register a new webhook at our platform ("https://zeorouteplanner.com/app/team/settings/genrate-token").

Events

Stop Progress Webhook

Errors

The Zeo Route Planner API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
404	Not Found -- The specified request could not be found.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.