Plan the tours of a day, publish them to the drivers and follow them live.
List tours
Newest first, cursor paginated, each tour with its stops, progress and driver phone. Allowed to carrier admins and dispatchers.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
qHeld anywhere in the tour code, the tour name or the driver name, ignoring case.
date^(?:(?:\d\d[2468][04…A Noumea day.
statusComma-separated statuses to keep.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List tours › Responses
One page of tours.
next_cursorPass it as cursor to get the next page. null on the last page.
Create a tour
A planned tour for a driver on a day, optionally with its first shipments. Allowed to carrier admins and dispatchers.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Create a tour › Request Body
driver_membership_id^([0-9a-fA-F]{8}-[0-… · requireddate^(?:(?:\d\d[2468][04… · requiredA Noumea day.
namevehicle_labelshipment_idsCreate a tour › Responses
The created tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredA Noumea day.
nameGiven by dispatch.
areaMain localities of the stops.
statusplanned: dispatch is still building it, drivers do not see it. published: on the driver phone. in_progress: the driver started it. completed: the driver closed it.
versiondepot_nameA GPS position in decimal degrees (WGS 84).
vehicle_labelcapacity_gramsload_gramsdistance_mplanned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredestimatesHow times and distances are estimated. road: driving distances and times from the routing provider; a tour planned while the provider did not answer keeps straight-line figures until its next change. straight_line: straight lines at an average speed.
published_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredThe paired phone of the driver.
From the last synced event that carried a GPS position.
created_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredGet a tour
The live view of a tour: stops, progress, driver phone and last known position. Allowed to carrier admins and dispatchers.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a tour › Responses
The tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredA Noumea day.
nameGiven by dispatch.
areaMain localities of the stops.
statusplanned: dispatch is still building it, drivers do not see it. published: on the driver phone. in_progress: the driver started it. completed: the driver closed it.
versiondepot_nameA GPS position in decimal degrees (WGS 84).
vehicle_labelcapacity_gramsload_gramsdistance_mplanned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredestimatesHow times and distances are estimated. road: driving distances and times from the routing provider; a tour planned while the provider did not answer keeps straight-line figures until its next change. straight_line: straight lines at an average speed.
published_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredThe paired phone of the driver.
From the last synced event that carried a GPS position.
created_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredAdd shipments to a tour
Appends one stop per shipment, a pickup when the parcel is still at the sender. A published or started tour reaches the phone at its next sync. Allowed to carrier admins and dispatchers.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Add shipments to a tour › Request Body
shipment_idsAdd shipments to a tour › Responses
The tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredA Noumea day.
nameGiven by dispatch.
areaMain localities of the stops.
statusplanned: dispatch is still building it, drivers do not see it. published: on the driver phone. in_progress: the driver started it. completed: the driver closed it.
versiondepot_nameA GPS position in decimal degrees (WGS 84).
vehicle_labelcapacity_gramsload_gramsdistance_mplanned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredestimatesHow times and distances are estimated. road: driving distances and times from the routing provider; a tour planned while the provider did not answer keeps straight-line figures until its next change. straight_line: straight lines at an average speed.
published_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredThe paired phone of the driver.
From the last synced event that carried a GPS position.
created_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredReorder the stops of a tour
Done and failed stops keep their rank. The driver gets the new order at the next sync. Allowed to carrier admins and dispatchers.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Reorder the stops of a tour › Request Body
stop_idsEvery stop of the tour, in the new order. Done and failed stops keep their rank.
Reorder the stops of a tour › Responses
The tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredA Noumea day.
nameGiven by dispatch.
areaMain localities of the stops.
statusplanned: dispatch is still building it, drivers do not see it. published: on the driver phone. in_progress: the driver started it. completed: the driver closed it.
versiondepot_nameA GPS position in decimal degrees (WGS 84).
vehicle_labelcapacity_gramsload_gramsdistance_mplanned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredestimatesHow times and distances are estimated. road: driving distances and times from the routing provider; a tour planned while the provider did not answer keeps straight-line figures until its next change. straight_line: straight lines at an average speed.
published_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredThe paired phone of the driver.
From the last synced event that carried a GPS position.
created_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredGive the remaining stops to another driver
Moves the pending stops to the open tour of that driver on the same day, or to a new planned tour. Answers with the receiving tour. Allowed to carrier admins and dispatchers.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Give the remaining stops to another driver › Request Body
driver_membership_id^([0-9a-fA-F]{8}-[0-… · requiredThe driver whose tour of the same day takes the pending stops.
Give the remaining stops to another driver › Responses
The tour that received the stops.
idcodedate^(?:(?:\d\d[2468][04… · requiredA Noumea day.
nameGiven by dispatch.
areaMain localities of the stops.
statusplanned: dispatch is still building it, drivers do not see it. published: on the driver phone. in_progress: the driver started it. completed: the driver closed it.
versiondepot_nameA GPS position in decimal degrees (WGS 84).
vehicle_labelcapacity_gramsload_gramsdistance_mplanned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredestimatesHow times and distances are estimated. road: driving distances and times from the routing provider; a tour planned while the provider did not answer keeps straight-line figures until its next change. straight_line: straight lines at an average speed.
published_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredThe paired phone of the driver.
From the last synced event that carried a GPS position.
created_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredPublish the tours of a day
Sends every planned tour of the day that has stops to the phones of its drivers. Allowed to carrier admins and dispatchers.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Publish the tours of a day › Request Body
date^(?:(?:\d\d[2468][04… · requiredA Noumea day.
Publish the tours of a day › Responses
How many tours were published.
publishedHow many tours went to the driver phones.
Optimize the stop order of the tours of a day
Reorders the pending stops of every open tour of the day. No routing provider is connected yet: the order is nearest neighbour on straight lines, and stops without GPS position go last. Allowed to carrier admins and dispatchers.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Optimize the stop order of the tours of a day › Request Body
date^(?:(?:\d\d[2468][04… · requiredA Noumea day.
Optimize the stop order of the tours of a day › Responses
The tours of the day.
next_cursorPass it as cursor to get the next page. null on the last page.
List shipments waiting for a tour
Shipments that can go on a tour and sit on no open tour, newest first. Allowed to carrier admins and dispatchers.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
zoneComma-separated destination zones to keep.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List shipments waiting for a tour › Responses
One page of shipments.
next_cursorPass it as cursor to get the next page. null on the last page.
List drivers
Active driver members, newest first. Allowed to carrier admins and dispatchers.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List drivers › Responses
One page of drivers.
next_cursorPass it as cursor to get the next page. null on the last page.