API Dispatch (Otimização de Rotas)

Q: Como faço a autenticação no Dispatch REST e SOAP?

O REST utiliza a sua TrackServiceKey no cabeçalho X-API-Key. O SOAP utiliza a mesma TrackServiceKey em SessionIDHeader como SessionID.

Q: Preciso de LatLong ou Address para as paragens?

LatLong é preferível. Se LatLong não for fornecido, Address é obrigatório para que a TrackRoad possa geocodificar a paragem.

Utilize o Dispatch para otimizar rotas em múltiplos veículos e muitas paragens. O Dispatch devolve uma rota ordenada por veículo com saída de horários, distância e atribuição para roteamento de entregas, assistência no terreno, operações de estafetas e planeamento de frotas.

O Dispatch atribui paragens a vários veículos e devolve rotas otimizadas com ordem das paragens, ETA, distância e duração para cada veículo.

Precisa do contrato completo?

Utilize o Swagger para modelos REST e o WSDL para detalhes de integração SOAP.

Ver Swagger UI Ver WSDL SOAP Visão geral da referência da API

Índice

O que faz o Dispatch
Modo Optima, Time Window & TimeWindowDepot
Múltiplas recolhas e entregas
Endpoints e URLs base
Autenticação
Esquema do pedido
Esquema da resposta
Erros comuns
Boas práticas
Endpoints relacionados
FAQ

O que faz o Dispatch#

O Dispatch resolve um problema de roteamento multi-veículo. Atribui paragens a veículos e ordena cada rota usando restrições como janelas temporais, capacidade, prioridade e locais de início ou fim.

LatLong é preferível. Cada paragem deve incluir LatLong sempre que possível. Se LatLong não for fornecido, tem de fornecer Address para que o serviço possa geocodificar a paragem.

O método Dispatch aceita uma lista de veículos e uma lista de localizações de paragem. Cada veículo pode incluir um local de início e um local de fim opcional. Cada localização pode conter um nome, campos de morada e latitude e longitude.

Se a latitude e a longitude estiverem presentes, a TrackRoad utiliza-as diretamente. Caso contrário, o serviço geocodifica a morada para obter coordenadas.

O Dispatch devolve itens de veículo. Cada item de veículo contém a rota atribuída como uma lista ordenada de paragens, otimizada por localização, capacidade, horários e outros fatores de roteamento.

Quando apenas um veículo está disponível, o Dispatch executa apenas a otimização de rota. Os modos de dispatch são sobretudo importantes quando existem vários veículos disponíveis.

Se não tiver a certeza de qual o modo de dispatch a utilizar, comece com Auto. Para uma otimização altamente precisa com um único veículo, utilize Optima.

Modo Optima, Time Window & TimeWindowDepot#

Em algumas linguagens pode não ser possível passar um datetime nulo. Nesse caso, utilize 0001-01-01T00:00:00. Datas anteriores ao limite do sistema são tratadas como valores nulos.

Para melhores resultados, utilize o DispatchMode Optima.

Três variáveis afetam o comportamento do dispatch com janelas temporais:

CanArriveEarly
TimeConstraintArrival
TimeConstraintDeparture

Opção 1: CanArriveEarly = true

Quando CanArriveEarly é true, a janela temporal começa no início do dia. Se TimeConstraintArrival for nulo, a paragem pode ser visitada a qualquer hora durante o dia. Se TimeConstraintArrival estiver definido, define a hora máxima de chegada aceitável. A hora de partida é ignorada.

Opção 2: CanArriveEarly = false

Quando CanArriveEarly é false, a chegada e a partida definem a janela temporal permitida. Se a chegada estiver definida e a partida for nula, a paragem é tratada como um agendamento exato. Se ambas estiverem definidas, a TrackRoad tenta visitar a paragem dentro desse intervalo temporal.

Opção 3: Duas janelas temporais

Também pode especificar uma segunda janela temporal utilizando TimeConstraintArrival2 e TimeConstraintDeparture2. Isto é útil quando uma paragem só pode ser visitada em dois períodos distintos, como horários restritos de entregas no centro da cidade. O TimeWindowDepot segue a mesma lógica, mas assume que os veículos começam e terminam num depósito comum.

As pausas podem ser modeladas com LocationType = Break. As cadeias de múltiplas recolhas e entregas suportam apenas uma janela temporal de entrega ao nível da entrega, e essa restrição temporal filha não pode ser mais apertada do que a restrição principal.

Múltiplas recolhas e entregas#

O Dispatch suporta encadeamento de recolhas e entregas. Isto é útil para operações de estafetas e fluxos de trabalho em que uma paragem tem de ser visitada antes de outra.

Utilize Midway para a primeira paragem numa cadeia e Delivery para especificar a localização relacionada seguinte. Utilize DeliveryNonStop para determinar se a próxima entrega associada tem de ocorrer imediatamente ou pode ocorrer mais tarde na mesma rota.

Por exemplo, se uma encomenda for recolhida na localização B e entregue na localização M, a TrackRoad preserva a relação obrigatória entre a recolha e a entrega enquanto continua a otimizar a rota em torno das restantes paragens.

DeliveryNonStop = true

Quando DeliveryNonStop é true, a paragem de entrega associada tem de ser visitada imediatamente após a paragem de recolha.

DeliveryNonStop = false

Quando DeliveryNonStop é false, a entrega associada tem de ocorrer depois da recolha, mas não precisa de acontecer imediatamente.

Pode encadear várias entregas, como B → M → N, definindo Delivery e KeepSameOrder em cada paragem associada.

