Routes API (Batch Route Calculation)

Q: How do I authenticate to Routes (REST and SOAP)?

REST requests send TrackServiceKey in the X-API-Key header. SOAP CalculateRoutes requests send TrackServiceKey in SessionIDHeader as SessionID.

Q: When should I use Routes vs Route?

Use Route when you need to calculate a single route. Use Routes when you want to calculate multiple routes in one batch request.

Q: What are the most common Routes API errors?

Common errors include missing or invalid X-API-Key, SOAP SessionIDHeader authentication failures, missing Locations, invalid coordinates, and invalid enum values.

Use Routes to calculate multiple routes in one request. REST returns JSON, while SOAP uses CalculateRoutes for batch route calculation workflows and legacy integrations.

Routes calculates multiple routes in one call, making it useful for bulk route planning, route comparison, and batch routing workflows.

Need the full API contract?

Swagger covers the REST models, while the SOAP WSDL supports legacy TrackService integrations.

View Swagger UI View SOAP WSDL API Reference Overview

What Routes does
Endpoints and base URLs
Authentication (REST & SOAP)
Request schema
Response schema
Examples
Common errors
Best practices
Related endpoints
FAQ

What Routes does#

Routes calculates one or many routes in a single request. This makes it useful when you need batch route calculation instead of sending many single-route calls.

Each route uses an ordered list of Location inputs and optional RouteOptions. You can also define a global RoutesOptions object that applies defaults across the full request.

Tip: If you only need one route, use Route API . If you need to calculate multiple routes at once, use Routes.

Endpoints and base URLs#

REST (JSON)

Item	Value
Base URL	https://trackservice.trackroad.com
Endpoint	`POST /rest/routes`
Full URL	https://trackservice.trackroad.com/rest/routes
Content-Type	`application/json`

SOAP (CalculateRoutes)

Item	Value
SOAP URL	https://trackservice.trackroad.com/TrackService.asmx
WSDL	https://trackservice.trackroad.com/TrackService.asmx?WSDL
Method	`CalculateRoutes`
SOAPAction	http://TrackService.TrackRoad.com/CalculateRoutes
Content-Type	`text/xml; charset=utf-8`

SOAP and REST share the same core routing concepts, such as RouteSpecification, RouteOptions, and Location. The main difference is transport: JSON for REST and SOAP envelope + SessionIDHeader for SOAP.

Authentication (REST & SOAP)#

REST authentication (X-API-Key)

Include your TrackServiceKey in the X-API-Key header on every REST request. See API Authentication .

SOAP authentication (SessionIDHeader)

SOAP requests use SessionIDHeader. Send your TrackServiceKey as SessionID for each CalculateRoutes call.

Recommended: use REST unless you need to integrate with an existing SOAP-only or legacy enterprise system.

Request schema#

The REST request body is a single batch object: RoutesSpecification, which contains a list of RouteSpecification items. SOAP uses the same logical structure inside the CalculateRoutes operation.

Shared models

Location, LatLong, and Address are shared across endpoints. See Dispatch API (shared models) .

RoutesSpecification (REST)

Property	Type	Required	Description
`Specifications`	RouteSpecification[]	Yes*	One item per route you want to calculate in the batch request.
`RoutesOptions`	RouteOptions	No	Global defaults applied to every route unless overridden by per-route RouteOptions.

RouteSpecification

Property	Type	Required	Description
`Locations`	Location[]	Yes*	Stops for this route. Order may be optimized based on RouteOptions.
`RouteOptions`	RouteOptions	No	Per-route overrides for routing engine, units, optimization mode, culture, and map options.

RouteOptions (summary)

RouteOptions fields such as RoutingService, DistanceUnit, RouteOptimize, Culture, and map-related settings are similar to the Route endpoint and can be applied globally or per route.

Response schema#

REST response (RoutesResult)

Property	Type	Description
`Results`	RouteResult[]	One result per input RouteSpecification.
`Map`	string	Optional map output depending on options. It may be empty.
`Errors`	Error[]	Optional warnings and errors returned by the service.
`Status`	int (enum)	0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

SOAP response (CalculateRoutesResult)

SOAP wraps the same logical result structure inside CalculateRoutesResponse and CalculateRoutesResult.

