shipping.nc API

Company register

Server

Look up the New Caledonian companies of the ISEE RIDET register (data.gouv.nc, Licence Ouverte v2.0) to fill in a company.


Search the company register

GET
https://api.shipping.nc
/v1/settings/companies

Up to 10 establishments by name, trade name or acronym, or by the start of a RID or RIDET. From the ISEE register of active establishments (RIDET), published on data.gouv.nc under the Licence Ouverte v2.0. The register is refreshed monthly and lists no street address. A 503 means the register is unavailable: type the company in. Fills the company of the carrier or of a shipper account. Allowed to carrier admins only.

Search the company register › query Parameters

q
​string · minLength: 2 · maxLength: 100 · required

A company name, trade name or acronym, or the start of a RID or RIDET.

Example: murene transports

Search the company register › Headers

x-correlation-id
​string · maxLength: 128

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

Search the company register › Responses

The matching establishments.

​object[] · required

Get an establishment of the company register

GET
https://api.shipping.nc
/v1/settings/companies/{ridet}

From the ISEE register of active establishments (RIDET), published on data.gouv.nc under the Licence Ouverte v2.0. The register is refreshed monthly and lists no street address. A 503 means the register is unavailable: type the company in. Fills the company of the carrier or of a shipper account. Allowed to carrier admins only.

Get an establishment of the company register › path Parameters

ridet
​string · required

The RIDET: 7 figures, a dot and the 3-figure establishment rank.

Get an establishment of the company register › Headers

x-correlation-id
​string · maxLength: 128

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

Get an establishment of the company register › Responses

The establishment.

ridet
​string · pattern: ^\d{7}\.\d{3}$ · required

The business identifier in New Caledonia.

Example: 1234567.001
legal_name
​string · required

The registered name.

Example: MURENE TRANSPORTS
trade_name
​string | null · required

The sign of the establishment.

Example: MURENE TRANSPORTS
acronym
​string | null · required
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
legal_form_label
​string | null · required

The legal form as the register names it.

Example: Société à responsabilité limitée
activity
​string | null · required

The NAF activity of the establishment.

Example: Transports routiers réguliers de voyageurs
commune
​string | null · enum · required

Null when the establishment is outside New Caledonia.

Enum values:
Nouméa
Dumbéa
Mont-Dore
Païta
Boulouparis
La Foa
Farino
Sarraméa
Example: Yaté
province
​string | null · required