Para trabalhos de ida e volta, defina localizações de recolha, entrega e regresso como uma cadeia. Uma recomendação comum é DeliveryNonStop = false e KeepSameOrder = true para uma otimização mais flexível, preservando a ordem do negócio.

Exemplo de paragens de ida e volta da API TrackRoad — Exemplo: Paragens de ida e volta.

Exemplo de rota de ida e volta da API TrackRoad — Exemplo: Rota de ida e volta.

Endpoints e URLs base#

REST

Item	Valor
URL base	https://trackservice.trackroad.com
Endpoint	`POST /rest/dispatch`
URL completa	https://trackservice.trackroad.com/rest/dispatch
Content-Type	`application/json`

SOAP

Item	Valor
Endpoint	https://trackservice.trackroad.com/TrackService.asmx
WSDL	https://trackservice.trackroad.com/TrackService.asmx?WSDL
Método	`Dispatch`
SOAPAction	http://trackservice.trackroad.com/Dispatch

O SOAP utiliza os mesmos modelos DispatchSpecification e DispatchResult. A principal diferença é o envelope SOAP e a autenticação baseada em cabeçalhos.

Autenticação#

Autenticação REST (X-API-Key)

Inclua a sua TrackServiceKey no cabeçalho X-API-Key em todos os pedidos. Gere a chave na sua conta TrackRoad em Autenticação da API .

curl -X POST "https://trackservice.trackroad.com/rest/dispatch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d '{ "RoutingService": 0, "DistanceUnit": 0, "RouteOptimize": 0, "Vehicles": [], "Locations": [] }'

using System.Net.Http;
using System.Text;

var url = "https://trackservice.trackroad.com/rest/dispatch";
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-API-Key", "YOUR_TRACKSERVICEKEY");

var json = @"{
  ""RoutingService"": 0,
  ""DistanceUnit"": 0,
  ""RouteOptimize"": 0,
  ""Vehicles"": [],
  ""Locations"": []
}";
using var content = new StringContent(json, Encoding.UTF8, "application/json");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://trackservice.trackroad.com/rest/dispatch";

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_TRACKSERVICEKEY"
  },
  body: JSON.stringify({
    RoutingService: 0,
    DistanceUnit: 0,
    RouteOptimize: 0,
    Vehicles: [],
    Locations: []
  })
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    String json = "{"
      + "\"RoutingService\":0,"
      + "\"DistanceUnit\":0,"
      + "\"RouteOptimize\":0,"
      + "\"Vehicles\":[],"
      + "\"Locations\":[]"
      + "}";

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));

    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/dispatch")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://trackservice.trackroad.com/rest/dispatch"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_TRACKSERVICEKEY"
}
payload = {
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "Vehicles": [],
  "Locations": []
}

r = requests.post(url, headers=headers, json=payload)
print(r.text)

<?php
$url = "https://trackservice.trackroad.com/rest/dispatch";

$payload = json_encode([
  "RoutingService" => 0,
  "DistanceUnit" => 0,
  "RouteOptimize" => 0,
  "Vehicles" => [],
  "Locations" => []
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: YOUR_TRACKSERVICEKEY"
  ],
  CURLOPT_POSTFIELDS => $payload
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://trackservice.trackroad.com/rest/dispatch")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"
req.body = {
  RoutingService: 0,
  DistanceUnit: 0,
  RouteOptimize: 0,
  Vehicles: [],
  Locations: []
}.to_json

res = http.request(req)
puts res.body

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://trackservice.trackroad.com/rest/dispatch"
  jsonBody := []byte(`{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0,"Vehicles":[],"Locations":[]}`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonBody))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("X-API-Key", "YOUR_TRACKSERVICEKEY")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://trackservice.trackroad.com/rest/dispatch"
  val json = """{"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0,"Vehicles":[],"Locations":[]}"""

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "application/json")
    .header("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://trackservice.trackroad.com/rest/dispatch";
  const char *json = "{\"RoutingService\":0,\"DistanceUnit\":0,\"RouteOptimize\":0,\"Vehicles\":[],\"Locations\":[]}";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://trackservice.trackroad.com/rest/dispatch";
  std::string json = R"({"RoutingService":0,"DistanceUnit":0,"RouteOptimize":0,"Vehicles":[],"Locations":[]})";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json.c_str());

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://trackservice.trackroad.com/rest/dispatch"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSDictionary *payload = @{
      @"RoutingService": @0,
      @"DistanceUnit": @0,
      @"RouteOptimize": @0,
      @"Vehicles": @[],
      @"Locations": @[]
    };

    NSData *body = [NSJSONSerialization dataWithJSONObject:payload options:0 error:nil];
    [req setHTTPBody:body];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req
      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://trackservice.trackroad.com/rest/dispatch")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let payload: [String: Any] = [
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "Vehicles": [],
  "Locations": []
]
req.httpBody = try! JSONSerialization.data(withJSONObject: payload)

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

Mantenha as chaves API no servidor. Não incorpore chaves em código de browser ou clientes móveis.

Autenticação SOAP (SessionIDHeader)

Para pedidos SOAP, envie a sua TrackServiceKey em SessionIDHeader como SessionID. Os antigos Login e Logout não são necessários quando utiliza autenticação com TrackServiceKey.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

/*
  1) Add Service Reference to:
     https://trackservice.trackroad.com/TrackService.asmx?WSDL

  2) Set SessionIDHeader.SessionID = YOUR_TRACKSERVICEKEY
     then call Dispatch(spec).
*/

