Smartlane API

The Smartlane API Developer Hub

Welcome to the Smartlane API developer hub. You'll find comprehensive guides and documentation to help you start working with Smartlane API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
 
Suggest Edits

Company

Returns the object data of the dispatcher's company. At the moment, there can be only one company in the database. However, for potential future extensions, the result of this call is a list containing one element: this one company

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/company
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/company
import requests

url = "https://dispatch.smartlane.io/your-company/api/company"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/company")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/company' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/company");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

List of company objects

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Company address

Returns the address/locations of the company central.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/companyaddress
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/companyaddress
import requests

url = "https://dispatch.smartlane.io/your-company/api/companyaddress"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/companyaddress")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/companyaddress' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/companyaddress");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Company address object

idinteger
citystring
contactcompanystring
customernrstring
contactfirstnamestring
contactlastnamestring
countrystring
districtstring
emailstring
housenumberstring
locationobject
location.coordinatesarray
location.typestring
phonenrstring
postalcodestring
streetstring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Dispatchers

Gets data of all dispatcher users in the database.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/dispatcher
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/dispatcher
import requests

url = "https://dispatch.smartlane.io/your-company/api/dispatcher"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/dispatcher")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/dispatcher' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/dispatcher");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

Response

list of dispatcher user objects

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Dispatcher (id)

Gets data of a single dispatcher user with a given id of the database. Returns the address(es)/locations of the company centrals and depots.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/dispatcher/dispatcher_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/dispatcher/dispatcher_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/dispatcher/dispatcher_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/dispatcher/dispatcher_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/dispatcher/dispatcher_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/dispatcher/dispatcher_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

dispatcher_id
int32
required

Dispatcher ID

Response

OK

idinteger
firstnamestring
lastnamestring
emailstring
company_idinteger

reference to Company

expiresstring
activeboolean
confirmed_atstring
usertypestring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Adds an additional dispatcher to the system

Adds an additional dispatcher to the system after an initial one already exists.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/adduser/dispatcher
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/adduser/dispatcher
import requests

url = "https://dispatch.smartlane.io/your-company/api/adduser/dispatcher"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/adduser/dispatcher")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/adduser/dispatcher' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/adduser/dispatcher");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

firstname
string
lastname
string
email
string

Response

Created

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Drivers

Returns a list of all drivers with all the information available.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driver
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driver
import requests

url = "https://dispatch.smartlane.io/your-company/api/driver"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driver")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driver' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driver");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

includeavail
boolean

"Returns an additional field available (which is not stored in the database) for the referring driver if the query parameter 'includeavail' is set to 'true'. Defaults to false if parameter is not supplied.

The result for 'available' is true if these two conditions are fulfilled for a driver:

There is at least one time frame in the driveravailability table.

The current time is within one of the driveravailability time frames for this driver"

includeposition
boolean

"Returns an additional field current_position for the driver's current position if the query parameter 'includeposition' is set to 'true'. Defaults to false if parameter is not supplied.
Both parameters can of course be combined, e.g.: /api/driver?includeavail=true&includeposition=true"

driverinfo
boolean

"Returns additional driver information (firstname, lastname, htmlcolor) if the query parameter 'driverinfo' is set to 'true'. Defaults to false if parameter is not supplied."

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver

Adds a new driver to the system.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/driver
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/driver
import requests

url = "https://dispatch.smartlane.io/your-company/api/driver"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driver")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/driver' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/driver");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
firstname
string
lastname
string
email
string
company_id
int32

reference to Company

expires
date-time
active
boolean
confirmed_at
date-time
usertype
string
vehicle
string

reference to Vehicletype

mobilenr
string
htmlcolor
string

Response

Created

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver

Edits/patches driver information.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/driver/driver_id
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/driver/driver_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/driver/driver_id"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driver/driver_id")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/driver/driver_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/driver/driver_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

driver_id
int32
required

Body Params

id
int32
firstname
string
lastname
string
email
string
company_id
int32

reference to Company

expires
date-time
active
boolean
confirmed_at
date-time
usertype
string
vehicle
string

reference to Vehicletype

mobilenr
string
htmlcolor
string

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver availability

Get the availability times of all drivers in the database.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driveravailability
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driveravailability
import requests

url = "https://dispatch.smartlane.io/your-company/api/driveravailability"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driveravailability")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driveravailability' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driveravailability");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver availability

Adds (but does not merge) a new driver availability time window to the database. It does not check if there is already an existing overlapping driver availability in the database. There might be multiple driver availabilities with overlapping time windows in the DB after using this POST call. if this is not desired, please use the endpoint POST /mergedriveravailability (see below).

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/driveravailability
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/driveravailability
import requests

url = "https://dispatch.smartlane.io/your-company/api/driveravailability"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driveravailability")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/driveravailability' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/driveravailability");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
fromtime
date-time
totime
date-time
driver_id
int32

reference to Driver

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver availability

Edits an existing driver availability time window

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/driveravailability
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/driveravailability
import requests

url = "https://dispatch.smartlane.io/your-company/api/driveravailability"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driveravailability")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/driveravailability' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/driveravailability");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
fromtime
date-time
totime
date-time
driver_id
int32

reference to Driver

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver availability (id)

Gets one driver availability time window identified by the time windows ID

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

driveravailability_id
int32
required

Response

OK

idinteger
fromtimestring
totimestring
driver_idinteger

reference to Driver

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver availability (id)

Deletes an existing driver availability time window

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id
curl --request DELETE \
  --url https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id"

response = requests.request("DELETE", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://dispatch.smartlane.io/your-company/api/driveravailability/driveravailability_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

driveravailability_id
int32
required

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Merge driver availability

Adds or merges a new driver availability time window after checking if another overlapping availability already exists. If there is one (at the beginning or the end of this on) ore two (at the beginning and the end of this one) already existing driver availabilities, it will be merged with the existing one(s) into one. If there is no overlapping availability, it will be added as a new one.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/mergedriveravailability
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/mergedriveravailability
import requests

url = "https://dispatch.smartlane.io/your-company/api/mergedriveravailability"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/mergedriveravailability")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/mergedriveravailability' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/mergedriveravailability");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
fromtime
date-time
totime
date-time
driver_id
int32

reference to Driver

Response

new availability successfully merged with an existing one

new availability successfully created

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver tracking

Gets all driver tracking data from the database.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/drivertracking
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/drivertracking
import requests

url = "https://dispatch.smartlane.io/your-company/api/drivertracking"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/drivertracking")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/drivertracking' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/drivertracking");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver tracking

Creates a new driver tracking entry with a timestamp and a position

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/drivertracking
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/drivertracking
import requests

