ВЧА

Вступ

Планувальник маршрутів Zeo допомагає власникам автопарків створювати та оптимізувати маршрути для своїх водіїв. Власники автопарків або малі підприємства, які здійснюють місцеві доставки в останню милю, можуть відстежувати статус доставки, поточне місцезнаходження водіїв і надсилати оновлення в реальному часі клієнтам. Мобільні додатки Zeo для водіїв-доставників оснащено бездоганною інтеграцією з усіма популярними навігаційними інструментами, включаючи waze, tomtom, карти Google тощо. У водія є всі важливі деталі під рукою, включаючи нотатки, дані клієнтів і кількість посилок. Zeo обробляє динамічне додавання та видалення адрес і перенаправляє послідовність, щоб забезпечити найбільш оптимізований маршрут. Завдяки Zeo власники автопарків заощаджують до 200 доларів на місяць на водія та отримують доступ до високоякісних звітів, таких як підтвердження доставки, підписи та позначки часу доставки

Authentication

ZeoRoutePlanner використовує ключі API, щоб дозволити доступ до API. Ви можете зареєструвати новий ключ API на нашій платформі (https://zeorouteplanner.com/app/team/settings/genrate-token).

ZeoRoutePlanner очікує, що ключ API буде включено в усі запити API до сервера в параметрах, які виглядають так:

api_key: api_key

API власника магазину

Створення зупинок

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": [{}]
        }
    ]
}'

Наведена вище команда повертає JSON зі структурою так:

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

Ця кінцева точка отримує всі драйвери.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
зупиняється [{}] Масив зупинок

Зупиняє параметри об’єкта

Параметр дефолт Опис
адреса "" Адреса зупинки
широта "" Адреса Latitude
довготи "" Довгота адреси
ноти "" Будь-яке повідомлення для додавання
оптимізувати_статус "нормальний"
тривалість_зупинки «Залишайтеся на зупинці»
прибуття_старт "" "зараз"
прибути_кінець "" "будь-коли"
раніше ""
останній ""
stop_type "" (доставка/вивіз)
Ім'я клієнта "" Ім'я клієнта
номер_мобільного_клієнта "" Контактний номер клієнта
driver_id "" Ідентифікатор водія
дата_зупинки "" Дата зупинки
кількість_посилок 1 Підрахунок посилок
метадані [] Спеціальне поле

Отримати всі драйвери

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

Наведена вище команда повертає JSON зі структурою так:

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

Ця кінцева точка отримує всі драйвери.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API

Створити драйвер

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": " "
}'

Наведена вище команда повертає JSON зі структурою так:

{
  "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
    }
  }
}

Ця кінцева точка створює драйвер.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
e-mail "" Електронна пошта водія
адреса "" Адреса водія
пароль "" Пароль для облікового запису водія
ім'я "" Ім'я водія
номер телефону "" Контактний номер

оновлення драйверів

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"
}'

Наведена вище команда повертає JSON зі структурою так:

{
  "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
    }
  }
}

Ця кінцева точка оновлює деталі драйвера.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
адреса "" Адреса водія
ім'я "" Ім'я водія
номер телефону "" Контактний номер водія
driver_id "" Ідентифікатор драйвера, який ми отримуємо з усіх API драйверів

Видалити драйвер

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

Наведена вище команда повертає JSON зі структурою так:

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

Ця кінцева точка видаляє драйвер.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
driver_id "" Ідентифікатор драйвера, який ми отримуємо з усіх API драйверів

Створити маршрут

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": [{}]
    }
  ]
}'

Наведена вище команда повертає JSON зі структурою так:

{
  "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": ""
         }
      ]
    }
  }
}

Ця кінцева точка створює маршрут.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
driver_id "" Ідентифікатор драйвера, який ми отримуємо з усіх API драйверів
початкова_адреса "" Початкова адреса маршруту
початкова_широта "" Початкова адреса Latitude
початкова_довгота "" Початкова адреса Довгота
кінцева_адреса "" Кінцева адреса маршруту
кінцева_широта "" Кінцева адреса Latitude
кінцева_довгота "" Кінцева адреса Довгота
назва маршруту "" Назва маршруту
driver_id "" Ідентифікатор водія для призначення маршруту
оригінал ""
зупиняється [] Зупинки між маршрутами
дата_маршруту '' Дата маршруту

Зупиняє параметри об’єкта

Параметр дефолт Опис
адреса "" Адреса зупинки
широта "" Адреса Latitude
довготи "" Довгота адреси
ноти "" Будь-яке повідомлення для додавання
оптимізувати_статус "нормальний"
тривалість_зупинки «Залишайтеся на зупинці»
прибуття_старт "" "зараз"
прибути_кінець "" "будь-коли"
раніше ""
останній ""
stop_type "" (доставка/вивіз)
Ім'я клієнта "" Ім'я клієнта
номер_мобільного_клієнта "" Контактний номер клієнта
кількість_посилок 1 Підрахунок посилок
метадані [{}] Спеціальне поле