var client = new TrackService.TrackServiceSoapClient();
var header = new TrackService.SessionIDHeader { SessionID = "YOUR_TRACKSERVICEKEY" };

var spec = new TrackService.DispatchSpecification
{
    RoutingService = TrackService.RoutingService.NetRoad,
    DistanceUnit = TrackService.DistanceUnit.Mile,
    RouteOptimize = TrackService.RouteOptimize.MinimizeTime,
    Vehicles = new TrackService.Vehicle[] { },
    Locations = new TrackService.Location[] { }
};

var result = client.Dispatch(header, spec);

Os namespaces e prefixos SOAP podem variar consoante a sua ferramenta. Um cliente gerado a partir do WSDL costuma ser a opção mais simples.

Esquema do pedido#

O corpo do pedido é um único objeto: DispatchSpecification. No mínimo, forneça veículos e localizações.

DispatchSpecification

Propriedade	Tipo	Obrigatório	Descrição
`RoutingService`	int (enum)	Não	Motor de roteamento. 0 = NetRoad, 1 = TrackRoad, 2 = Bing. Recomendado: 0 = NetRoad.
`IsNeedMatchCode`	bool	Não	Se true, inclui códigos de qualidade de correspondência de geocodificação quando aplicável.
`CurrentTime`	string (date-time)	Não	Referência de hora atual utilizada para restrições temporais em formato ISO 8601.
`DispatchMode`	int (enum)	Não	Estratégia de otimização. Para recomendações de modo, consulte Modos de Dispatch.
`MinimumOptimization`	int	Não	Limiar de intensidade da otimização. Intervalo típico: 1 a 10.
`DistanceUnit`	int (enum)	Não	0 = Milha, 1 = Quilómetro.
`RouteOptimize`	int (enum)	Não	0 = MinimizeTime, 1 = MinimizeDistance. Recomendado: 0 = MinimizeTime.
`Vehicles`	Vehicle[]	Não	Veículos disponíveis para dispatch.
`Locations`	Location[]	Sim	Paragens a atribuir e ordenar.

DispatchMode

Propriedade	Tipo	Valor	Descrição
`Auto`	int	0	Seleciona automaticamente uma estratégia de dispatch adequada. Melhor ponto de partida por defeito.
`EqualStop`	int	1	Tenta distribuir um número igual de paragens pelos veículos.
`SingleRegion`	int	2	Útil quando os veículos estão geograficamente dispersos, mas servem paragens em áreas semelhantes.
`MultipleRegion`	int	3	Útil para veículos a operar em cidades diferentes ou regiões distantes e para dispatch de assistência no terreno em tempo real.
`EqualHour`	int	4	Tenta dividir o trabalho em rotas com duração total semelhante.
`EqualDistance`	int	5	Tenta dividir o trabalho em rotas com distância total semelhante.
`TimeWindow`	int	6	Dá prioridade a janelas de agendamento e entrega. A otimização pode ser reduzida para cumprir restrições temporais.
`TimeWindowDepot`	int	7	Modo de janela temporal que assume um depósito central partilhado pelos veículos.
`Optima`	int	8	Modo de elevada precisão para um único veículo, com ou sem janelas temporais.
`BalanceLocation`	int	9	Equilibra o número de paragens atribuídas entre vários motoristas.
`BalanceTime`	int	10	Equilibra o tempo de rota entre vários motoristas.
`MinimumVehicles`	int	11	Seleciona o número mínimo de veículos necessário para servir todas as paragens, tendo em conta fatores de roteamento.

Vehicle

Propriedade	Tipo	Obrigatório	Descrição
`Name`	string	Recomendado	Identificador do veículo apresentado nos resultados.
`Email`	string	Não	Contacto opcional do motorista ou veículo.
`Group`	string	Não	Campo de agrupamento opcional, como equipa, depósito ou região.
`Speed`	int	Não	Substituição opcional da velocidade. Se definido como 0, é utilizada a velocidade rodoviária predefinida.
`MaxStops`	int	Não	Número máximo de paragens por rota para o veículo.
`MaxWeight`	double	Não	Capacidade máxima de peso do veículo.
`MaxSkids`	int	Não	Capacidade máxima de pallets/skids do veículo.
`MaxVolume`	double	Não	Capacidade máxima de volume do veículo.
`MaxMinutes`	int	Não	Duração máxima da rota para o veículo.
`FuelCost`	double	Não	Parâmetro de custo opcional utilizado por alguns modos de otimização.
`OnTheRoad`	bool	Não	Se true, uma rota de vários dias pode continuar a partir da localização de fim do dia anterior, em vez de regressar ao ponto de partida original.
`Tin`	string (date-time)	Não	Data/hora a partir da qual o veículo está disponível.
`Tout`	string (date-time)	Não	Data/hora até à qual o veículo está disponível.
`StartLocation`	Location	Não	Depósito de início ou posição inicial opcional do veículo.
`FinishLocation`	Location	Não	Depósito de fim ou posição final opcional do veículo.
`Roles`	string	Não	Cadeia opcional de perfis que pode ser correspondida com condições da paragem.
`TransportType`	int (enum)	Não	Modo de transporte, como carro, camião, autocarro, motociclo, pedestre, trotinete ou bicicleta.
`ExcludeTolls`	bool	Não	Especifica se as estradas com portagem devem ser evitadas.
`ExcludeHighways`	bool	Não	Especifica se as autoestradas devem ser evitadas.
`UseTruckRoute`	bool	Não	Especifica se as rotas para camiões devem ser preferidas ou permitidas.
`Width`	float	Não	Largura do veículo em metros.
`Height`	float	Não	Altura do veículo em metros.
`Length`	float	Não	Comprimento do veículo em metros.
`AxleLoad`	float	Não	Carga por eixo do veículo em toneladas métricas.
`AxleCount`	int	Não	Número de eixos.