url = "https://dispatch.smartlane.io/your-company/api/drivertracking"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/drivertracking")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/drivertracking' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/drivertracking");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
timestamp
date-time
position
object
 
position.coordinates
array of numbers
position.type
string
driver_id
int32

reference to Driver

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver tracking (id)

Gets one driver tracking entry identified by the tracking entry ID

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

drivertracking_id
int32
required

Response

OK

idinteger
timestampstring
positionobject
position.coordinatesarray
position.typestring
driver_idinteger

reference to Driver

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver tracking

Deletes one driver tracking entry identified by the tracking entry ID

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id
curl --request DELETE \
  --url https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id"

response = requests.request("DELETE", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://dispatch.smartlane.io/your-company/api/drivertracking/drivertracking_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

drivertracking_id
int32
required

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Drivers position

Fetches the current position of all drivers.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driverposition
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driverposition
import requests

url = "https://dispatch.smartlane.io/your-company/api/driverposition"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driverposition")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driverposition' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driverposition");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver position

Gets the current position of a single driver by id.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driverposition/driver_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driverposition/driver_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/driverposition/driver_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driverposition/driver_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driverposition/driver_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driverposition/driver_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

driver_id
int32
required

Driver ID

Response

OK

idinteger
timestampstring
positionobject
position.coordinatesarray
position.typestring
driver_idinteger

reference to Driver

firstnamestring
lastnamestring
htmlcolorstring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver trace (id)

Get a polyline of the already driven part of a route of one driver.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/drivertrace/driver_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/drivertrace/driver_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/drivertrace/driver_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/drivertrace/driver_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/drivertrace/driver_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/drivertrace/driver_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

driver_id
int32
required

Driver ID

Response

A GeoJSON Linestring

coordinatesarray
typestring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver route (id)

"Get the ID of the driven route which the driver is actually driving on. A driver could be assigned to multiple routes. This endpoint returns only one route which the driver is actually already driving (route status is 'ontheway')."

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driverroute/driver_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driverroute/driver_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/driverroute/driver_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driverroute/driver_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driverroute/driver_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driverroute/driver_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

driver_id
int32
required

Driver ID

Response

the ID of the driven route

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Driver status

Get all possible status entries for drivers

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/driverstatus
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/driverstatus
import requests

url = "https://dispatch.smartlane.io/your-company/api/driverstatus"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/driverstatus")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/driverstatus' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/driverstatus");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Vehicle type

Get all possible vehicle type entries for drivers.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/vehicletype
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/vehicletype
import requests

url = "https://dispatch.smartlane.io/your-company/api/vehicletype"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/vehicletype")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/vehicletype' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/vehicletype");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
 
Suggest Edits

Address

Get all addresses.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/address
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/address
import requests

url = "https://dispatch.smartlane.io/your-company/api/address"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/address")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/address' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/address");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Address

Adds a new customer address to the address database. The new address can then be searched via /searchaddres. If no location (latitude/longitude) is given in the request, the address will automatically be geocoded and located on the map.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/address
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/address
import requests

url = "https://dispatch.smartlane.io/your-company/api/address"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/address")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/address' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/address");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
integer
city
string
contactcompany
string
customernr
string
contactfirstname
string
contactlastname
string
country
string
district
string
email
string
housenumber
string
location
object
 
location.coordinates
array of numbers
location.type
string
phonenr
string
postalcode
string
street
string

Response

OK

idinteger
citystring
contactcompanystring
customernrstring
contactfirstnamestring
contactlastnamestring
countrystring
districtstring
emailstring
housenumberstring
locationobject
location.coordinatesarray
location.typestring
phonenrstring
postalcodestring
streetstring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Address

Edits an existing address.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/address
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/address
import requests

url = "https://dispatch.smartlane.io/your-company/api/address"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/address")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/address' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/address");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
integer
city
string
contactcompany
string
customernr
string
contactfirstname
string
contactlastname
string
country
string
district
string
email
string
housenumber
string
location
object
 
location.coordinates
array of numbers
location.type
string
phonenr
string
postalcode
string
street
string

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Address for location

Retrieves a street address for a given geo location via reverse geocoding.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/addressforlocation
curl --request GET \
  --url 'https://dispatch.smartlane.io/your-company/api/addressforlocation?lon=lon&lat=lat'
import requests

url = "https://dispatch.smartlane.io/your-company/api/addressforlocation"

querystring = {"lon":"lon","lat":"lat"}