Отримати інформацію про маршрут

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
}'

Наведена вище команда повертає JSON зі структурою так:

{
  "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": ""
        }
      ]
    }
  }
}

Ця кінцева точка ОТРИМУЄ інформацію про маршрут.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
route_id "" Ідентифікатор маршруту ми отримуємо зі списку маршрутів
driver_id "" ID водія маршруту

Отримайте оптимізовану інформацію про маршрут

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
}'

Наведена вище команда повертає JSON зі структурою так:

{
    "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"
            }
        ]
    }
}

Ця кінцева точка ОТРИМУЄ інформацію про маршрут.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
driver_id "" ID водія маршруту

Видалити маршрут

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
}'

Наведена вище команда повертає JSON зі структурою так:

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

Цей маршрут видалення кінцевої точки.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
route_id "" Ідентифікатор маршруту ми отримуємо зі списку маршрутів
driver_id "" ID водія маршруту

Отримати всі маршрути водія

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"
}'

Наведена вище команда повертає JSON зі структурою так:

{
  "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
  }
}

Ця кінцева точка отримує всі маршрути.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
обмежувати 50 Записи для повернення
зсув 0 Наступні записи для повернення
driver_id Ідентифікатор водія

Отримайте всі маршрути власників магазинів

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
}'

Наведена вище команда повертає JSON зі структурою так:

{
  "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
  }
}

Ця кінцева точка отримує всі маршрути.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
обмежувати 50 Записи для повернення
зсув 0 Наступні записи для повернення
дата початку нуль Дата початку маршруту (дд-мм-рррр)
Дата закінчення нуль Дата закінчення маршруту (дд-мм-рррр)

Створення маршруту для водія власником магазину

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"'

Наведена вище команда повертає JSON зі структурою так:

{
    "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": ""
                }
            ]
        }
    }
}

Ця кінцева точка використовується для створення маршруту для водія.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API (Перейти на сторінку Адреса вебсайту увійдіть в обліковий запис власника магазину, а потім перейдіть на сторінку Сторінка налаштуваньвиберіть отримати маркер API та згенеруйте api_key)
початкова_адреса "" початкова адреса маршруту
кінцева_адреса "" кінцева адреса маршруту
driver_email "" електронна адреса водія
файл "" завантажити файл у форматі xlsx ви можете завантажити, перейшовши за посиланням(Зразок посилання на файл)

Самовивіз

Створити маршрут

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
    }
  ]
}'

Наведена вище команда повертає JSON зі структурою так:

{
    "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
                }
            ]
        }
    }
}

Ця кінцева точка створює маршрут.

Запит HTTP

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

Параметри запиту

Параметр Тип даних дефолт Опис
driver_id int (*) Для створення маршруту потрібен driver_id
початкова_адреса рядок (*) Адреса, звідки починається маршрут
початкова_широта десятковий знак 0 Необхідна початкова_адреса АБО початкова_широта, початкова_довгота
початкова_довгота десятковий знак 0 Необхідна початкова_адреса АБО початкова_широта, початкова_довгота
кінцева_адреса рядок Кінцеве місце маршруту
кінцева_широта десятковий знак Потрібна або end_address, АБО end_latitude, end_longitude
кінцева_довгота десятковий знак Потрібна або end_address, АБО end_latitude, end_longitude
назва маршруту рядок (*) поточна дата (дд/мм/рр) Назва маршруту
зупиняється масив об'єктів (*) Зупиняє інформацію в масиві об'єкта

Зупиняє параметри об’єкта

Параметр Тип даних дефолт Опис
id INT (*) 0 1. Якщо stop_type — доставка, не потрібно надсилати ідентифікатор
2. Якщо stop_type pickup, тоді потрібно надіслати 20-значний ідентифікатор
стоп_замовлення int (*) 0 Додайте порядок зупинки
share_stop_id Int 0 1. Якщо stop_type — pickup, залиште його типовим
2. Якщо stop_type — це доставка, і ви не хочете зв’язуватися з самовивозом, залиште його за замовчуванням
3. Якщо ви хочете зв’язатися з будь-якою посадкою, введіть ідентифікатор цієї зупинки
stop_type рядок доставка значення мають бути доставка та самовивезення
адреса рядок Необхідна або адреса, АБО широта, довгота
широта десятковий знак 0 Необхідна або адреса, АБО широта, довгота
довготи десятковий знак 0 Необхідна або адреса, АБО широта, довгота
ноти рядок Зупинити пов’язану інформацію
тривалість_зупинки Int 2 Визначає тривалість зупинки в хвилинах, тобто скільки часу вона займає на місці клієнта.
Ім'я клієнта рядок Інформація про клієнта
номер_мобільного_клієнта рядок Інформація про клієнта
customer_email рядок Інформація про клієнта
address_typed {} {} 1. Якщо stop_type — це pickup, тоді ключ — це delivery_count, а значення — це загальна кількість доставки, пов’язаної з цією самовивезенням
2. якщо stop_type — доставка, залиште його типовим