Exemplo da funcionalidade OnTheRoad de veículo na API TrackRoad — Exemplo: Comportamento diário da rota com OnTheRoad ativado versus desativado.

Location

Cada localização deve incluir LatLong sempre que possível. Se faltarem coordenadas, Address é obrigatório para que a TrackRoad possa geocodificar a paragem.

Propriedade	Tipo	Obrigatório	Descrição
`MatchCode`	int (enum)	Não	Código de qualidade de correspondência da geocodificação.
`Name`	string	Não	Rótulo da paragem mostrado nos resultados.
`Delivery`	string	Não	Nome da localização de entrega associada ou rótulo do cliente.
`DeliveryNonStop`	bool	Não	Determina se a entrega associada tem de ocorrer imediatamente após a paragem atual.
`KeepSameOrder`	bool	Não	Se true, preserva a ordem relativa definida no pedido.
`Vehicle`	string	Não	Pré-atribuição opcional a um veículo específico pelo nome.
`Description`	string	Não	Notas ou descrição opcionais.
`Phone`	string	Não	Número de telefone de contacto opcional.
`LatLong`	LatLong	Condicional	Entrada de coordenadas preferida. Obrigatória se Address não for fornecido.
`Address`	Address	Condicional	Morada utilizada para geocodificação quando LatLong não é fornecido.
`Priority`	int	Não	Indicação de prioridade para a otimização.
`Wait`	int	Não	Tempo de serviço ou de espera na paragem.
`Volume`	double	Não	Procura de volume consumida da capacidade do veículo.
`Weight`	double	Não	Procura de peso consumida da capacidade do veículo.
`Skids`	int	Não	Procura de skids consumida da capacidade do veículo.
`TimeConstraintArrival`	string (date-time)	Não	Valor principal de chegada da janela temporal.
`TimeConstraintDeparture`	string (date-time)	Não	Valor principal de partida da janela temporal.
`TimeConstraintArrival2`	string (date-time)	Não	Valor opcional de chegada da segunda janela temporal.
`TimeConstraintDeparture2`	string (date-time)	Não	Valor opcional de partida da segunda janela temporal.
`LocationType`	int (enum)	Não	0 = Midway, 1 = Start, 2 = Finish, 3 = Delivery, 4 = MidwayDrop, 5 = Break.
`CanArriveEarly`	bool	Não	Se false, não é permitida a chegada antes da janela temporal autorizada.
`Conditions`	string	Não	Regra de negócio ou condição de correspondência de perfil opcional.

LatLong

Propriedade	Tipo	Obrigatório	Descrição
`Latitude`	double	Sim	Latitude em graus (-90 a 90).
`Longitude`	double	Sim	Longitude em graus (-180 a 180).

Address

Propriedade	Tipo	Obrigatório	Descrição
`Street`	string	Recomendado	Morada.
`City`	string	Recomendado	Cidade.
`State`	string	Não	Estado ou região.
`PostalCode`	string	Não	Código postal.
`Country`	string	Recomendado	País.

Esquema da resposta#

Uma resposta com sucesso devolve DispatchResult contendo itens de rota por veículo e erros ou avisos opcionais.

DispatchResult

Propriedade	Tipo	Descrição
`Items`	VehicleItem[]	Itens de resultado por veículo contendo a rota atribuída.
`Errors`	Error[]	Erros ou avisos opcionais.
`Status`	int (enum)	Estado da operação: 0 = None, 1 = Success, 2 = Failed, 3 = SuccessWithErrors.

VehicleItem

Propriedade	Tipo	Descrição
`Vehicle`	Vehicle	O veículo associado a esta rota.
`Locations`	Location[]	Localizações ordenadas atribuídas a esse veículo.

Error

Propriedade	Tipo	Descrição
`Message`	string	Mensagem de erro ou aviso legível por humanos.

Exemplos#

Os blocos de código de pedido e resposta de exemplo podem permanecer inalterados e não necessitam de localização.

REST: Minimal request example (recommended pattern)#