response = requests.request("GET", url, params=querystring)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/addressforlocation?lon=lon&lat=lat")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/addressforlocation',
  qs: 
   { lon: 'lon',
     lat: 'lat' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/addressforlocation?lon=lon&lat=lat");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

lon
float
required

longitude value

lat
float
required

latitude value

Response

OK

idinteger
citystring
contactcompanystring
customernrstring
contactfirstnamestring
contactlastnamestring
countrystring
districtstring
emailstring
housenumberstring
locationobject
location.coordinatesarray
location.typestring
phonenrstring
postalcodestring
streetstring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Search address

Address objects in the database can be searched by a full text search on the fields company, contactlastname and contactfirstname for a given query string.

Please note: Search works only on database objects which are indexed by Whoosh; i.e., elements which are already in the database before the whoosh index is initially created will be ignored in the search procedure.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/searchaddress
curl --request GET \
  --url 'https://dispatch.smartlane.io/your-company/api/searchaddress?query=query'
import requests

url = "https://dispatch.smartlane.io/your-company/api/searchaddress"

querystring = {"query":"query"}

response = requests.request("GET", url, params=querystring)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/searchaddress?query=query")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/searchaddress',
  qs: { query: 'query' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/searchaddress?query=query");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

query
string
required

"The query language which can be used as querystring is quite powerful. Its capabilities and syntax can be found here:

http://whoosh.readthedocs.io/en/latest/querylang.html

Quotes may ONLY be used if the exact string is being searched. 'Lieferquelle%20OR%20Stadtb%C3%BCcherei' (result nothing) is different from Lieferquelle%20OR%20Stadtb%C3%BCcherei (result Lieferquelle, Stadtbücherei)

Please note: search works only on database objects which are indexed; i.e., elements which are already in the database before the index is initially created will be ignored in the search procedure."

limit
int32

An Integer number defining the maximum number of search results to be shown.

citocode
boolean

Flag indicating if searched address is a CitoCode

Response

OK

idinteger
citystring
contactcompanystring
customernrstring
contactfirstnamestring
contactlastnamestring
countrystring
districtstring
emailstring
housenumberstring
locationobject
location.coordinatesarray
location.typestring
phonenrstring
postalcodestring
streetstring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Tour area

Gets all tour areas as GeoJSON Multipolygons from the database. Tour areas are usually aggregated from one one or more postal code (PLZ) areas but can also be any other arbitrary geographical (Multi)Polygon. Tour areas can be assigned to one driver each so that the referring driver for a tour area can automatically be assigned to the tour which is created from deliveries/addresses located in this area.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/tourarea
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/tourarea
import requests

url = "https://dispatch.smartlane.io/your-company/api/tourarea"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/tourarea")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/tourarea' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/tourarea");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Tour area (id)

Get tour area information of a single tourarea by ID.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

tourarea_id
int32
required

Response

OK

idinteger
geomobject
geom.coordinatesarray
geom.typestring
plzareasobject
plzareas.num_resultsinteger
plzareas.objectsarray
plzareas.pageinteger
plzareas.total_pagesinteger
driver_idinteger

Reference to driver ID

areanameinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Tour area (id)

Edits/patches tour area information.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/tourarea/tourarea_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

tourarea_id
int32
required

Body Params

id
int32
geom
object
 
geom.coordinates
array of integers
geom.type
string
plzareas
object
 
plzareas.num_results
int32
plzareas.objects
array of objects
gid
plz
note
area_id
geom 
plzareas.page
int32
plzareas.total_pages
int32
driver_id
int32

Reference to driver ID

areaname
int32

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delete area (id)

Deletes tour area information of a single tourarea by ID.

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://dispatch.smartlane.io/your-company/api/deletetourarea/tourarea_id
curl --request DELETE \
  --url https://dispatch.smartlane.io/your-company/api/deletetourarea/tourarea_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/deletetourarea/tourarea_id"

response = requests.request("DELETE", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deletetourarea/tourarea_id")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://dispatch.smartlane.io/your-company/api/deletetourarea/tourarea_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://dispatch.smartlane.io/your-company/api/deletetourarea/tourarea_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

tourarea_id
int32
required

Response

OK

idinteger
geomobject
geom.coordinatesarray
geom.typestring
plzareasobject
plzareas.num_resultsinteger
plzareas.objectsarray
plzareas.pageinteger
plzareas.total_pagesinteger
driver_idinteger

Reference to driver ID

areanameinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Area from PLZ

Get tour areas for a point on the map.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/areaforpoint
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/areaforpoint
import requests

url = "https://dispatch.smartlane.io/your-company/api/areaforpoint"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/areaforpoint")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/areaforpoint' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/areaforpoint");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

lat
string

Latitude of requested point

lon
string

Longitude of requested point

Response

OK

successboolean
plzarea_idinteger

gid of containing Plzarea

plzstring

Postalcode of containg Plzarea

geomobject
geom.coordinatesarray
geom.typestring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
 
Suggest Edits

Delivery

Get data for all deliveries with all data available in the database.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/delivery
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/delivery
import requests

url = "https://dispatch.smartlane.io/your-company/api/delivery"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/delivery")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/delivery' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/delivery");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

results_per_page
integer
page
integer

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery

Add a new delivery consisting of two addresses - A pickup location (depot) depot and delivery location (destination).
Time window information pdt_from (earliest planned delivery time) and pdt_to (latest planned delivery time) must be provided for time window routing.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/delivery
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/delivery
import requests

url = "https://dispatch.smartlane.io/your-company/api/delivery"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/delivery")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/delivery' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/delivery");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
deliveryissuename
string
pdt_from
date-time

planned delivery time from

pdt_to
date-time

planned delivery time to

eta_from
date-time

estimated time of arrival time window start

eta_to
date-time

estimated time of arrival time window end

tdt_from
date-time

target delivery time from (relevant for the driver)

tdt_to
date-time

target delivery time to (relevant for the driver)

ddt_from
date-time

driver delivery target time from

ddt_to
date-time

driver delivery target time to

ata
date-time

actual time of arrival

atd
date-time

actual time of delivery

els
int32

estimated length of stay in minutes

als
number

actual length of stay in minutes

tfp
int32

driving time from preceding delivery

creationtime
date-time
deliverprio
int32
orderindex
int32
load
int32
notes
string
custom_id
string
custom_tour
string
drivernotes
string
final
boolean
vehicle
string
scancode
string
notify_customer
boolean
deliverylocation_id
int32

reference to Address

supplierlocation_id
int32

reference to Address

address
object
 
address.id
integer
address.city
string
address.contactcompany
string
address.customernr
string
address.contactfirstname
string
address.contactlastname
string
address.country
string
address.district
string
address.email
string
address.housenumber
string
address.location
object
 
address.location.coordinates
array of numbers
address.location.type
string
address.phonenr
string
address.postalcode
string
address.street
string
delivery_address
object
 
delivery_address.coordinates
array of numbers
delivery_address.type
string
supplier_address
object
 
supplier_address.coordinates
array of numbers
supplier_address.type
string
route_id
int32

reference to Route

status
int32

reference to Deliverystatus

code
int32

reference to Deliverycode

distances
string

Deprecated. JSON object containing distances to other deliveries on the same route

deliverytype_id
int32

reference to Deliverytype

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery

Edit any field of the delivery information.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/delivery
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/delivery
import requests

url = "https://dispatch.smartlane.io/your-company/api/delivery"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/delivery")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/delivery' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/delivery");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
deliveryissuename
string
pdt_from
date-time

planned delivery time from

pdt_to
date-time

planned delivery time to

eta_from
date-time

estimated time of arrival time window start

eta_to
date-time

estimated time of arrival time window end

tdt_from
date-time

target delivery time from (relevant for the driver)

tdt_to
date-time

target delivery time to (relevant for the driver)

ddt_from
date-time

driver delivery target time from

ddt_to
date-time

driver delivery target time to

ata
date-time

actual time of arrival

atd
date-time

actual time of delivery

els
int32

estimated length of stay in minutes

als
number

actual length of stay in minutes

tfp
int32

driving time from preceding delivery

creationtime
date-time
deliverprio
int32
orderindex
int32
load
int32
notes
string
custom_id
string
custom_tour
string
drivernotes
string
final
boolean
vehicle
string
scancode
string
notify_customer
boolean
deliverylocation_id
int32

reference to Address

supplierlocation_id
int32

reference to Address

address
object
 
address.id
integer
address.city
string
address.contactcompany
string
address.customernr
string
address.contactfirstname
string
address.contactlastname
string
address.country
string
address.district
string
address.email
string
address.housenumber
string
address.location
object
 
address.location.coordinates
array of numbers
address.location.type
string
address.phonenr
string
address.postalcode
string
address.street
string
delivery_address
object
 
delivery_address.coordinates
array of numbers
delivery_address.type
string
supplier_address
object
 
supplier_address.coordinates
array of numbers
supplier_address.type
string
route_id
int32

reference to Route

status
int32

reference to Deliverystatus

code
int32

reference to Deliverycode

distances
string

