shipping.nc API

Driver phone

Server

What a paired driver phone reads and records about its own tours.


List my tours

GET
https://api.shipping.nc
/v1/dispatch/driver/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.

List my tours › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
date
​string · date · pattern: ^(?:(?:\d\d[2468][04…

Keep the tours of this Noumea day.

Example: 2026-11-11

List my tours › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

List my tours › Responses

One page of tours.

​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


Download a tour

GET
https://api.shipping.nc
/v1/dispatch/driver/tours/{id}

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.

Download a tour › path Parameters

id
​string · uuid · required

The tour id.

Download a tour › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Download a tour › Responses

The tour.

id
​string · required
code
​string · required
date
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required

The Noumea day of the tour.

Example: 2026-11-11
name
​string · required

The name dispatch gave, or the main localities of its stops.

Example: Nouméa sud et Mont-Dore
status
​string · enum · required
Enum values:
published
in_progress
completed
version
​integer · max: 9007199254740991 · required

Goes up each time dispatch changes the tour. Download the tour again when it differs from yours.

Example: 3
depot_name
​string · required
vehicle_label
​string | null · required
stop_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
parcel_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
distance_m
​integer | null · min: -9007199254740991 · max: 9007199254740991 · required

Estimated driving distance.

Example: 64000
planned_start_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
planned_end_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
started_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
completed_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object[] · required

Start a tour

POST
https://api.shipping.nc
/v1/dispatch/driver/tours/{id}/start

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.

Start a tour › path Parameters

id
​string · uuid · required

The tour id.

Start a tour › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Start a tour › Request Body

occurred_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When it happened on the device.

Example: 2026-11-11T14:05:00+11:00

Start a tour › Responses

The tour.

id
​string · required
code
​string · required
date
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required

The Noumea day of the tour.

Example: 2026-11-11
name
​string · required

The name dispatch gave, or the main localities of its stops.

Example: Nouméa sud et Mont-Dore
status
​string · enum · required
Enum values:
published
in_progress
completed
version
​integer · max: 9007199254740991 · required

Goes up each time dispatch changes the tour. Download the tour again when it differs from yours.

Example: 3
depot_name
​string · required
vehicle_label
​string | null · required
stop_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
parcel_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
distance_m
​integer | null · min: -9007199254740991 · max: 9007199254740991 · required

Estimated driving distance.

Example: 64000
planned_start_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
planned_end_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
started_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
completed_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object[] · required

Close a tour

POST
https://api.shipping.nc
/v1/dispatch/driver/tours/{id}/complete

The driver is back at the depot. Safe to retry. Only a paired driver phone; it sees its own published tours and nothing else.

Close a tour › path Parameters

id
​string · uuid · required

The tour id.

Close a tour › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Close a tour › Request Body

occurred_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When it happened on the device.

Example: 2026-11-11T14:05:00+11:00

Close a tour › Responses

The tour.

id
​string · required
code
​string · required
date
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required

The Noumea day of the tour.

Example: 2026-11-11
name
​string · required

The name dispatch gave, or the main localities of its stops.

Example: Nouméa sud et Mont-Dore
status
​string · enum · required
Enum values:
published
in_progress
completed
version
​integer · max: 9007199254740991 · required

Goes up each time dispatch changes the tour. Download the tour again when it differs from yours.

Example: 3
depot_name
​string · required
vehicle_label
​string | null · required
stop_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
parcel_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
distance_m
​integer | null · min: -9007199254740991 · max: 9007199254740991 · required

Estimated driving distance.

Example: 64000
planned_start_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
planned_end_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
started_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
completed_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object[] · required

Record the load scan of a stop

PUT
https://api.shipping.nc
/v1/dispatch/driver/tours/{id}/stops/{stopId}/loaded

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.

Record the load scan of a stop › path Parameters

id
​string · uuid · required

The tour id.

stopId
​string · uuid · required

The stop id.

Record the load scan of a stop › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Record the load scan of a stop › Request Body

scanned_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the parcel was scanned into the van, on the device.

Example: 2026-11-11T14:05:00+11:00

Record the load scan of a stop › Responses

Recorded.

No data returned

Get an upload URL for a proof

POST
https://api.shipping.nc
/v1/dispatch/driver/proof-uploads

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.

Get an upload URL for a proof › Headers

x-correlation-id
​string · maxLength: 128

Your request identifier. Generated when absent, and always echoed in the response header.

Get an upload URL for a proof › Request Body

shipment_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
kind
​string · enum · required
Enum values:
signature
photo
content_type
​string · enum · required

A photo is a JPEG or a PNG; a signature is an SVG drawn from the strokes of the pad, or a PNG.

Enum values:
image/png
image/jpeg
image/svg+xml

Get an upload URL for a proof › Responses

Where to upload.

key
​string · required

Reference it in the proof or incident of the tracking event.

upload_url
​string · required

POST a multipart form there before it expires: the fields below first, then the file as file.

method
​string · const · required
Const value: POST
​object · required
max_bytes
​integer · max: 9007199254740991 · required

The storage refuses a larger file.

Example: 4194304
expires_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required