{
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "DispatchMode": 0,
  "Vehicles": [
    {
      "Name": "Truck 1",
      "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
    }
  ],
  "Locations": [
    { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
    { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
  ]
}

REST request examples (multiple languages)#

curl -X POST "https://trackservice.trackroad.com/rest/dispatch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d '{
    "RoutingService": 0,
    "DistanceUnit": 0,
    "RouteOptimize": 0,
    "DispatchMode": 0,
    "Vehicles": [
      {
        "Name": "Truck 1",
        "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
        "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
      }
    ],
    "Locations": [
      { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
      { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
    ]
  }'

using System.Net.Http;
using System.Text;

var url = "https://trackservice.trackroad.com/rest/dispatch";
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-API-Key", "YOUR_TRACKSERVICEKEY");

var json = @"{
  ""RoutingService"": 0,
  ""DistanceUnit"": 0,
  ""RouteOptimize"": 0,
  ""DispatchMode"": 0,
  ""Vehicles"": [
    {
      ""Name"": ""Truck 1"",
      ""StartLocation"": { ""LatLong"": { ""Latitude"": 37.7946, ""Longitude"": -122.3950 }, ""LocationType"": 1 },
      ""FinishLocation"": { ""LatLong"": { ""Latitude"": 37.7946, ""Longitude"": -122.3950 }, ""LocationType"": 2 }
    }
  ],
  ""Locations"": [
    { ""Name"": ""Stop A"", ""LatLong"": { ""Latitude"": 37.7897, ""Longitude"": -122.4011 }, ""LocationType"": 0 },
    { ""Name"": ""Stop B"", ""LatLong"": { ""Latitude"": 37.7810, ""Longitude"": -122.4110 }, ""LocationType"": 0 }
  ]
}";
using var content = new StringContent(json, Encoding.UTF8, "application/json");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://trackservice.trackroad.com/rest/dispatch";

const payload = {
  RoutingService: 0,
  DistanceUnit: 0,
  RouteOptimize: 0,
  DispatchMode: 0,
  Vehicles: [
    {
      Name: "Truck 1",
      StartLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
      FinishLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 2 }
    }
  ],
  Locations: [
    { Name: "Stop A", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
    { Name: "Stop B", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 0 }
  ]
};

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_TRACKSERVICEKEY"
  },
  body: JSON.stringify(payload)
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    String json = "{"
      + "\"RoutingService\":0,"
      + "\"DistanceUnit\":0,"
      + "\"RouteOptimize\":0,"
      + "\"DispatchMode\":0,"
      + "\"Vehicles\":[{"
        + "\"Name\":\"Truck 1\","
        + "\"StartLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
        + "\"FinishLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":2}"
      + "}],"
      + "\"Locations\":[{"
        + "\"Name\":\"Stop A\","
        + "\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},"
        + "\"LocationType\":0"
      + "},{"
        + "\"Name\":\"Stop B\","
        + "\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},"
        + "\"LocationType\":0"
      + "}]"
      + "}";

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));

    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/dispatch")
      .post(body)
      .addHeader("Content-Type", "application/json")
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://trackservice.trackroad.com/rest/dispatch"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_TRACKSERVICEKEY"
}