Deprecated. JSON object containing distances to other deliveries on the same route

deliverytype_id
int32

reference to Deliverytype

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery

Delete all queried delivery objects.

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://dispatch.smartlane.io/your-company/api/delivery
curl --request DELETE \
  --url https://dispatch.smartlane.io/your-company/api/delivery
import requests

url = "https://dispatch.smartlane.io/your-company/api/delivery"

response = requests.request("DELETE", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/delivery")
  .delete(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://dispatch.smartlane.io/your-company/api/delivery' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://dispatch.smartlane.io/your-company/api/delivery");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

results_per_page
integer
page
integer

Response

number of deleted entries

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery (id)

Get data for one delivery object in the database via it's id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/delivery/delivery_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/delivery/delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/delivery/delivery_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/delivery/delivery_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/delivery/delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/delivery/delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

delivery_id
int32
required

Delivery ID

Response

OK

idinteger
deliveryissuenamestring
pdt_fromstring

planned delivery time from

pdt_tostring

planned delivery time to

eta_fromstring

estimated time of arrival time window start

eta_tostring

estimated time of arrival time window end

tdt_fromstring

target delivery time from (relevant for the driver)

tdt_tostring

target delivery time to (relevant for the driver)

ddt_fromstring

driver delivery target time from

ddt_tostring

driver delivery target time to

atastring

actual time of arrival

atdstring

actual time of delivery

elsinteger

estimated length of stay in minutes

alsnumber

actual length of stay in minutes

tfpinteger

driving time from preceding delivery

creationtimestring
deliverpriointeger
orderindexinteger
loadinteger
notesstring
custom_idstring
custom_tourstring
drivernotesstring
finalboolean
vehiclestring
scancodestring
notify_customerboolean
deliverylocation_idinteger

reference to Address

supplierlocation_idinteger

reference to Address

addressobject
address.idinteger
address.citystring
address.contactcompanystring
address.customernrstring
address.contactfirstnamestring
address.contactlastnamestring
address.countrystring
address.districtstring
address.emailstring
address.housenumberstring
address.locationobject
address.location.coordinatesarray
address.location.typestring
address.phonenrstring
address.postalcodestring
address.streetstring
delivery_addressobject
delivery_address.coordinatesarray
delivery_address.typestring
supplier_addressobject
supplier_address.coordinatesarray
supplier_address.typestring
route_idinteger

reference to Route

statusinteger

reference to Deliverystatus

codeinteger

reference to Deliverycode

distancesstring

Deprecated. JSON object containing distances to other deliveries on the same route

deliverytype_idinteger

reference to Deliverytype

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery metadata

Get meta data for all deliveries. Similar to get delivery, but with only the most relevant data to save bandwidth.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/deliverymetadata
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/deliverymetadata
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverymetadata"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverymetadata")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverymetadata' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/deliverymetadata");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

day
string

Day for which the deliveries should be filtered, e.g. "2020-01-01".

status
int32

Status ids for which deliveries should be filtered. Use multiple times to filter for more than one type.

deliverytype_id
integer

Delivery type ids for which deliveries should be filtered. Use multiple times to filter for more than one type.

Response

OK

num_resultsinteger
objectsarray

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery metadata

Gets number of deliveries according to filters. (Compare filter parameters to get delivery).

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/deliverynumber
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/deliverynumber
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverynumber"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverynumber")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverynumber' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/deliverynumber");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

day
string

Day for which the deliveries should be filtered, e.g. "2020-01-01".

status
int32

Status ids for which deliveries should be filtered. Use multiple times to filter for more than one type.

deliverytype_id
integer

Delivery type ids for which deliveries should be filtered. Use multiple times to filter for more than one type.

Response

OK

nr_of_deliveriesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Multidelivery (id)

Get data for one multi_delivery_id from the database

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/multidelivery/multi_delivery_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/multidelivery/multi_delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/multidelivery/multi_delivery_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/multidelivery/multi_delivery_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/multidelivery/multi_delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/multidelivery/multi_delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

multi_delivery_id
int32
required

Multi delivery ID

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery type

Get all entries of delivery types from the database.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/deliverytype
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/deliverytype
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverytype"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverytype")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverytype' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/deliverytype");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

Response

OK

typenamestring

Name of the delivery type (max. 80 characters)

default_elsinteger

Default estimated length of stay.

notesstring

Notes for delivery type (max. 255 characters)

htmlcolorstring

RGB color string of 6 hex digits, e.g. '00AABB'.

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery type

Add a new delivery type

Delivery types allow users to classify deliveries, e.g. a "pickup" or "construction job", whatever required by the users business. An important property of the delivery type is the estimated length of stay.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/deliverytype
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/deliverytype
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverytype"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverytype")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverytype' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/deliverytype");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

typename
string

Name of the delivery type (max. 80 characters)

default_els
integer

Default estimated length of stay.

notes
string

Notes for delivery type (max. 255 characters)

htmlcolor
string

RGB color string of 6 hex digits, e.g. '00AABB'.

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery type

Edit any field of the delivery type information.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/deliverytype
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/deliverytype
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverytype"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverytype")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverytype' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/deliverytype");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

typename
string

Name of the delivery type (max. 80 characters)

default_els
integer

Default estimated length of stay.

notes
string

Notes for delivery type (max. 255 characters)

htmlcolor
string

RGB color string of 6 hex digits, e.g. '00AABB'.

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery status

Get all possible status entries for deliveries.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/deliverystatus
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/deliverystatus
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverystatus"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverystatus")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverystatus' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/deliverystatus");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

A list of delivery status objects

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery code

Get all possible status detail codes for deliveries. They offer a more detailed explanation (e.g. delivered to neighbor) to the status of a finished delivery (delivered or undelivered).

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/deliverycode
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/deliverycode
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverycode"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverycode")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverycode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/deliverycode");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

A list of delivery code objects

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Order up (id)

Allows manual re-ordering of deliveries via id by increasing the order index of this delivery by one (it will be handled later). The delivery which had the order index plus one before will switch the order index with this one.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/orderup/delivery_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/orderup/delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/orderup/delivery_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/orderup/delivery_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/orderup/delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/orderup/delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

delivery_id
int32
required

Delivery ID

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Order down (id)

Allows manual re-ordering of deliveries via id by decreasing the order index of this delivery by one (it will be handled earlier). The delivery which had the order index minus one before will switch the order index with this one

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/orderdown/delivery_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/orderdown/delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/orderdown/delivery_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/orderdown/delivery_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/orderdown/delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/orderdown/delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

delivery_id
int32
required

Delivery ID

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery done (id)

Automatically sets values of this finished delivery for status ('delivered' or 'undelivered'), actual delivery time and driver notes.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/deliverydone/delivery_id
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/deliverydone/delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverydone/delivery_id"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverydone/delivery_id")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverydone/delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/deliverydone/delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