Оновити маршрут

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
    }
  ]
}'

Наведена вище команда повертає JSON зі структурою так:

{
    "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
                }
            ]
        }
    }
}

Цей маршрут оновлення кінцевої точки.

Запит HTTP

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

Параметри запиту

Параметри запиту

Параметр Тип даних дефолт Опис
driver_id int (*) Для створення маршруту потрібен driver_id
початкова_адреса рядок (*) Адреса, звідки починається маршрут
початкова_широта десятковий знак 0 Необхідна початкова_адреса АБО початкова_широта, початкова_довгота
початкова_довгота десятковий знак 0 Необхідна початкова_адреса АБО початкова_широта, початкова_довгота
кінцева_адреса рядок Кінцеве місце маршруту
кінцева_широта десятковий знак Потрібна або end_address, АБО end_latitude, end_longitude
кінцева_довгота десятковий знак Потрібна або end_address, АБО end_latitude, end_longitude
назва маршруту рядок (*) поточна дата (дд/мм/рр) Назва маршруту
зупиняється масив об'єктів (*) Зупиняє інформацію в масиві об'єкта

Зупиняє параметри об’єкта

Параметр Тип даних дефолт Опис
id INT (*) 0 1. Якщо stop_type — доставка, не потрібно надсилати ідентифікатор
2. Якщо stop_type pickup, тоді потрібно надіслати 20-значний ідентифікатор
стоп_замовлення int (*) 0 Додайте порядок зупинки
share_stop_id Int 0 1. Якщо stop_type — pickup, залиште його типовим
2. Якщо stop_type — це доставка, і ви не хочете зв’язуватися з самовивозом, залиште його за замовчуванням
3. Якщо ви хочете зв’язатися з будь-якою посадкою, введіть ідентифікатор цієї зупинки
stop_type рядок доставка значення мають бути доставка та самовивезення
адреса рядок Необхідна або адреса, АБО широта, довгота
широта десятковий знак 0 Необхідна або адреса, АБО широта, довгота
довготи десятковий знак 0 Необхідна або адреса, АБО широта, довгота
ноти рядок Зупинити пов’язану інформацію
тривалість_зупинки Int 2 Визначає тривалість зупинки в хвилинах, тобто скільки часу вона займає на місці клієнта.
Ім'я клієнта рядок Інформація про клієнта
номер_мобільного_клієнта рядок Інформація про клієнта
customer_email рядок Інформація про клієнта
address_typed {} {} 1. Якщо stop_type — це pickup, тоді ключ — це delivery_count, а значення — це загальна кількість доставки, пов’язаної з цією самовивезенням
2. якщо stop_type — доставка, залиште його типовим

Отримати інформацію про маршрут

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
}'

Наведена вище команда повертає JSON зі структурою так:

{
    "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
                }
            ]
        }
    }
}

Ця кінцева точка ОТРИМУЄ інформацію про маршрут.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
route_id "" Ідентифікатор маршруту ми отримуємо зі списку маршрутів
driver_id "" ID водія маршруту

Видалити маршрут доставки

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
}'

Наведена вище команда повертає JSON зі структурою так:

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

Цей маршрут видалення кінцевої точки.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
route_id "" Ідентифікатор маршруту ми отримуємо зі списку маршрутів
driver_id "" ID водія маршруту

Отримайте оптимізовану інформацію про маршрут

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
}'

Наведена вище команда повертає JSON у такій структурі, якщо optimize:true:

{
    "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"
            }
        ]
    }
}

Наведена вище команда повертає JSON у такій структурі, якщо optimize:false:

{
    "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"
            ]
          }
        ]
    }
}

Ця кінцева точка ОТРИМУЄ інформацію про маршрут.

Запит HTTP

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

Параметри запиту

Параметр дефолт Опис
api_key "" Ключ доступу до API
driver_id "" ID водія маршруту

WebHooks

ZeoRoutePlanner дозволяє використовувати вебхук, ми можемо повідомляти вас про події. Ви можете зареєструвати новий вебхук на нашій платформі ("https://zeorouteplanner.com/app/team/settings/genrate-token").

Події

помилки

Zeo Route Planner API використовує такі коди помилок:

Код помилки Сенс
400 Поганий запит -- Ваш запит недійсний.
401 Неавторизовано -- ваш ключ API неправильний.
404 Не знайдено -- вказаний запит не знайдено.
500 Внутрішня помилка сервера -- у нас виникла проблема з нашим сервером. Спробуйте ще раз пізніше.
503 Служба недоступна -- Ми тимчасово вимкнені для обслуговування. Будь-ласка спробуйте пізніше.