payload = {
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "DispatchMode": 0,
  "Vehicles": [
    {
      "Name": "Truck 1",
      "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
    }
  ],
  "Locations": [
    { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
    { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
  ]
}

r = requests.post(url, headers=headers, json=payload)
print(r.text)

<?php
$url = "https://trackservice.trackroad.com/rest/dispatch";

$payload = json_encode([
  "RoutingService" => 0,
  "DistanceUnit" => 0,
  "RouteOptimize" => 0,
  "DispatchMode" => 0,
  "Vehicles" => [[
    "Name" => "Truck 1",
    "StartLocation" => [ "LatLong" => [ "Latitude" => 37.7946, "Longitude" => -122.3950 ], "LocationType" => 1 ],
    "FinishLocation" => [ "LatLong" => [ "Latitude" => 37.7946, "Longitude" => -122.3950 ], "LocationType" => 2 ]
  ]],
  "Locations" => [
    [ "Name" => "Stop A", "LatLong" => [ "Latitude" => 37.7897, "Longitude" => -122.4011 ], "LocationType" => 0 ],
    [ "Name" => "Stop B", "LatLong" => [ "Latitude" => 37.7810, "Longitude" => -122.4110 ], "LocationType" => 0 ]
  ]
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: YOUR_TRACKSERVICEKEY"
  ],
  CURLOPT_POSTFIELDS => $payload
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://trackservice.trackroad.com/rest/dispatch")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

payload = {
  RoutingService: 0,
  DistanceUnit: 0,
  RouteOptimize: 0,
  DispatchMode: 0,
  Vehicles: [
    {
      Name: "Truck 1",
      StartLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
      FinishLocation: { LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 2 }
    }
  ],
  Locations: [
    { Name: "Stop A", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
    { Name: "Stop B", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 0 }
  ]
}

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"
req.body = payload.to_json

res = http.request(req)
puts res.body

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://trackservice.trackroad.com/rest/dispatch"
  jsonBody := []byte(`{
    "RoutingService": 0,
    "DistanceUnit": 0,
    "RouteOptimize": 0,
    "DispatchMode": 0,
    "Vehicles": [
      {
        "Name": "Truck 1",
        "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
        "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
      }
    ],
    "Locations": [
      { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
      { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
    ]
  }`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonBody))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("X-API-Key", "YOUR_TRACKSERVICEKEY")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://trackservice.trackroad.com/rest/dispatch"
  val json = """
    {
      "RoutingService": 0,
      "DistanceUnit": 0,
      "RouteOptimize": 0,
      "DispatchMode": 0,
      "Vehicles": [
        {
          "Name": "Truck 1",
          "StartLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
          "FinishLocation": { "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 2 }
        }
      ],
      "Locations": [
        { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
        { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 0 }
      ]
    }
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "application/json")
    .header("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://trackservice.trackroad.com/rest/dispatch";
  const char *json =
    "{"
    "\"RoutingService\":0,"
    "\"DistanceUnit\":0,"
    "\"RouteOptimize\":0,"
    "\"DispatchMode\":0,"
    "\"Vehicles\":[{"
      "\"Name\":\"Truck 1\","
      "\"StartLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      "\"FinishLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":2}"
    "}],"
    "\"Locations\":[{"
      "\"Name\":\"Stop A\","
      "\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},"
      "\"LocationType\":0"
    "},{"
      "\"Name\":\"Stop B\","
      "\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},"
      "\"LocationType\":0"
    "}]"
    "}";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://trackservice.trackroad.com/rest/dispatch";
  std::string json =
    "{"
    "\"RoutingService\":0,"
    "\"DistanceUnit\":0,"
    "\"RouteOptimize\":0,"
    "\"DispatchMode\":0,"
    "\"Vehicles\":[{"
      "\"Name\":\"Truck 1\","
      "\"StartLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      "\"FinishLocation\":{\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":2}"
    "}],"
    "\"Locations\":[{"
      "\"Name\":\"Stop A\","
      "\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},"
      "\"LocationType\":0"
    "},{"
      "\"Name\":\"Stop B\","
      "\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},"
      "\"LocationType\":0"
    "}]"
    "}";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json.c_str());

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://trackservice.trackroad.com/rest/dispatch"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSDictionary *payload = @{
      @"RoutingService": @0,
      @"DistanceUnit": @0,
      @"RouteOptimize": @0,
      @"DispatchMode": @0,
      @"Vehicles": @[
        @{
          @"Name": @"Truck 1",
          @"StartLocation": @{@"LatLong": @{@"Latitude": @37.7946, @"Longitude": @-122.3950}, @"LocationType": @1},
          @"FinishLocation": @{@"LatLong": @{@"Latitude": @37.7946, @"Longitude": @-122.3950}, @"LocationType": @2}
        }
      ],
      @"Locations": @[
        @{@"Name": @"Stop A", @"LatLong": @{@"Latitude": @37.7897, @"Longitude": @-122.4011}, @"LocationType": @0},
        @{@"Name": @"Stop B", @"LatLong": @{@"Latitude": @37.7810, @"Longitude": @-122.4110}, @"LocationType": @0}
      ]
    };

    NSData *body = [NSJSONSerialization dataWithJSONObject:payload options:0 error:nil];
    [req setHTTPBody:body];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req
      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://trackservice.trackroad.com/rest/dispatch")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let payload: [String: Any] = [
  "RoutingService": 0,
  "DistanceUnit": 0,
  "RouteOptimize": 0,
  "DispatchMode": 0,
  "Vehicles": [
    [
      "Name": "Truck 1",
      "StartLocation": ["LatLong": ["Latitude": 37.7946, "Longitude": -122.3950], "LocationType": 1],
      "FinishLocation": ["LatLong": ["Latitude": 37.7946, "Longitude": -122.3950], "LocationType": 2]
    ]
  ],
  "Locations": [
    ["Name": "Stop A", "LatLong": ["Latitude": 37.7897, "Longitude": -122.4011], "LocationType": 0],
    ["Name": "Stop B", "LatLong": ["Latitude": 37.7810, "Longitude": -122.4110], "LocationType": 0]
  ]
]

req.httpBody = try! JSONSerialization.data(withJSONObject: payload)

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

SOAP request examples (multiple languages)#

SOAP uses the same DispatchSpecification model, but it’s wrapped in a SOAP envelope and authenticated via SessionIDHeader (SessionID = TrackServiceKey).

curl -X POST "https://trackservice.trackroad.com/TrackService.asmx" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H "SOAPAction: http://trackservice.trackroad.com/Dispatch" \
  -d @dispatch-soap.xml

/*
  Recommended: use a WSDL-generated client for SOAP.

  1) Add Service Reference to:
     https://trackservice.trackroad.com/TrackService.asmx?WSDL

  2) Set SessionIDHeader.SessionID = YOUR_TRACKSERVICEKEY
     then call Dispatch(spec).
*/

var client = new TrackService.TrackServiceSoapClient();
var header = new TrackService.SessionIDHeader { SessionID = "YOUR_TRACKSERVICEKEY" };

var spec = new TrackService.DispatchSpecification
{
    RoutingService = TrackService.RoutingService.NetRoad,
    DistanceUnit = TrackService.DistanceUnit.Mile,
    RouteOptimize = TrackService.RouteOptimize.MinimizeTime,
    DispatchMode = TrackService.DispatchMode.Auto,
    Vehicles = new TrackService.Vehicle[]
    {
        new TrackService.Vehicle
        {
            Name = "Truck 1",
            StartLocation = new TrackService.Location
            {
                LatLong = new TrackService.LatLong { Latitude = 37.7946, Longitude = -122.3950 },
                LocationType = TrackService.LocationType.Start
            },
            FinishLocation = new TrackService.Location
            {
                LatLong = new TrackService.LatLong { Latitude = 37.7946, Longitude = -122.3950 },
                LocationType = TrackService.LocationType.Finish
            }
        }
    },
    Locations = new TrackService.Location[]
    {
        new TrackService.Location
        {
            Name = "Stop A",
            LatLong = new TrackService.LatLong { Latitude = 37.7897, Longitude = -122.4011 },
            LocationType = TrackService.LocationType.Midway
        },
        new TrackService.Location
        {
            Name = "Stop B",
            LatLong = new TrackService.LatLong { Latitude = 37.7810, Longitude = -122.4110 },
            LocationType = TrackService.LocationType.Midway
        }
    }
};

var result = client.Dispatch(header, spec);

// SOAP in browser JS is uncommon; use Node.js + fetch (undici) or axios.
// This example uses fetch in Node 18+.

const endpoint = "https://trackservice.trackroad.com/TrackService.asmx";

const xml = `<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles>
          <Vehicle>
            <Name>Truck 1</Name>
            <StartLocation>
              <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              <LocationType>1</LocationType>
            </StartLocation>
            <FinishLocation>
              <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
              <LocationType>2</LocationType>
            </FinishLocation>
          </Vehicle>
        </Vehicles>
        <Locations>
          <Location>
            <Name>Stop A</Name>
            <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
            <LocationType>0</LocationType>
          </Location>
          <Location>
            <Name>Stop B</Name>
            <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
            <LocationType>0</LocationType>
          </Location>
        </Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>`;

const res = await fetch(endpoint, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "http://trackservice.trackroad.com/Dispatch"
  },
  body: xml
});

console.log(await res.text());

// Option A (recommended): use a SOAP client generated from WSDL (JAX-WS).
// Option B: post raw XML (shown here) using OkHttp.

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    String xml =
      "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    + " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
    + " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    + "  <soap:Header>"
    + "    <SessionIDHeader xmlns=\"http://trackservice.trackroad.com/\">"
    + "      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>"
    + "    </SessionIDHeader>"
    + "  </soap:Header>"
    + "  <soap:Body>"
    + "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
    + "      <specification>"
    + "        <RoutingService>0</RoutingService>"
    + "        <DistanceUnit>0</DistanceUnit>"
    + "        <RouteOptimize>0</RouteOptimize>"
    + "        <DispatchMode>0</DispatchMode>"
    + "        <Vehicles />"
    + "        <Locations />"
    + "      </specification>"
    + "    </Dispatch>"
    + "  </soap:Body>"
    + "</soap:Envelope>";

    RequestBody body = RequestBody.create(xml, MediaType.parse("text/xml; charset=utf-8"));

    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/TrackService.asmx")
      .post(body)
      .addHeader("Content-Type", "text/xml; charset=utf-8")
      .addHeader("SOAPAction", "http://trackservice.trackroad.com/Dispatch")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

endpoint = "https://trackservice.trackroad.com/TrackService.asmx"

xml = """<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>
"""

headers = {
  "Content-Type": "text/xml; charset=utf-8",
  "SOAPAction": "http://trackservice.trackroad.com/Dispatch"
}

r = requests.post(endpoint, headers=headers, data=xml.encode("utf-8"))
print(r.text)

<?php
$endpoint = "https://trackservice.trackroad.com/TrackService.asmx";

$xml = <<<XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>
XML;

$ch = curl_init($endpoint);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: text/xml; charset=utf-8",
    "SOAPAction: http://trackservice.trackroad.com/Dispatch"
  ],
  CURLOPT_POSTFIELDS => $xml
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"

endpoint = URI("https://trackservice.trackroad.com/TrackService.asmx")

xml = <<~XML
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
      <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
        <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
      </SessionIDHeader>
    </soap:Header>
    <soap:Body>
      <Dispatch xmlns="http://trackservice.trackroad.com/">
        <specification>
          <RoutingService>0</RoutingService>
          <DistanceUnit>0</DistanceUnit>
          <RouteOptimize>0</RouteOptimize>
          <DispatchMode>0</DispatchMode>
          <Vehicles />
          <Locations />
        </specification>
      </Dispatch>
    </soap:Body>
  </soap:Envelope>
XML

http = Net::HTTP.new(endpoint.host, endpoint.port)
http.use_ssl = true

req = Net::HTTP::Post.new(endpoint)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "http://trackservice.trackroad.com/Dispatch"
req.body = xml

res = http.request(req)
puts res.body

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  endpoint := "https://trackservice.trackroad.com/TrackService.asmx"

  xml := []byte(`<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>`)

  req, _ := http.NewRequest("POST", endpoint, bytes.NewBuffer(xml))
  req.Header.Set("Content-Type", "text/xml; charset=utf-8")
  req.Header.Set("SOAPAction", "http://trackservice.trackroad.com/Dispatch")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val endpoint = "https://trackservice.trackroad.com/TrackService.asmx"
  val xml = """
    <?xml version="1.0" encoding="utf-8"?>
    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <soap:Header>
        <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
          <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
        </SessionIDHeader>
      </soap:Header>
      <soap:Body>
        <Dispatch xmlns="http://trackservice.trackroad.com/">
          <specification>
            <RoutingService>0</RoutingService>
            <DistanceUnit>0</DistanceUnit>
            <RouteOptimize>0</RouteOptimize>
            <DispatchMode>0</DispatchMode>
            <Vehicles />
            <Locations />
          </specification>
        </Dispatch>
      </soap:Body>
    </soap:Envelope>
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(endpoint))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "http://trackservice.trackroad.com/Dispatch")
    .POST(HttpRequest.BodyPublishers.ofString(xml))
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *endpoint = "https://trackservice.trackroad.com/TrackService.asmx";
  const char *xml =
    "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
    " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    "  <soap:Header>"
    "    <SessionIDHeader xmlns=\"http://trackservice.trackroad.com/\">"
    "      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>"
    "    </SessionIDHeader>"
    "  </soap:Header>"
    "  <soap:Body>"
    "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
    "      <specification>"
    "        <RoutingService>0</RoutingService>"
    "        <DistanceUnit>0</DistanceUnit>"
    "        <RouteOptimize>0</RouteOptimize>"
    "        <DispatchMode>0</DispatchMode>"
    "        <Vehicles />"
    "        <Locations />"
    "      </specification>"
    "    </Dispatch>"
    "  </soap:Body>"
    "</soap:Envelope>";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://trackservice.trackroad.com/Dispatch");

  curl_easy_setopt(curl, CURLOPT_URL, endpoint);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, xml);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string endpoint = "https://trackservice.trackroad.com/TrackService.asmx";
  std::string xml =
    "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
    " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    "  <soap:Header>"
    "    <SessionIDHeader xmlns=\"http://trackservice.trackroad.com/\">"
    "      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>"
    "    </SessionIDHeader>"
    "  </soap:Header>"
    "  <soap:Body>"
    "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
    "      <specification>"
    "        <RoutingService>0</RoutingService>"
    "        <DistanceUnit>0</DistanceUnit>"
    "        <RouteOptimize>0</RouteOptimize>"
    "        <DispatchMode>0</DispatchMode>"
    "        <Vehicles />"
    "        <Locations />"
    "      </specification>"
    "    </Dispatch>"
    "  </soap:Body>"
    "</soap:Envelope>";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://trackservice.trackroad.com/Dispatch");

  curl_easy_setopt(curl, CURLOPT_URL, endpoint.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, xml.c_str());

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);

  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://trackservice.trackroad.com/TrackService.asmx"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"text/xml; charset=utf-8" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"http://trackservice.trackroad.com/Dispatch" forHTTPHeaderField:@"SOAPAction"];

    NSString *xml =
    @"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
     "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
     " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
     " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
     "  <soap:Header>"
     "    <SessionIDHeader xmlns=\"http://trackservice.trackroad.com/\">"
     "      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>"
     "    </SessionIDHeader>"
     "  </soap:Header>"
     "  <soap:Body>"
     "    <Dispatch xmlns=\"http://trackservice.trackroad.com/\">"
     "      <specification>"
     "        <RoutingService>0</RoutingService>"
     "        <DistanceUnit>0</DistanceUnit>"
     "        <RouteOptimize>0</RouteOptimize>"
     "        <DispatchMode>0</DispatchMode>"
     "        <Vehicles />"
     "        <Locations />"
     "      </specification>"
     "    </Dispatch>"
     "  </soap:Body>"
     "</soap:Envelope>";

    NSData *body = [xml dataUsingEncoding:NSUTF8StringEncoding];
    [req setHTTPBody:body];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req
      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://trackservice.trackroad.com/TrackService.asmx")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("text/xml; charset=utf-8", forHTTPHeaderField: "Content-Type")