delivery_id
int32
required

Delivery ID to finish.

Form Data

status
string

Status is --delivered-- (= successfully delivered to recipient. This is default if not set) or --undelivered-- (indicating a failed delivery for re-planning).

code
int32

Workflow code of the delivery status.

drivernotes
string

Additial notes from the driver, e.g. reasons for undeliverable item.

deliverytime
date-time

Sets the atd (actual time of delivery) for the correspondent delivery

name
string

Name of the recipient.

scancode
string

Scanned barcode.

signature_base64
string

A base64 string containing a encoded png

signature_png
binary

Local path of the signature file(s) to be uploaded.

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Finished deliveries

Returns a list of all finished ('delivered' or 'undelivered') deliveries filtered by time and status

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/finisheddeliveries
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/finisheddeliveries
import requests

url = "https://dispatch.smartlane.io/your-company/api/finisheddeliveries"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/finisheddeliveries")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/finisheddeliveries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/finisheddeliveries");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

start
date-time

start time for query, defaults to midnight of today

end
date-time

end time for query, defaults to now

status
string

status filter for deliveries (delivered or undelivered or both)

code
int32

code for delivery status details (e.g. delivered to neighbor or recipient not at home). Available codes are available via GET /deliverycode. Defaults to 1 (delivered to recipient) if status is delivered, else to 4 (recipient not present)

allundelivered
boolean

indicates if date and time filter are ignored for undelivered deliveries. Often, all deliveries that are still undelivered should be displayed regardless of when the delivery attempt failed and regardless of the date filter for the successfully delivered deliveries. Defaults to true (all undelivered deliveries are returned)

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Delivery beeline (id)

Calculates the direct / beeline distance between a delivery location and its starting point (e.g. depot).

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/deliverybeeline/delivery_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/deliverybeeline/delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverybeeline/delivery_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverybeeline/delivery_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverybeeline/delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/deliverybeeline/delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

delivery_id
int32
required

Delivery ID

Response

OK

coordinatesarray
typestring

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Cancel delivery (id)

Cancels an unfinished (not yet delivered) delivery because of an unplanned event (e.g. customer cancels order). The delivery will be moved to the delivery archive and is not available anymore for routing

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/canceldelivery/delivery_id
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/canceldelivery/delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/canceldelivery/delivery_id"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/canceldelivery/delivery_id")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/canceldelivery/delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/canceldelivery/delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

delivery_id
int32
required

Delivery ID

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Pickup and Delivery from two deliveries

Connects two single deliveries so that one will be the pickup for the other (the actual delivery). A pickup will always be planned before a delivery in a tour planning process. Furthermore, a pickup decreases the vehicles capacity by the given load of this entry

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/deliverypickup
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/deliverypickup
import requests

url = "https://dispatch.smartlane.io/your-company/api/deliverypickup"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/deliverypickup")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/deliverypickup' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/deliverypickup");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

pickup_id
int32

ID of the delivery object (previously created e.g. by POST /delivery) which will be the pickup entity

delivery_id
int32

ID of the delivery object (previously created e.g. by POST /delivery) which will be the delivery entity

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Live delivery (id)

Returns tracking information for one (signed) delivery. Tracking consists of the current position of the driver and an estimated time of arrival at the deliveries destination. This endpoint is not secured by an authorization token but it must be supplied a cryptographically signed key containing the delivery id as path parameter. This signed id is generated for all deliveries on a route when setting the route status to 'ontheway' (PATCH /route {status : 3}. By setting this route status, an email will be sent automatically to all delivery recipients for which an email address was supplied in their address. This emails each contains a link to a tracking page handling the signed delivery ID for tracking their delivery.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/livedelivery/signed_delivery_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/livedelivery/signed_delivery_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/livedelivery/signed_delivery_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/livedelivery/signed_delivery_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/livedelivery/signed_delivery_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/livedelivery/signed_delivery_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

signed_delivery_id
int32
required

Cryptographically signed delivery ID

Response

OK

idstring
addressobject
address.idinteger
address.citystring
address.contactcompanystring
address.customernrstring
address.contactfirstnamestring
address.contactlastnamestring
address.countrystring
address.districtstring
address.emailstring
address.housenumberstring
address.locationobject
address.location.coordinatesarray
address.location.typestring
address.phonenrstring
address.postalcodestring
address.streetstring
etastring
driverinfoobject
driverinfo.idinteger
driverinfo.timestampstring
driverinfo.positionobject
driverinfo.position.coordinatesarray
driverinfo.position.typestring
driverinfo.driver_idinteger

reference to Driver

A failure message caused by missing authorization (403 forbidden)

A conflict with current data in the database has been detected (e.g. delivery does not exist or is not assigned to a route)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route

Returns all data for all planned routes from the system.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/route
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/route
import requests

url = "https://dispatch.smartlane.io/your-company/api/route"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/route")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/route' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/route");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter query string. Can be used to filter results. Detailed description

results_per_page
integer
page
integer

Response

List of route objects

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route (id)

Returns all data for one planned route from the system.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/route/route_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/route/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/route/route_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/route/route_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/route/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/route/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Route ID

Response

Detailed route data

idinteger
creationtimestring
aststring

Actual start time

tst_fromstring

Target start time span (beginning)

tst_tostring

Target start time span (end)

distanceinteger

Complete length of route in meters

driver_idinteger
gross_durationinteger

Complete duration of tour, including length of driver's stays in minutes

net_durationinteger

Pure driving time in minutes

statusinteger
deliveriesarray
custom_idstring
previous_deliveriesarray

When deliveries are removed or changed, they are saved here

previous_driversarray

List of drivers that were previously assigned

pstinteger

Deprecated. Planed start time

replacesinteger

Reference IDs to previous versions, when the route is updated.

routebase_addressobject
routebase_address.idinteger
routebase_address.citystring
routebase_address.contactcompanystring
routebase_address.customernrstring
routebase_address.contactfirstnamestring
routebase_address.contactlastnamestring
routebase_address.countrystring
routebase_address.districtstring
routebase_address.emailstring
routebase_address.housenumberstring
routebase_address.locationobject
routebase_address.location.coordinatesarray
routebase_address.location.typestring
routebase_address.phonenrstring
routebase_address.postalcodestring
routebase_address.streetstring
routebase_address_idinteger

Reference to Address

routestringobject

GeoJSON LineString of locations on the route

routestring.coordinatesarray
routestring.typestring
sorted_deliveriesarray

Deprecated

areatextstring

Autogenerated summary of the routes region

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route (id)

Edits the route information.
Currently used for updating the status and driver_id. Soon to be replaced by dedicated endpoints.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/route/route_id
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/route/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/route/route_id"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/route/route_id")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/route/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/route/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Route ID

