shipping.nc API

Pickup points

Server

The shops of the shipping.nc pickup point network, where recipients collect their parcels. For checkout pages and shipment forms.


List the pickup points

GET
https://api.shipping.nc
/v1/relay/points

The shops of the shipping.nc network where a recipient can collect a parcel, for a checkout page or a shipment form. Closed points are left out; accepts_parcels tells whether a new parcel can go there now. Filter by commune, or by near_lat and near_lng for the nearest first. Any carrier member token or shipper API key (Bearer shk_...) is accepted.

List the pickup points › query Parameters

commune
​string · enum

A commune of New Caledonia.

Enum values:
Nouméa
Dumbéa
Mont-Dore
Païta
Boulouparis
La Foa
Farino
Sarraméa
near_lat
​number · min: -90 · max: 90
near_lng
​number · min: -180 · max: 180
radius_km
​number · max: 500

With near_lat and near_lng: only the points within this distance, nearest first.

Default: 10
limit
​integer · min: 1 · max: 100
Default: 20

List the pickup points › Headers

x-correlation-id
​string · maxLength: 128

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

List the pickup points › Responses

The pickup points.

​object[] · required

Get a pickup point

GET
https://api.shipping.nc
/v1/relay/points/{id}

One shop of the network, with its address, opening hours and whether it takes parcels now.

Get a pickup point › path Parameters

id
​string · minLength: 1 · required

Get a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Get a pickup point › Responses

The pickup point.

A shop of the shipping.nc network that holds parcels for recipients.
id
​string · required
name
​string · required
address_lines
​string[] · required
postal_code
​string | null · required
commune
​string · enum · required

A commune of New Caledonia.

Enum values:
Nouméa
Dumbéa
Mont-Dore
Païta
Boulouparis
La Foa
Farino
Sarraméa
​object · required

A GPS position in decimal degrees (WGS 84).

​array · minItems: 7 · maxItems: 7 · required
phone
​string | null · required

The shop phone number, in E.164 format.

status
​string · enum · required

active: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.

Enum values:
active
paused
closed
accepts_parcels
​boolean · required

Whether a new parcel can be addressed to the point now: active and not full.

distance_m
​integer | null · min: -9007199254740991 · max: 9007199254740991 · required

The straight-line distance from the near position, when one was given.