Examples#

Use the examples below to understand how TrackRoad Routes works with both REST JSON and SOAP CalculateRoutes. The example code blocks should remain unchanged across languages.

REST request body (JSON)#

{
  "Locations": [
    { "Name": "Start", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
    { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
    { "Name": "Finish", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
  ],
  "RouteOptions": {
    "RoutingService": 2,
    "DistanceUnit": 0,
    "RouteOptimize": 0,
    "Culture": "en-US",
    "ZoomLevel": 0
  }
}

REST call examples#

curl -X POST "https://trackservice.trackroad.com/rest/Route" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d @route-request.json

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

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

var json = @"{
  ""Locations"": [
    { ""Name"": ""Start"", ""LatLong"": { ""Latitude"": 37.7946, ""Longitude"": -122.3950 }, ""LocationType"": 1 },
    { ""Name"": ""Stop A"", ""LatLong"": { ""Latitude"": 37.7897, ""Longitude"": -122.4011 }, ""LocationType"": 0 },
    { ""Name"": ""Finish"", ""LatLong"": { ""Latitude"": 37.7810, ""Longitude"": -122.4110 }, ""LocationType"": 2 }
  ],
  ""RouteOptions"": { ""RoutingService"": 2, ""DistanceUnit"": 0, ""RouteOptimize"": 0, ""Culture"": ""en-US"", ""ZoomLevel"": 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/Route";

const payload = {
  Locations: [
    { Name: "Start", LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
    { Name: "Stop A", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
    { Name: "Finish", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 2 }
  ],
  RouteOptions: { RoutingService: 2, DistanceUnit: 0, RouteOptimize: 0, Culture: "en-US", ZoomLevel: 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 = "{"
      + "\"Locations\":["
      + "{\"Name\":\"Start\",\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      + "{\"Name\":\"Stop A\",\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},\"LocationType\":0},"
      + "{\"Name\":\"Finish\",\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},\"LocationType\":2}"
      + "],"
      + "\"RouteOptions\":{\"RoutingService\":2,\"DistanceUnit\":0,\"RouteOptimize\":0,\"Culture\":\"en-US\",\"ZoomLevel\":0}"
      + "}";

    RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));
    Request request = new Request.Builder()
      .url("https://trackservice.trackroad.com/rest/Route")
      .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/Route"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_TRACKSERVICEKEY"
}

payload = {
  "Locations": [
    { "Name": "Start", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
    { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
    { "Name": "Finish", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
  ],
  "RouteOptions": { "RoutingService": 2, "DistanceUnit": 0, "RouteOptimize": 0, "Culture": "en-US", "ZoomLevel": 0 }
}

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

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

$payload = json_encode([
  "Locations" => [
    [ "Name" => "Start", "LatLong" => [ "Latitude" => 37.7946, "Longitude" => -122.3950 ], "LocationType" => 1 ],
    [ "Name" => "Stop A", "LatLong" => [ "Latitude" => 37.7897, "Longitude" => -122.4011 ], "LocationType" => 0 ],
    [ "Name" => "Finish", "LatLong" => [ "Latitude" => 37.7810, "Longitude" => -122.4110 ], "LocationType" => 2 ]
  ],
  "RouteOptions" => [ "RoutingService" => 2, "DistanceUnit" => 0, "RouteOptimize" => 0, "Culture" => "en-US", "ZoomLevel" => 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"
require "uri"

uri = URI("https://trackservice.trackroad.com/rest/Route")

payload = {
  Locations: [
    { Name: "Start", LatLong: { Latitude: 37.7946, Longitude: -122.3950 }, LocationType: 1 },
    { Name: "Stop A", LatLong: { Latitude: 37.7897, Longitude: -122.4011 }, LocationType: 0 },
    { Name: "Finish", LatLong: { Latitude: 37.7810, Longitude: -122.4110 }, LocationType: 2 }
  ],
  RouteOptions: { RoutingService: 2, DistanceUnit: 0, RouteOptimize: 0, Culture: "en-US", ZoomLevel: 0 }
}

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

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

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

package main

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

func main() {
  url := "https://trackservice.trackroad.com/rest/Route"

  body := []byte(`{
    "Locations": [
      { "Name": "Start", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
      { "Name": "Finish", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
    ],
    "RouteOptions": { "RoutingService": 2, "DistanceUnit": 0, "RouteOptimize": 0, "Culture": "en-US", "ZoomLevel": 0 }
  }`)

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

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

  var buf bytes.Buffer
  buf.ReadFrom(resp.Body)
  fmt.Println(buf.String())
}

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody

fun main() {
  val client = OkHttpClient()
  val url = "https://trackservice.trackroad.com/rest/Route"

  val json = """
  {
    "Locations": [
      { "Name": "Start", "LatLong": { "Latitude": 37.7946, "Longitude": -122.3950 }, "LocationType": 1 },
      { "Name": "Stop A", "LatLong": { "Latitude": 37.7897, "Longitude": -122.4011 }, "LocationType": 0 },
      { "Name": "Finish", "LatLong": { "Latitude": 37.7810, "Longitude": -122.4110 }, "LocationType": 2 }
    ],
    "RouteOptions": { "RoutingService": 2, "DistanceUnit": 0, "RouteOptimize": 0, "Culture": "en-US", "ZoomLevel": 0 }
  }
  """.trimIndent()

  val body = json.toRequestBody("application/json".toMediaType())
  val request = Request.Builder()
    .url(url)
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .build()

  client.newCall(request).execute().use { resp ->
    println(resp.body?.string())
  }
}

#include <stdio.h>
#include <string.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/Route";
  const char *json =
    "{"
    "\"Locations\":["
      "{\"Name\":\"Start\",\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      "{\"Name\":\"Stop A\",\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},\"LocationType\":0},"
      "{\"Name\":\"Finish\",\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},\"LocationType\":2}"
    "],"
    "\"RouteOptions\":{\"RoutingService\":2,\"DistanceUnit\":0,\"RouteOptimize\":0,\"Culture\":\"en-US\",\"ZoomLevel\":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>

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

  const char* url = "https://trackservice.trackroad.com/rest/Route";
  const char* json =
    "{"
    "\"Locations\":["
      "{\"Name\":\"Start\",\"LatLong\":{\"Latitude\":37.7946,\"Longitude\":-122.3950},\"LocationType\":1},"
      "{\"Name\":\"Stop A\",\"LatLong\":{\"Latitude\":37.7897,\"Longitude\":-122.4011},\"LocationType\":0},"
      "{\"Name\":\"Finish\",\"LatLong\":{\"Latitude\":37.7810,\"Longitude\":-122.4110},\"LocationType\":2}"
    "],"
    "\"RouteOptions\":{\"RoutingService\":2,\"DistanceUnit\":0,\"RouteOptimize\":0,\"Culture\":\"en-US\",\"ZoomLevel\":0}"
    "}";

  struct curl_slist* headers = nullptr;
  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;
}

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://trackservice.trackroad.com/rest/Route"];

    NSDictionary *payload = @{
      @"Locations": @[
        @{@"Name":@"Start", @"LatLong":@{@"Latitude":@37.7946, @"Longitude":@-122.3950}, @"LocationType":@1},
        @{@"Name":@"Stop A", @"LatLong":@{@"Latitude":@37.7897, @"Longitude":@-122.4011}, @"LocationType":@0},
        @{@"Name":@"Finish", @"LatLong":@{@"Latitude":@37.7810, @"Longitude":@-122.4110}, @"LocationType":@2}
      ],
      @"RouteOptions": @{@"RoutingService":@2, @"DistanceUnit":@0, @"RouteOptimize":@0, @"Culture":@"en-US", @"ZoomLevel":@0}
    };

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

    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    req.HTTPMethod = @"POST";
    [req setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];
    req.HTTPBody = body;

    dispatch_semaphore_t sema = dispatch_semaphore_create(0);

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

    [task resume];
    dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
  }
  return 0;
}

import Foundation

let url = URL(string: "https://trackservice.trackroad.com/rest/Route")!

let payload: [String: Any] = [
  "Locations": [
    ["Name": "Start", "LatLong": ["Latitude": 37.7946, "Longitude": -122.3950], "LocationType": 1],
    ["Name": "Stop A", "LatLong": ["Latitude": 37.7897, "Longitude": -122.4011], "LocationType": 0],
    ["Name": "Finish", "LatLong": ["Latitude": 37.7810, "Longitude": -122.4110], "LocationType": 2]
  ],
  "RouteOptions": ["RoutingService": 2, "DistanceUnit": 0, "RouteOptimize": 0, "Culture": "en-US", "ZoomLevel": 0]
]

let body = try JSONSerialization.data(withJSONObject: payload, options: [])

var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("application/json", forHTTPHeaderField: "Content-Type")
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")
req.httpBody = body

let sema = DispatchSemaphore(value: 0)

URLSession.shared.dataTask(with: req) { data, response, error in
  if let error = error { print(error) }
  else if let data = data { print(String(data: data, encoding: .utf8) ?? "") }
  sema.signal()
}.resume()

sema.wait()

SOAP request (CalculateRoute)#

SOAP requires SessionIDHeader. Replace YOUR_SESSION_ID with the session id returned from SOAP Login.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_SESSION_ID</SessionID>
    </SessionIDHeader>
  </soap:Header>

  <soap:Body>
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Locations>
          <Location>
            <Name>Start</Name>
            <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
            <LocationType>Start</LocationType>
          </Location>

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

          <Location>
            <Name>Finish</Name>
            <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
            <LocationType>Finish</LocationType>
          </Location>
        </Locations>

        <RouteOptions>
          <RoutingService>Bing</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
          <Culture>en-US</Culture>
          <ZoomLevel>0</ZoomLevel>
        </RouteOptions>
      </specification>
    </CalculateRoute>
  </soap:Body>
</soap:Envelope>

SOAP call examples#

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

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

var url = "https://trackservice.trackroad.com/TrackService.asmx";
var soapAction = "http://TrackService.TrackRoad.com/CalculateRoute";

var xml = @"<?xml version=""1.0"" encoding=""utf-8""?>
<soap:Envelope xmlns:soap=""http://schemas.xmlsoap.org/soap/envelope/"">
  <soap:Header>
    <SessionIDHeader xmlns=""http://TrackService.TrackRoad.com/"">
      <SessionID>YOUR_SESSION_ID</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CalculateRoute xmlns=""http://TrackService.TrackRoad.com/"">
      <specification>
        <Locations>
          <Location>
            <Name>Start</Name>
            <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
            <LocationType>Start</LocationType>
          </Location>
          <Location>
            <Name>Stop A</Name>
            <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
            <LocationType>Midway</LocationType>
          </Location>
          <Location>
            <Name>Finish</Name>
            <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
            <LocationType>Finish</LocationType>
          </Location>
        </Locations>
        <RouteOptions>
          <RoutingService>Bing</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
          <Culture>en-US</Culture>
          <ZoomLevel>0</ZoomLevel>
        </RouteOptions>
      </specification>
    </CalculateRoute>
  </soap:Body>
</soap:Envelope>";

using var http = new HttpClient();
using var content = new StringContent(xml, Encoding.UTF8, "text/xml");

content.Headers.Clear();
content.Headers.TryAddWithoutValidation("Content-Type", "text/xml; charset=utf-8");

var req = new HttpRequestMessage(HttpMethod.Post, url);
req.Content = content;
req.Headers.TryAddWithoutValidation("SOAPAction", soapAction);

var resp = await http.SendAsync(req);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

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

const xml = `<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_SESSION_ID</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Locations>
          <Location>
            <Name>Start</Name>
            <LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong>
            <LocationType>Start</LocationType>
          </Location>
          <Location>
            <Name>Stop A</Name>
            <LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong>
            <LocationType>Midway</LocationType>
          </Location>
          <Location>
            <Name>Finish</Name>
            <LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong>
            <LocationType>Finish</LocationType>
          </Location>
        </Locations>
        <RouteOptions>
          <RoutingService>Bing</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
          <Culture>en-US</Culture>
          <ZoomLevel>0</ZoomLevel>
        </RouteOptions>
      </specification>
    </CalculateRoute>
  </soap:Body>
</soap:Envelope>`;

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "http://TrackService.TrackRoad.com/CalculateRoute"
  },
  body: xml
});

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

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:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
      + "  <soap:Header>"
      + "    <SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
      + "      <SessionID>YOUR_SESSION_ID</SessionID>"
      + "    </SessionIDHeader>"
      + "  </soap:Header>"
      + "  <soap:Body>"
      + "    <CalculateRoute xmlns=\"http://TrackService.TrackRoad.com/\">"
      + "      <specification>"
      + "        <Locations>"
      + "          <Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>"
      + "          <Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>"
      + "          <Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>"
      + "        </Locations>"
      + "        <RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>"
      + "      </specification>"
      + "    </CalculateRoute>"
      + "  </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/CalculateRoute")
      .build();

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

import requests

url = "https://trackservice.trackroad.com/TrackService.asmx"
headers = {
  "Content-Type": "text/xml; charset=utf-8",
  "SOAPAction": "http://TrackService.TrackRoad.com/CalculateRoute"
}

xml = """<?xml version="1.0" encoding="utf-8"?<
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"<
  <soap:Header<
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/"<
      <SessionID<YOUR_SESSION_ID</SessionID<
    </SessionIDHeader<
  </soap:Header<
  <soap:Body<
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/"<
      <specification<
        <Locations<
          <Location<
            <Name<Start</Name<
            <LatLong<<Latitude<37.7946</Latitude<<Longitude<-122.3950</Longitude<</LatLong<
            <LocationType<Start</LocationType<
          </Location<
          <Location<
            <Name<Stop A</Name<
            <LatLong<<Latitude<37.7897</Latitude<<Longitude<-122.4011</Longitude<</LatLong<
            <LocationType<Midway</LocationType<
          </Location<
          <Location<
            <Name<Finish</Name<
            <LatLong<<Latitude<37.7810</Latitude<<Longitude<-122.4110</Longitude<</LatLong<
            <LocationType<Finish</LocationType<
          </Location<
        </Locations<
        <RouteOptions<
          <RoutingService<Bing</RoutingService<
          <DistanceUnit<Mile</DistanceUnit<
          <RouteOptimize<MinimizeTime</RouteOptimize<
          <Culture<en-US</Culture<
          <ZoomLevel<0</ZoomLevel<
        </RouteOptions<
      </specification<
    </CalculateRoute<
  </soap:Body<
</soap:Envelope<"""

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

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

$xml = '<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_SESSION_ID</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Locations>
          <Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>
          <Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>
          <Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>
        </Locations>
        <RouteOptions>
          <RoutingService>Bing</RoutingService>
          <DistanceUnit>Mile</DistanceUnit>
          <RouteOptimize>MinimizeTime</RouteOptimize>
          <Culture>en-US</Culture>
          <ZoomLevel>0</ZoomLevel>
        </RouteOptions>
      </specification>
    </CalculateRoute>
  </soap:Body>
</soap:Envelope>';

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

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

require "net/http"
require "uri"

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

xml = <<~XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_SESSION_ID</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Locations>
          <Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>
          <Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>
          <Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>
        </Locations>
        <RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>
      </specification>
    </CalculateRoute>
  </soap:Body>
</soap:Envelope>
XML

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

req = Net::HTTP::Post.new(uri.request_uri)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "http://TrackService.TrackRoad.com/CalculateRoute"
req.body = xml

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

package main

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

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

  xml := []byte(`<?xml version="1.0" encoding="utf-8"?<
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"<
  <soap:Header<
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/"<
      <SessionID<YOUR_SESSION_ID</SessionID<
    </SessionIDHeader<
  </soap:Header<
  <soap:Body<
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/"<
      <specification<
        <Locations<
          <Location<<Name<Start</Name<<LatLong<<Latitude<37.7946</Latitude<<Longitude<-122.3950</Longitude<</LatLong<<LocationType<Start</LocationType<</Location<
          <Location<<Name<Stop A</Name<<LatLong<<Latitude<37.7897</Latitude<<Longitude<-122.4011</Longitude<</LatLong<<LocationType<Midway</LocationType<</Location<
          <Location<<Name<Finish</Name<<LatLong<<Latitude<37.7810</Latitude<<Longitude<-122.4110</Longitude<</LatLong<<LocationType<Finish</LocationType<</Location<
        </Locations<
        <RouteOptions<<RoutingService<Bing</RoutingService<<DistanceUnit<Mile</DistanceUnit<<RouteOptimize<MinimizeTime</RouteOptimize<<Culture<en-US</Culture<<ZoomLevel<0</ZoomLevel<</RouteOptions<
      </specification<
    </CalculateRoute<
  </soap:Body<
</soap:Envelope<`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(xml))
  req.Header.Set("Content-Type", "text/xml; charset=utf-8")
  req.Header.Set("SOAPAction", "http://TrackService.TrackRoad.com/CalculateRoute")

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

  var buf bytes.Buffer
  buf.ReadFrom(resp.Body)
  fmt.Println(buf.String())
}

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody

fun main() {
  val client = OkHttpClient()
  val url = "https://trackservice.trackroad.com/TrackService.asmx"

  val xml = """
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
      <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
        <SessionID>YOUR_SESSION_ID</SessionID>
      </SessionIDHeader>
    </soap:Header>
    <soap:Body>
      <CalculateRoute xmlns="http://TrackService.TrackRoad.com/">
        <specification>
          <Locations>
            <Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>
            <Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>
            <Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>
          </Locations>
          <RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>
        </specification>
      </CalculateRoute>
    </soap:Body>
  </soap:Envelope>
  """.trimIndent()

  val body = xml.toRequestBody("text/xml; charset=utf-8".toMediaType())
  val request = Request.Builder()
    .url(url)
    .post(body)
    .addHeader("Content-Type", "text/xml; charset=utf-8")
    .addHeader("SOAPAction", "http://TrackService.TrackRoad.com/CalculateRoute")
    .build()

  client.newCall(request).execute().use { resp ->
    println(resp.body?.string())
  }
}

#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/TrackService.asmx";
  const char *xml =
    "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    "<soap:Header>"
      "<SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
        "<SessionID>YOUR_SESSION_ID</SessionID>"
      "</SessionIDHeader>"
    "</soap:Header>"
    "<soap:Body>"
      "<CalculateRoute xmlns=\"http://TrackService.TrackRoad.com/\">"
        "<specification>"
          "<Locations>"
            "<Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>"
            "<Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>"
            "<Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>"
          "</Locations>"
          "<RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>"
        "</specification>"
      "</CalculateRoute>"
    "</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/CalculateRoute");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  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>

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

  const char* url = "https://trackservice.trackroad.com/TrackService.asmx";
  const char* xml =
    "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    "<soap:Header>"
      "<SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
        "<SessionID>YOUR_SESSION_ID</SessionID>"
      "</SessionIDHeader>"
    "</soap:Header>"
    "<soap:Body>"
      "<CalculateRoute xmlns=\"http://TrackService.TrackRoad.com/\">"
        "<specification>"
          "<Locations>"
            "<Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>"
            "<Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>"
            "<Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>"
          "</Locations>"
          "<RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>"
        "</specification>"
      "</CalculateRoute>"
    "</soap:Body>"
    "</soap:Envelope>";

  struct curl_slist* headers = nullptr;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://TrackService.TrackRoad.com/CalculateRoute");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  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;
}

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://trackservice.trackroad.com/TrackService.asmx"];

    NSString *xml =
    @"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    @"<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    @"  <soap:Header>"
    @"    <SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    @"      <SessionID>YOUR_SESSION_ID</SessionID>"
    @"    </SessionIDHeader>"
    @"  </soap:Header>"
    @"  <soap:Body>"
    @"    <CalculateRoute xmlns=\"http://TrackService.TrackRoad.com/\">"
    @"      <specification>"
    @"        <Locations>"
    @"          <Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>"
    @"          <Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>"
    @"          <Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>"
    @"        </Locations>"
    @"        <RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>"
    @"      </specification>"
    @"    </CalculateRoute>"
    @"  </soap:Body>"
    @"</soap:Envelope>";

    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    req.HTTPMethod = @"POST";
    [req setValue:@"text/xml; charset=utf-8" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"http://TrackService.TrackRoad.com/CalculateRoute" forHTTPHeaderField:@"SOAPAction"];
    req.HTTPBody = [xml dataUsingEncoding:NSUTF8StringEncoding];

    dispatch_semaphore_t sema = dispatch_semaphore_create(0);

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

    [task resume];
    dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
  }
  return 0;
}

import Foundation

let url = URL(string: "https://trackservice.trackroad.com/TrackService.asmx")!

let xml = """
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_SESSION_ID</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CalculateRoute xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <Locations>
          <Location><Name>Start</Name><LatLong><Latitude>37.7946</Latitude><Longitude>-122.3950</Longitude></LatLong><LocationType>Start</LocationType></Location>
          <Location><Name>Stop A</Name><LatLong><Latitude>37.7897</Latitude><Longitude>-122.4011</Longitude></LatLong><LocationType>Midway</LocationType></Location>
          <Location><Name>Finish</Name><LatLong><Latitude>37.7810</Latitude><Longitude>-122.4110</Longitude></LatLong><LocationType>Finish</LocationType></Location>
        </Locations>
        <RouteOptions><RoutingService>Bing</RoutingService><DistanceUnit>Mile</DistanceUnit><RouteOptimize>MinimizeTime</RouteOptimize><Culture>en-US</Culture><ZoomLevel>0</ZoomLevel></RouteOptions>
      </specification>
    </CalculateRoute>
  </soap:Body>
</soap:Envelope>
"""

var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("text/xml; charset=utf-8", forHTTPHeaderField: "Content-Type")
req.setValue("http://TrackService.TrackRoad.com/CalculateRoute", forHTTPHeaderField: "SOAPAction")
req.httpBody = xml.data(using: .utf8)

let sema = DispatchSemaphore(value: 0)
URLSession.shared.dataTask(with: req) { data, response, error in
  if let error = error { print(error) }
  else if let data = data { print(String(data: data, encoding: .utf8) ?? "") }
  sema.signal()
}.resume()
sema.wait()

Response example (REST JSON)#

{
  "Route": {
    "Distance": 5.42,
    "Time": 1180,
    "RouteLegs": [
      {
        "Distance": 2.10,
        "Time": 480,
        "Itinerary": {
          "Items": [
            {
              "Distance": 0.2,
              "Time": 40,
              "Text": "Head north on ...",
              "LatLong": { "Latitude": 37.79, "Longitude": -122.39 }
            }
          ]
        }
      }
    ],
    "Points": [
      { "Latitude": 37.7946, "Longitude": -122.3950 },
      { "Latitude": 37.7897, "Longitude": -122.4011 }
    ],
    "Map": null
  },
  "Errors": [],
  "Status": 1
}

Common errors#

REST 401 / Unauthorized: Missing or invalid X-API-Key.
REST 403 / Forbidden: Key is valid but blocked, expired, or lacks available credit.
SOAP authentication failure: Missing or invalid SessionIDHeader. SessionID must be your TrackServiceKey.
Validation errors: Missing Locations, invalid coordinates, or invalid enum values.

Best practices#

Batch smartly: Put multiple route calculations into one Routes call to reduce request overhead.
Prefer LatLong: Provide coordinates whenever possible to reduce geocoding ambiguity and improve performance.
Use global RoutesOptions: Set shared defaults once and override only where necessary per route.
Keep options consistent: Mixing routing engines, units, or optimization modes across routes can make comparisons harder.

FAQ#

What does the Routes API do?

Routes API calculates one or many routes in a single request. Each result can include ordered locations, distance, time, and optional map output depending on options.

How do I authenticate to Routes (REST and SOAP)?

REST requests send TrackServiceKey in the X-API-Key header. SOAP CalculateRoutes requests send TrackServiceKey in SessionIDHeader as SessionID.

When should I use Routes vs Route?

Use Route when you need to calculate a single route. Use Routes when you want to calculate multiple routes in one batch request.

What are the most common Routes API errors?

Common errors include missing or invalid X-API-Key, SOAP SessionIDHeader authentication failures, missing Locations, invalid coordinates, and invalid enum values.

Next step: optimize across vehicles

If you need to assign stops to multiple vehicles and optimize stop order for each vehicle, continue with Dispatch API.

Go to Dispatch Swagger UI

Table of Contents