Body Params

id
int32
creationtime
date-time
ast
date-time

Actual start time

tst_from
date-time

Target start time span (beginning)

tst_to
date-time

Target start time span (end)

distance
int32

Complete length of route in meters

driver_id
int32
gross_duration
int32

Complete duration of tour, including length of driver's stays in minutes

net_duration
int32

Pure driving time in minutes

status
int32
deliveries
array of objects
id
deliveryissuename
pdt_from
pdt_to
eta_from
eta_to
tdt_from
tdt_to
ddt_from
ddt_to
ata
atd
els
als
tfp
creationtime
deliverprio
orderindex
load
notes
custom_id
custom_tour
drivernotes
final
vehicle
scancode
notify_customer
deliverylocation_id
supplierlocation_id
address 
delivery_address 
supplier_address 
route_id
status
code
distances
deliverytype_id
custom_id
string
previous_deliveries
array of objects

When deliveries are removed or changed, they are saved here

id
deliveryissuename
pdt_from
pdt_to
eta_from
eta_to
tdt_from
tdt_to
ddt_from
ddt_to
ata
atd
els
als
tfp
creationtime
deliverprio
orderindex
load
notes
custom_id
custom_tour
drivernotes
final
vehicle
scancode
notify_customer
deliverylocation_id
supplierlocation_id
address 
delivery_address 
supplier_address 
route_id
status
code
distances
deliverytype_id
previous_drivers
array of objects

List of drivers that were previously assigned

id
firstname
lastname
email
company_id
expires
active
confirmed_at
usertype
vehicle
mobilenr
htmlcolor
pst
int32

Deprecated. Planed start time

replaces
int32

Reference IDs to previous versions, when the route is updated.

routebase_address
object
 
routebase_address.id
integer
routebase_address.city
string
routebase_address.contactcompany
string
routebase_address.customernr
string
routebase_address.contactfirstname
string
routebase_address.contactlastname
string
routebase_address.country
string
routebase_address.district
string
routebase_address.email
string
routebase_address.housenumber
string
routebase_address.location
object
 
routebase_address.location.coordinates
array of numbers
routebase_address.location.type
string
routebase_address.phonenr
string
routebase_address.postalcode
string
routebase_address.street
string
routebase_address_id
int32

Reference to Address

routestring
object

GeoJSON LineString of locations on the route

 
routestring.coordinates
array of numbers
routestring.type
string
sorted_deliveries
array of objects

Deprecated

id
deliveryissuename
pdt_from
pdt_to
eta_from
eta_to
tdt_from
tdt_to
ddt_from
ddt_to
ata
atd
els
als
tfp
creationtime
deliverprio
orderindex
load
notes
custom_id
custom_tour
drivernotes
final
vehicle
scancode
notify_customer
deliverylocation_id
supplierlocation_id
address 
delivery_address 
supplier_address 
route_id
status
code
distances
deliverytype_id
areatext
string

Autogenerated summary of the routes region

Response

Detailed route data

idinteger
creationtimestring
aststring

Actual start time

tst_fromstring

Target start time span (beginning)

tst_tostring

Target start time span (end)

distanceinteger

Complete length of route in meters

driver_idinteger
gross_durationinteger

Complete duration of tour, including length of driver's stays in minutes

net_durationinteger

Pure driving time in minutes

statusinteger
deliveriesarray
custom_idstring
previous_deliveriesarray

When deliveries are removed or changed, they are saved here

previous_driversarray

List of drivers that were previously assigned

pstinteger

Deprecated. Planed start time

replacesinteger

Reference IDs to previous versions, when the route is updated.

routebase_addressobject
routebase_address.idinteger
routebase_address.citystring
routebase_address.contactcompanystring
routebase_address.customernrstring
routebase_address.contactfirstnamestring
routebase_address.contactlastnamestring
routebase_address.countrystring
routebase_address.districtstring
routebase_address.emailstring
routebase_address.housenumberstring
routebase_address.locationobject
routebase_address.location.coordinatesarray
routebase_address.location.typestring
routebase_address.phonenrstring
routebase_address.postalcodestring
routebase_address.streetstring
routebase_address_idinteger

Reference to Address

routestringobject

GeoJSON LineString of locations on the route

routestring.coordinatesarray
routestring.typestring
sorted_deliveriesarray

Deprecated

areatextstring

Autogenerated summary of the routes region

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Set status (id)

Sets the status of the route with ID route_id and is a simpler alternative to PATCHing the status of the route.
"Note: this is supposed to be a PATCH. But is set to be POST for an issue with cordova"

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/setroutestatus/route_id
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/setroutestatus/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/setroutestatus/route_id"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/setroutestatus/route_id")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/setroutestatus/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/setroutestatus/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Identifier of the Route

Response

Ok

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route metadata

"Returns a reduced set of data (without route geometry) for planned routes from the system.
Retrieves route objects with all fields except the following: routebase (only routebase address id), delivery details (only delivery ids), routestring."

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/routemetadata
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/routemetadata
import requests

url = "https://dispatch.smartlane.io/your-company/api/routemetadata"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/routemetadata")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/routemetadata' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/routemetadata");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

q
string

Filter parameters

Response

List of routes with minimal information

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route metadata (id)

Returns a reduced set of data (without geometry) for one planned route from the system. This call retrieves route objects with all fields except the following: routebase (only routebase address id), delivery details (only delivery ids), routestring.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/routemetadata/route_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/routemetadata/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/routemetadata/route_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/routemetadata/route_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/routemetadata/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/routemetadata/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Route ID

Response

Minimal information for one single route

idinteger
custom_idstring

an arbitrary custom tour id/name

aststring

actual start time. Will be set, when tour status is set to 'ontheway'

creationtimestring
deliveriesarray

if routing parameter response_date is set to any OTHER value than 'base' or 'all', only delivery IDs will be returned. Otherwise, see 'delivery_items' below

delivery_itemsarray

if routing parameter response_date is set to 'base' or 'all', delivery objects will be returned. Otherwise, see 'deliveries' above

distanceinteger

driving distance of whole route in meters

driver_idinteger

reference to Driver

gross_durationinteger

net duration (including stop times at each location) of whole route in seconds

htmlcolorstring

color of the route for displaying it on a map

net_durationinteger

net duration (only driving time without stops) of whole route in seconds

tst_fromstring

ealiest tour target start time for driver

tst_tostring

latest tour target start time for driver

routebase_address_idinteger

reference to start address object

routestringstring

a GeoJSON Linestring object containing lat/lon waypoints of the whole tour. Will ohnly be returned if the request parameter 'routestring' is set to true

statusinteger

see 'Routestatus'

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Routing variants

