NAV

Introdução

O planejador de rotas Zeo ajuda os proprietários de frotas a criar e otimizar rotas para seus motoristas. Proprietários de frotas ou pequenas empresas que fazem entregas locais de última milha podem acompanhar o status da entrega, a localização ao vivo dos motoristas e enviar atualizações em tempo real aos clientes. Os aplicativos móveis da Zeo para motoristas de entrega são equipados com integrações perfeitas com todas as ferramentas de navegação populares, incluindo Waze, Tomtom, Google Maps, etc. O motorista tem todos os detalhes importantes ao seu alcance, incluindo notas, detalhes do cliente e contagem de pacotes. Zeo lida com adição e exclusão dinâmica de endereços e redireciona a sequência para fornecer a rota mais otimizada. Com Zeo, os proprietários de frotas economizam até 200$ por mês por motorista e têm acesso a relatórios de alta qualidade, como comprovantes de entrega, assinaturas e carimbos de data de entrega

Autenticação

ZeoRoutePlanner usa chaves API para permitir acesso à API. Você pode registrar uma nova chave API em nossa plataforma (https://zeorouteplanner.com/app/team/settings/genrate-token).

ZeoRoutePlanner espera que a chave da API seja incluída em todas as solicitações de API ao servidor em parâmetros semelhantes aos seguintes:

api_key: api_key

API do proprietário da loja

Criar paradas

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint recupera todos os drivers.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
pára [{}} Matriz de paradas

Interrompe os parâmetros do objeto

Parâmetro Padrão Descrição
endereço "" Endereço de parada
latitude "" Endereço Latitude
longitude "" Longitude do endereço
notas "" Qualquer mensagem para adicionar
otimizar_status "normal"
duração_parada "Fique parado"
chegar_início "" "agora"
chegar_fim "" "a qualquer momento"
mais cedo ""
mais recente ""
tipo_de_parada "" (entrega/retirada)
nome do cliente "" Nome do cliente
número_móvel_do_cliente "" Número de contato do cliente
ID_do_motorista "" ID do motorista
data_de_parada "" Data de Parada
contagem_de_pacotes 1 Contagem de pacotes
metadados [] Campo customizado

Obtenha todos os drivers

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint recupera todos os drivers.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint cria driver.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
email "" E-mail do motorista
endereço "" Endereço do motorista
senha "" Senha da conta do motorista
nome "" Nome do motorista
telefone não "" Número de contato de

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

O comando acima retorna JSON estruturado assim:

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

Detalhes do driver de atualização deste endpoint.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
endereço "" Endereço do motorista
nome "" Nome do motorista
telefone não "" Número de contato do motorista
ID_do_motorista "" ID do driver que obtemos de todas as APIs do driver

Excluir driver

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

O comando acima retorna JSON estruturado assim:

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

Este driver de exclusão de endpoint.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_do_motorista "" ID do driver que obtemos de todas as APIs do driver

Criar rota

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint cria rota.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_do_motorista "" ID do driver que obtemos de todas as APIs do driver
endereço_inicial "" Endereço inicial da rota
latitude_inicial "" Endereço inicial Latitude
longitude_inicial "" Endereço inicial Longitude
end_address "" Endereço final da rota
latitude_final "" Endereço final Latitude
longitude_final "" Longitude do endereço final
nome_da_rota "" Nome da Rota
ID_do_motorista "" ID do motorista para atribuir rota
orginal ""
pára [] Paradas entre rotas
data_rota '' Data da rota

Interrompe os parâmetros do objeto

Parâmetro Padrão Descrição
endereço "" Endereço de parada
latitude "" Endereço Latitude
longitude "" Longitude do endereço
notas "" Qualquer mensagem para adicionar
otimizar_status "normal"
duração_parada "Fique parado"
chegar_início "" "agora"
chegar_fim "" "a qualquer momento"
mais cedo ""
mais recente ""
tipo_de_parada "" (entrega/retirada)
nome do cliente "" Nome do cliente
número_móvel_do_cliente "" Número de contato do cliente
contagem_de_pacotes 1 Contagem de pacotes
metadados [{}} Campo customizado

Obtenha informações da rota

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint GET informações de rota.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_da_rota "" ID da rota que obtemos da lista de rotas
ID_do_motorista "" ID do motorista da rota

Obtenha informações otimizadas de rota

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint GET informações de rota.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_do_motorista "" ID do motorista da rota

Apagar rota

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

O comando acima retorna JSON estruturado assim:

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

Esta rota de exclusão de endpoint.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_da_rota "" ID da rota que obtemos da lista de rotas
ID_do_motorista "" ID do motorista da rota

Obtenha todas as rotas do motorista

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint busca todas as rotas.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
limitar 50 Registros para retornar
compensar 0 Próximos registros a serem retornados
ID_do_motorista ID do motorista

Obtenha todas as rotas do proprietário da loja

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint busca todas as rotas.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
limitar 50 Registros para retornar
compensar 0 Próximos registros a serem retornados
data de início zero Data de início da rota (dd-mm-aaaa)
data final zero Data de término da rota (dd-mm-aaaa)

Obtenha a rota criada para o motorista pelo proprietário da loja

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint é usado para criar rota para o driver.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API (ir para a página URL do site faça login na conta do proprietário da loja e vá para a página Página de configuraçõesselecione obter token de API e gere api_key)
endereço_inicial "" endereço inicial da rota
end_address "" endereço final da rota
email_motorista "" e-mail do motorista
lima "" fazer upload do arquivo no formato xlsx que você pode baixar clicando no link (Link de arquivo de amostra)

Entregas de coleta

Criar rota

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint cria rota.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Tipo de dados Padrão Descrição
ID_do_motorista interno (*) Precisa de driver_id para criar uma rota
endereço_inicial corda (*) Endereço de onde começa a rota
latitude_inicial decimal 0 Obrigatório start_address OU start_latitude,start_longitude
longitude_inicial decimal 0 Obrigatório start_address OU start_latitude,start_longitude
end_address corda Localização final da rota
latitude_final decimal Obrigatório end_address OU end_latitude,end_longitude
longitude_final decimal Obrigatório end_address OU end_latitude,end_longitude
nome_da_rota corda (*) data atual (dd/mm/aa) Nome da rota
pára matriz de objetos (*) Interrompe informações na matriz de objetos

Interrompe os parâmetros do objeto

Parâmetro Tipo de dados Padrão Descrição
id INT (*) 0 1. Se stop_type for delivery, não há necessidade de enviar id
2. Se for retirada stop_type, será necessário enviar um ID de 20 dígitos
stop_order interno (*) 0 Adicionar ordem de parada
share_stop_id int 0 1. Se stop_type for pickup deixe como padrão
2. Se stop_type for delivery e não quiser vincular com retirada deixe como padrão
3. Se você deseja vincular a qualquer coleta, coloque o ID dessa parada de coleta
tipo_de_parada corda Entrega os valores devem ser entrega e retirada
endereço corda Endereço obrigatório OU latitude, longitude
latitude decimal 0 Endereço obrigatório OU latitude, longitude
longitude decimal 0 Endereço obrigatório OU latitude, longitude
notas corda Interromper informações relacionadas
duração_parada int 2 Especifica a duração da parada em minutos, ou seja, quanto tempo leva no local do cliente.
nome do cliente corda Informação ao Cliente
número_móvel_do_cliente corda Informação ao Cliente
email do cliente corda Informação ao Cliente
endereço_typed {} {} 1. Se stop_type for coleta, a chave será delivery_count e o valor estará em int. O número total de entregas está vinculado a esta coleta.
2. se stop_type for delivery deixe como padrão

Atualizar rota

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

O comando acima retorna JSON estruturado assim:

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

Esta rota de atualização do endpoint.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetros de consulta

Parâmetro Tipo de dados Padrão Descrição
ID_do_motorista interno (*) Precisa de driver_id para criar uma rota
endereço_inicial corda (*) Endereço de onde começa a rota
latitude_inicial decimal 0 Obrigatório start_address OU start_latitude,start_longitude
longitude_inicial decimal 0 Obrigatório start_address OU start_latitude,start_longitude
end_address corda Localização final da rota
latitude_final decimal Obrigatório end_address OU end_latitude,end_longitude
longitude_final decimal Obrigatório end_address OU end_latitude,end_longitude
nome_da_rota corda (*) data atual (dd/mm/aa) Nome da rota
pára matriz de objetos (*) Interrompe informações na matriz de objetos

Interrompe os parâmetros do objeto

Parâmetro Tipo de dados Padrão Descrição
id INT (*) 0 1. Se stop_type for delivery, não há necessidade de enviar id
2. Se for retirada stop_type, será necessário enviar um ID de 20 dígitos
stop_order interno (*) 0 Adicionar ordem de parada
share_stop_id int 0 1. Se stop_type for pickup deixe como padrão
2. Se stop_type for delivery e não quiser vincular com retirada deixe como padrão
3. Se você deseja vincular a qualquer coleta, coloque o ID dessa parada de coleta
tipo_de_parada corda Entrega os valores devem ser entrega e retirada
endereço corda Endereço obrigatório OU latitude, longitude
latitude decimal 0 Endereço obrigatório OU latitude, longitude
longitude decimal 0 Endereço obrigatório OU latitude, longitude
notas corda Interromper informações relacionadas
duração_parada int 2 Especifica a duração da parada em minutos, ou seja, quanto tempo leva no local do cliente.
nome do cliente corda Informação ao Cliente
número_móvel_do_cliente corda Informação ao Cliente
email do cliente corda Informação ao Cliente
endereço_typed {} {} 1. Se stop_type for coleta, a chave será delivery_count e o valor estará em int. O número total de entregas está vinculado a esta coleta.
2. se stop_type for delivery deixe como padrão

Obtenha informações da rota

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

O comando acima retorna JSON estruturado assim:

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

Este endpoint GET informações de rota.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_da_rota "" ID da rota que obtemos da lista de rotas
ID_do_motorista "" ID do motorista da rota

Excluir rota de entrega de coleta

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

O comando acima retorna JSON estruturado assim:

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

Esta rota de exclusão de endpoint.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_da_rota "" ID da rota que obtemos da lista de rotas
ID_do_motorista "" ID do motorista da rota

Obtenha informações otimizadas de rota

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

O comando acima retorna JSON estruturado assim se optimizar: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"
            }
        ]
    }
}

O comando acima retorna JSON estruturado assim se 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"
            ]
          }
        ]
    }
}

Este endpoint GET informações de rota.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetro Padrão Descrição
Chave API "" Chave de acesso da API
ID_do_motorista "" ID do motorista da rota

WebHooks

ZeoRoutePlanner permite que você use o webhook para notificá-lo sobre os eventos. Você pode registrar um novo webhook em nossa plataforma ("https://zeorouteplanner.com/app/team/settings/genrate-token").

Eventos

erros

A API Zeo Route Planner usa os seguintes códigos de erro:

Erro de código Significado
400 Solicitação incorreta – sua solicitação é inválida.
401 Não autorizado – sua chave de API está errada.
404 Not Found – A solicitação especificada não foi encontrada.
500 Erro interno do servidor – Tivemos um problema com nosso servidor. Tente mais tarde.
503 Serviço indisponível – Estamos temporariamente off-line para manutenção. Por favor, tente novamente mais tarde.