shipping.nc API

Carrier signup

Server

Public: a carrier asks for an account, proves its email with a code, and waits for the shipping.nc staff to accept it.


Ask for a carrier account

POST
https://api.shipping.nc
/v1/public/signup-requests

Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). Checks the RIDET against the register, then emails a 6-digit code that proves the address. The answer never tells whether the email already has an account.

Ask for a carrier account › Headers

x-correlation-id
​string · maxLength: 128

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

Ask for a carrier account › Request Body

ridet
​string · required

The establishment, as the RIDET register knows it. The name and legal form come from the register.

commune
​string · required

Where the deliveries start; the commune of the register unless the carrier chose another one.

Example: Nouméa
first_name
​string · minLength: 1 · maxLength: 60 · required
last_name
​string · minLength: 1 · maxLength: 60 · required
email
​string · email · maxLength: 254 · pattern: ^(?:[A-Za-z0-9_'+\-]… · required

Where the verification code, then the invitation, are sent.

locale
​string · enum · required

The language of the emails.

Enum values:
fr
en
accept_terms
​boolean · const · required

The terms of use and the privacy policy are accepted.

Const value:
phone
​string

A phone number. Six digits without a prefix are read as a New Caledonia number (+687).

Example: +687 78 12 34

Ask for a carrier account › Responses

The code was sent.

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

When the code just sent stops working.

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

When a new code may be asked for.


Verify the email of a signup request

POST
https://api.shipping.nc
/v1/public/signup-requests/{id}/verification

Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). A code works for 15 minutes and 5 attempts; a 422 tells which in details.reason (wrong, expired, locked) and details.attempts_left. Once verified, the request waits for the shipping.nc staff.

Verify the email of a signup request › path Parameters

id
​string · uuid · required

The id the creation answered.

Verify the email of a signup request › Headers

x-correlation-id
​string · maxLength: 128

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

Verify the email of a signup request › Request Body

code
​string · required

The 6-digit code of the email; spaces are ignored.

Verify the email of a signup request › Responses

The request waits for review.

id
​string · required
company_name
​string · required
ridet
​string · required
commune
​string · required
first_name
​string · required
email
​string · required

Send a new verification code

POST
https://api.shipping.nc
/v1/public/signup-requests/{id}/code

Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). At most one code a minute per request and 5 a day per email; a 429 carries Retry-After and details.reason (cooldown, daily_limit). The previous code stops working.

Send a new verification code › path Parameters

id
​string · uuid · required

The id the creation answered.

Send a new verification code › Headers

x-correlation-id
​string · maxLength: 128

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

Send a new verification code › Responses

A new code was sent.

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

When the code just sent stops working.

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

When a new code may be asked for.


Search the company register

GET
https://api.shipping.nc
/v1/public/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 a signup request. Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). Answers may be cached for five minutes.

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/public/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 a signup request. Public, unauthenticated. The API Gateway throttles this route on its own, below the stage limit (ADR 0016). Answers may be cached for five minutes.

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