Get all possible routing variants for a list of deliveries.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/routingvariants
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/routingvariants
import requests

url = "https://dispatch.smartlane.io/your-company/api/routingvariants"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/routingvariants")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/routingvariants' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/routingvariants");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

deliveryids
array of integers

Response

Preferred routing variant and alternatives.

mainvariantarray

Preferred routing variant

variantsarray

Alternative routing variants

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Updateable routes

Get updateable routes.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/updateableroutes
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/updateableroutes
import requests

url = "https://dispatch.smartlane.io/your-company/api/updateableroutes"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/updateableroutes")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/updateableroutes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/updateableroutes");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route delivery distances (id)

Get all distances between subsequent deliveries on this route, i.e. an object containing information for all deliveries on this route including the distance from a delivery to its respective predecessor

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/routedeliverydistances/route_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/routedeliverydistances/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/routedeliverydistances/route_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/routedeliverydistances/route_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/routedeliverydistances/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/routedeliverydistances/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Route ID

Response

Distances and information between deliveries of one route

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Update etas timewindow (id)

"Calculates the estimated time of arrival for all active deliveries on one route with a given ID

Updates all estimated arrival times for all deliveries on a given route (which must be in the status 'ontheway'). The values are stored as 'eta_from' and 'eta_to' in the delivery tables of the database an can be retrieved via GET /delivery for each delivery.
Calculation is done between the current position of a driver on the delivery's route and all deliveries each which must not be unassigned, (already) delivered or canceled.
The current and predicted traffic situation are considered in this call.
The relevant route and the referring driver are automatically derived from the given route.
All already delivered or canceled deliveries must have set a correct status. Otherwise they will be falsely considered in this calculation."

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/updateetas/timewindow/route_id
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/updateetas/timewindow/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/updateetas/timewindow/route_id"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/updateetas/timewindow/route_id")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/updateetas/timewindow/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/updateetas/timewindow/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Route ID

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Update etas timewindow

"Calculates the estimated time of arrival for all active deliveries on all active routes

Updates all estimated arrival times for all deliveries on all routes which are in the status 'ontheway'. The values are stored as 'eta_from' and 'eta_to' in the delivery tables of the database an can be retrieved via GET /delivery for each delivery.
Calculation is done between the current position of a driver on each delivery's route and all deliveries each which must not be unassigned, (already) delivered or canceled.
The current and predicted traffic situation are considered in this call.
The relevant route and the referring driver are automatically derived from the given route.
All already delivered or canceled assignments must have set a correct status. Otherwise they will be falsely considered in this calculation."

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/updateetas/timewindow
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/updateetas/timewindow
import requests

url = "https://dispatch.smartlane.io/your-company/api/updateetas/timewindow"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/updateetas/timewindow")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/updateetas/timewindow' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/updateetas/timewindow");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Route status

Get all possible status entries for routes.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://dispatch.smartlane.io/your-company/api/routestatus
curl --request GET \
  --url https://dispatch.smartlane.io/your-company/api/routestatus
import requests

url = "https://dispatch.smartlane.io/your-company/api/routestatus"

response = requests.request("GET", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/routestatus")
  .get()
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'GET',
  url: 'https://dispatch.smartlane.io/your-company/api/routestatus' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://dispatch.smartlane.io/your-company/api/routestatus");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

OK

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Calc route optimized timewindow

Calculates the optimal route(s) for deliveries with (optional) time windows and a common starting point. The deliveries will be distributed to a number of tours according to the available time and vehicle capacities.
It calls an intelligent algorithm which fits all delivery times into their respective time windows but also results in the shortest possible overall driving time.
The number of tours will be minimized considering the given time and load volume constraints. if the url parameter "assign_drivers" is set to true, available drivers will automatically assigned to each tour.
However, it is not necessary to define any drivers beforehand.

This is per default an asynchroneous process which only returns a Process ID. Results can then be polled (e.g. every second) via "GET /api/process/status/<process_id>/final".
There is also a possibility to get the results of a finished routing process immediately via Websockets. Please discuss our sample Websocket client implementations with us: support@smartlane.de.
The routing process can also be called synchroneously by setting the "async" parameter explicitely to false. In this case, no polling is required and results will be returned directly.
Pleas note that in this synchroneous case, the call might take a while and block the API server while waiting for the response.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/calcroute/optimized/timewindow
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/calcroute/optimized/timewindow
import requests

url = "https://dispatch.smartlane.io/your-company/api/calcroute/optimized/timewindow"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/calcroute/optimized/timewindow")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/calcroute/optimized/timewindow' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/calcroute/optimized/timewindow");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

truck
boolean

indicates if a special route for trucks shall be calculated. In this case, truck restrictions on the respective roads will be respected. The resulting tour will not lead through truck restricted road sections. Default: false

roundtrip
boolean

indicates if tours should be planned as round trip returning to the depot after finishing the tour

traffic
boolean

flag indicating if traffic situation prediction should be used for route calculation

cancelroutes
boolean

flag indicating if all existing routes should be cancelled before new routing process starts

vehicle
string

Vehicle type for resulting routes. Must be one of 'car', 'truck' or 'bicycle'. This parameter has an effect on the road types that will be used and on the average speed on each road

num_vehicles
int32

fix maximum number of tours that can be planned. If this parameter is set to a specific value, the actual number of drivers in the system will be ignored. No route will be calculated if this value is not enough for the necessary number of tours. Defaults to number of driver objects in the system. If there are no drivers in the system, a maximum of 5 is assumed. Alternative spelling: numvehicles

assign_drivers
boolean

indicates if drivers should be assigned automatically after routing

usearea
boolean

If set to true and if there are existing tour areas in the system, imported deliveries will automatically be matched to pre-defined geographical areas. Usually, these areas are a union of one or more postal code areas. Existing areas can be viewed via GET /tourarea. All deliveries in one area will result in exactly one tour each. If there are remaining deliveries which are not located in one of the pre-defined areas, they will automatically clustered to new optimized tours. Defaults to false

relax_minutes
int32

Relax all time windows by maximally by this value in minutes by 30min steps (maximally 300min). Increases likelihood of a feasible solution but decreases punctuality of time windows

relax_after_time
string

Relax time windows only after this given fixed time. Is only used if relax_minutes > 0. Format is hh:mm:ss+hh(timezone):mm(timezone). Always provide time zone information

nameprefix
string

A user-defined prefix for calculated tour names/custom ids in this request. If the result contains than one tour, this prefix wil be extended by sequential numbers

async
boolean

indicates if the routing process shall be asynchronous or not. If set to true, routing will be processed concurrently in the background and the server is free to receive other requests. A process ID will be returned immediately after calling the request which can then be polled (e.g. every second) via 'GET /api/process/status/<process_id>/final'. If set to false, server will be blocked and complete results will be returned immediately after they are processed.

