What a paired driver phone reads and records about its own tours.
List my tours
The published, started and closed tours of the driver, newest first. Only a paired driver phone; it sees its own published tours and nothing else.
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.
date^(?:(?:\d\d[2468][04…Keep the tours of this Noumea day.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List my tours › Responses
One page of tours.
next_cursorPass it as cursor to get the next page. null on the last page.
Download a tour
The tour with its stops and exactly the recipient data a delivery needs. Keep it on the phone for offline use and download it again when version changes. Only a paired driver phone; it sees its own published tours and nothing else.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Download a tour › Responses
The tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredThe Noumea day of the tour.
nameThe name dispatch gave, or the main localities of its stops.
statusversionGoes up each time dispatch changes the tour. Download the tour again when it differs from yours.
depot_namevehicle_labelstop_countparcel_countdistance_mEstimated driving distance.
planned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredStart a tour
The driver leaves the depot. Safe to retry: starting a started tour changes nothing. Only a paired driver phone; it sees its own published tours and nothing else.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Start a tour › Request Body
occurred_at^(?:(?:\d\d[2468][04… · requiredWhen it happened on the device.
Start a tour › Responses
The tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredThe Noumea day of the tour.
nameThe name dispatch gave, or the main localities of its stops.
statusversionGoes up each time dispatch changes the tour. Download the tour again when it differs from yours.
depot_namevehicle_labelstop_countparcel_countdistance_mEstimated driving distance.
planned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredClose a tour
The driver is back at the depot. Safe to retry. Only a paired driver phone; it sees its own published tours and nothing else.
path Parameters
idThe tour id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Close a tour › Request Body
occurred_at^(?:(?:\d\d[2468][04… · requiredWhen it happened on the device.
Close a tour › Responses
The tour.
idcodedate^(?:(?:\d\d[2468][04… · requiredThe Noumea day of the tour.
nameThe name dispatch gave, or the main localities of its stops.
statusversionGoes up each time dispatch changes the tour. Download the tour again when it differs from yours.
depot_namevehicle_labelstop_countparcel_countdistance_mEstimated driving distance.
planned_start_at^(?:(?:\d\d[2468][04… · requiredplanned_end_at^(?:(?:\d\d[2468][04… · requiredstarted_at^(?:(?:\d\d[2468][04… · requiredcompleted_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredRecord the load scan of a stop
The parcels of the stop are in the van. Safe to retry: the first scan time is kept. Only a paired driver phone; it sees its own published tours and nothing else.
path Parameters
idThe tour id.
stopIdThe stop id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Record the load scan of a stop › Request Body
scanned_at^(?:(?:\d\d[2468][04… · requiredWhen the parcel was scanned into the van, on the device.
Record the load scan of a stop › Responses
Recorded.
Get an upload URL for a proof
A presigned form, valid 15 minutes, to POST a signature or a photo of a shipment on your tour, up to max_bytes. A photo is a JPEG or a PNG, a signature an SVG or a PNG. Upload, then reference the returned key in the tracking event: the event is refused until the file is there. Only a paired driver phone; it sees its own published tours and nothing else.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get an upload URL for a proof › Request Body
shipment_id^([0-9a-fA-F]{8}-[0-… · requiredkindcontent_typeA photo is a JPEG or a PNG; a signature is an SVG drawn from the strokes of the pad, or a PNG.
Get an upload URL for a proof › Responses
Where to upload.
keyReference it in the proof or incident of the tracking event.
upload_urlPOST a multipart form there before it expires: the fields below first, then the file as file.
methodmax_bytesThe storage refuses a larger file.
expires_at^(?:(?:\d\d[2468][04… · required