req.setValue("http://trackservice.trackroad.com/Dispatch", forHTTPHeaderField: "SOAPAction")

let xml = """
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles />
        <Locations />
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>
"""

req.httpBody = xml.data(using: .utf8)

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

SOAP: Raw request (Envelope + SessionIDHeader)#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://trackservice.trackroad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://trackservice.trackroad.com/">
      <specification>
        <RoutingService>0</RoutingService>
        <DistanceUnit>0</DistanceUnit>
        <RouteOptimize>0</RouteOptimize>
        <DispatchMode>0</DispatchMode>
        <Vehicles></Vehicles>
        <Locations></Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

JSON: Response example#

{
  "Items": [
    {
      "Vehicle": { "Name": "Truck 1" },
      "Locations": [
        { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 } },
        { "Name": "Stop B", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 } }
      ]
    }
  ],
  "Errors": [],
  "Status": 1
}

SOAP: Response example#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DispatchResponse xmlns="http://trackservice.trackroad.com/">
      <DispatchResult>
        <Status>1</Status>
        <Errors />

        <Items>
          <VehicleItem>
            <Vehicle>
              <Name>Truck 1</Name>
            </Vehicle>

            <Locations>
              <Location>
                <Name>Stop A</Name>
                <LocationType>0</LocationType>
                <LatLong>
                  <Latitude>37.7897</Latitude>
                  <Longitude>-122.4011</Longitude>
                </LatLong>
              </Location>

              <Location>
                <Name>Stop B</Name>
                <LocationType>0</LocationType>
                <LatLong>
                  <Latitude>37.7810</Latitude>
                  <Longitude>-122.4110</Longitude>
                </LatLong>
              </Location>
            </Locations>
          </VehicleItem>
        </Items>

      </DispatchResult>
    </DispatchResponse>
  </soap:Body>