response_data
string

Indicates if payload data (i.e. route and location/delivery details of routing result) should be provided in response. Only relevant when parameter 'async' is explicitely set to 'false'. Asynchroneous routing will not return any payload data immediately (see 'GET /api/process/status/<process_id>/final' instead)

Body Params

deliverydata
array of objects

a list of delivery/address objects (either in the Delivery format with city, street, ... or geo positions lat and lng) which will be combined to the resulting tour(s). Time windows (pdt_from and pdt_to) are optional. It is required to provide either 'deliverydata' or 'deliveriyids'. If both are provided, only deliveryids is used.

custom_id
lat
lng
city
postalcode
street
housenumber
customernr
contactcompany
contactfirstname
contactlastname
country
email
phonenr
pdt_from
pdt_to
els
load
notes
final
pickup_ref_id
notify_customer_email
notify_customer_sms
deliverytype_id
deliveryids
array of integers

a list of delivery ids (if delivery objects are already defined) which will be combined to the resulting tour(s). It is required to provide either 'deliverydata' or 'deliveriyids'. If both are provided, only 'deliveryids' is used.

startaddress_id
int32

Use either startaddress_id OR startaddress (or none of both). startaddress_id is the ID of the Address object (if such an address object already exists) which should be used as starting point/depot of all tours. Default is the standard company / depot address. If both, 'startaddress' (see below) AND 'startaddress_id' are provided, only startaddress is used.

startaddress
object

Address object. Either complete Address data (city, street, ...) or geo positions lat and lng (see 'Inputaddress'). It defines the starting point of the tour. Default is the standard company / depot address. Either 'startaddress_id' (see above) or 'startaddress' or none of both can be given. If both are provided, only startaddress is used.

 
startaddress.city
string
startaddress.country
string
startaddress.housenumber
string
startaddress.postalcode
string
startaddress.street
string
startaddress.lat
double
startaddress.lng
double
start_time
date-time

Start time for an optional predefined time frame for deliveries on the route. It is only used for deliveries which don't have a specified time window (pdt_from and pdt_to) which always would have a higher priority

end_time
date-time

End time for an optional predefined end time frame for deliveries on the route. It is only used for deliveries which don't have a specified time window (pdt_from and pdt_to) which always would have a higher priority

vehcapacities
array of integers

List of vehicle capacity numbers (e.g. kg or nr of parcels, same unit as delivery.load) which is the maximum load per vehicle/tour. It is recommended to have at least the same number of capacities as number of vehicles in one call.

fix_order
boolean

If set to true, the resulting order of deliveries in the tour calculation result will stay exectly as given in the routing request body

Response

resulting route ids and (if reponse_data is set to 'base' or 'all'), also route payload data. 'all' also includes geo routestring of tour. Only relevant for synchroneous routing (else, see response status 202)

num_resultsinteger
objectsarray
pageinteger
total_pagesinteger

process_id for started asynchroneous process. Can be used for async status polling via "GET /api/process/status/<process_id>/final"

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Calc route update timewindow (id)

Re-calculates times and delivery orders of an existing time window optimized route based on current delays and traffic conditions.
It generates a new route based on existing unfinished (not yet delivered or canceled) deliveries of the route with the given ID. Additionally, it may consume one or both optional ID lists of new deliveries and/or deleted deliveries as body parameter and calculates a route containing "old" and "new" deliveries combined minus the newly deleted deliveries.
It also sets the status of the "old" route to "route_replaced" and sets the field "replaced_by" to the ID of the new calculated route. Already delivered or canceled delivery objects will not be re-calculated or re-ordered. Notice: All new deliveries must start from the same location (depot) than all already existing ones on the updated route.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://dispatch.smartlane.io/your-company/api/calcroute/update/timewindow/route_id
curl --request PATCH \
  --url https://dispatch.smartlane.io/your-company/api/calcroute/update/timewindow/route_id
import requests

url = "https://dispatch.smartlane.io/your-company/api/calcroute/update/timewindow/route_id"

response = requests.request("PATCH", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/calcroute/update/timewindow/route_id")
  .patch(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://dispatch.smartlane.io/your-company/api/calcroute/update/timewindow/route_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://dispatch.smartlane.io/your-company/api/calcroute/update/timewindow/route_id");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

route_id
int32
required

Route ID

Body Params

add_deliveryids
array of integers
del_deliveryids
array of integers

Response

OK. Route successfully updated.

A failure message caused by missing authorization (403 forbidden)

A failure message caused by unprocessable input (e.g. no data found for input parameters)

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Upload onestep

Uploads an excel file containing addresses, planned time windows and tour IDs. It afterwards automatically calculates optimized tours containing more accurate actual time windows.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://dispatch.smartlane.io/your-company/api/upload/onestep
curl --request POST \
  --url https://dispatch.smartlane.io/your-company/api/upload/onestep
import requests

url = "https://dispatch.smartlane.io/your-company/api/upload/onestep"

response = requests.request("POST", url)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://dispatch.smartlane.io/your-company/api/upload/onestep")
  .post(null)
  .build();

Response response = client.newCall(request).execute();
var request = require("request");

var options = { method: 'POST',
  url: 'https://dispatch.smartlane.io/your-company/api/upload/onestep' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://dispatch.smartlane.io/your-company/api/upload/onestep");

xhr.send(data);
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

cancelroutes
boolean

If set to true, all previously existing routes will be archived before routing starts. Defaults to false

assign_drivers
boolean

If set to true, all existing drivers will be randomly distributed to the resulting tours after routing. Defaults to false

preclustered
boolean

If set to true, the user can pre-assign multiple delivery/address rows in the excel file to desired routes by setting any value in the tour-column. All remaining delivery entries in the excel file(s) with no entry in the tour column will be clustered automatically to new optimized tours. If set to false, all entries in the tour-column will be ignored and optimal area clusters will be calculated for the routing process. Defaults to true

usearea
boolean

If set to true and if there are existing tour areas in the system, imported deliveries will automatically be matched to pre-defined geographical areas. Usually, these areas are a union of one or more postal code areas. Existing areas can be viewed via GET /tourarea. All deliveries in one area will result in exactly one tour each. If there are remaining deliveries which are not located in one of the pre-defined areas, they will automatically clustered to new optimized tours. Defaults to false

relax_minutes
int32

Relax all time windows by maximally by this value in minutes by 30min steps (maximally 300min). Increases likelihood of a feasible solution but decreases punctuality of time windows

relax_after_time
string

Relax time windows only after this given fixed time. Is only used if relax_minutes > 0. Format is hh:mm:ss+hh(timezone):mm(timezone). Always provide time zone information