shipping.nc API

Public tracking

Server

What a recipient sees, without personal data.


Brand a tracking page by its host

GET
https://api.shipping.nc
/v1/tracking/sites/{host}

Public. The carrier that serves its tracking page on this host name, so the page wears its brand before any parcel is looked up. Answers may be cached for five minutes.

Brand a tracking page by its host › path Parameters

host
​string · required

The host name of the tracking page, without scheme or port. Case is ignored.

Brand a tracking page by its host › Headers

x-correlation-id
​string · maxLength: 128

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

Brand a tracking page by its host › Responses

The carrier of this tracking page.

​object · required

The carrier that delivers the parcel: its public brand and support contact only.


Track a parcel

GET
https://api.shipping.nc
/v1/tracking/{trackingNumber}

Public, unauthenticated. Never returns the recipient name, phone, address or GPS position: only the status history with coarse places, the destination zone and the delivery terms.

Track a parcel › path Parameters

trackingNumber
​string · required

Two-letter carrier prefix, 8 digits and a check digit. Spaces and case are ignored.

Track a parcel › Headers

x-correlation-id
​string · maxLength: 128

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

Track a parcel › Responses

The public tracking view.

tracking_number
​string · required
status
​string · enum · required
Enum values:
created
picked_up
in_transit
out_for_delivery
delivered
available_for_pickup
collected
delivery_failed
service_kind
​string · enum · required
Enum values:
home_delivery
express_same_day
pickup_point
delivery_confirmation
​string · enum · required

What the recipient must do at the door.

Enum values:
none
signature
otp
destination_zone
​string · enum · required
Enum values:
grand_noumea
brousse_west
brousse_east
loyalty_islands
isle_of_pines
parcel_count
​integer · min: 1 · max: 9007199254740991 · required
​object | null · required

When the next delivery attempt is expected: the window of the current attempt while out for delivery, the next attempt after a failed one. null when unknown.

failure_reason
​string | null · enum · required

Why the last attempt failed, while the status is delivery_failed.

Enum values:
recipient_absent
address_not_found
refused
no_access
damaged
id_check_failed
pickup_code_missing
​object · required

The carrier that delivers the parcel: its public brand and support contact only.

​object | null · required

The pickup point where the parcel waits for the recipient, once it got there; null before, or for a delivery to an address.

​object[] · required