</soap:Envelope>

Erros comuns#

REST 401 / Unauthorized: X-API-Key em falta ou inválido.
REST 403 / Forbidden: A chave é válida, mas está bloqueada, expirou ou não tem crédito.
Erros de validação: Uma paragem não tem LatLong nem Address, ou as coordenadas são inválidas.
Erros de autenticação SOAP: SessionIDHeader em falta ou inválido, ou SessionID vazio.

Boas práticas

Prefira LatLong para evitar ambiguidades de geocodificação e melhorar a consistência do roteamento.
Utilize StartLocation e FinishLocation para roteamento baseado em depósito e ETAs mais precisos.
Adicione restrições de capacidade, como peso, volume e skids, para uma atribuição de rotas mais realista.
Utilize janelas temporais quando as paragens tiverem de ser visitadas dentro de horários de clientes ou operacionais.
Para SOAP, utilize a TrackServiceKey em SessionIDHeader. O antigo fluxo de login não é necessário.

FAQ#

O que faz a API Dispatch?

O Dispatch otimiza paragens em vários veículos e devolve rotas ordenadas por veículo com saída de horários e distâncias.

Como faço a autenticação no Dispatch REST e SOAP?

O REST utiliza a sua TrackServiceKey no cabeçalho X-API-Key. O SOAP utiliza a mesma TrackServiceKey em SessionIDHeader como SessionID.

Preciso de LatLong ou Address para as paragens?

LatLong é preferível. Se LatLong não for fornecido, Address é obrigatório para que a TrackRoad possa geocodificar a paragem.

Pronto para otimizar rotas?

Gere a sua chave API e comece a integrar o Dispatch para otimização de rotas multi-veículo usando REST ou SOAP.

Obter chave API WSDL SOAP Swagger UI