shipping.nc API

Recipient self-service

Server

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

Public. The link of the pickup code text message. Gives the code only while the parcel is out for delivery, never the recipient details.

Open the pickup code link › path Parameters

token
​string · required

The token at the end of the link.

Open the pickup code link › Headers

x-correlation-id
​string · maxLength: 128

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

Open the pickup code link › Responses

What the link shows.

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
​object | null · required
pickup_code
​string | null · required

Only while the parcel is out for delivery or waits at a pickup point.

Example: 482913
​object | null · required

The pickup point where the parcel waits for the recipient; null for a delivery to an address.

​object · required

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


Text a confirmation code to the recipient

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

Public. Sends a six-digit code to the phone number the shipper gave. One code a minute and five a day per parcel; a code lasts ten minutes.

Text a confirmation code to the recipient › path Parameters

trackingNumber
​string · required

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

Text a confirmation code to the recipient › Headers

x-correlation-id
​string · maxLength: 128

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

Text a confirmation code to the recipient › Responses

The code was sent.

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

Change a delivery as the recipient

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

Public, confirmed by the text message code. Pick another day among the next five working days, collect the parcel at the hub after a failed attempt, or leave directions for the driver.

Change a delivery as the recipient › path Parameters

trackingNumber
​string · required

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

Change a delivery as the recipient › Headers

x-correlation-id
​string · maxLength: 128

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

Change a delivery as the recipient › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: verification_id, code, kind +1 more
type = object · requires: verification_id, code, kind
type = object · requires: verification_id, code, kind +1 more
Properties for Variant 1:
verification_id
​string · minLength: 1 · required
code
​string · pattern: ^\d{6}$ · required

The six digits sent by text message.

Example: 204815
kind
​string · const · required
Const value: reschedule
date
​string · date · pattern: ^(?:(?:\d\d[2468][04… · required

A Noumea day among the next five working days.

Example: 2026-11-12

Change a delivery as the recipient › Responses

The public tracking view after the change.

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