shipping.nc API

Platform console

Server

shipping.nc staff only: provisioning carriers, support sessions, audit log and stage health. Every call is authorized against platform_staff and audited.


Get the signed-in staff member

GET
https://api.shipping.nc
/v1/admin/me

Get the signed-in staff member › Headers

x-correlation-id
​string · maxLength: 128

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

Get the signed-in staff member › Responses

Profile and counters.

user_id
​string · required
email
​string · required
full_name
​string · required
role
​string · enum · required
Enum values:
platform_admin
support
read_only
​object · required

Count carriers per lifecycle

GET
https://api.shipping.nc
/v1/admin/carriers/stats

Count carriers per lifecycle › Headers

x-correlation-id
​string · maxLength: 128

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

Count carriers per lifecycle › Responses

Counts and regions.

​object · required
regions
​string[] · required

Check a tracking prefix and a subdomain

GET
https://api.shipping.nc
/v1/admin/carriers/availability

Check a tracking prefix and a subdomain › query Parameters

tracking_prefix
​string · pattern: ^[A-Z]{2}$
subdomain
​string · minLength: 3 · maxLength: 40 · pattern: ^[a-z0-9]+(-[a-z0-9]…

The back-office subdomain, under shipping.nc.

Example: cote-est

Check a tracking prefix and a subdomain › Headers

x-correlation-id
​string · maxLength: 128

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

Check a tracking prefix and a subdomain › Responses

Whether each value is free on the whole platform.

​object | null · required
​object | null · required

Export the carriers as CSV

GET
https://api.shipping.nc
/v1/admin/carriers/export

Export the carriers as CSV › Headers

x-correlation-id
​string · maxLength: 128

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

Export the carriers as CSV › Responses

Every carrier, one row each.

string

List carriers

GET
https://api.shipping.nc
/v1/admin/carriers

List carriers › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
q
​string · minLength: 1 · maxLength: 100

Name, RIDET or subdomain.

lifecycle
​string · enum
Enum values:
active
onboarding
suspended
plan
​string · enum
Enum values:
starter
standard
pro
region
​string · minLength: 1 · maxLength: 80

List carriers › Headers

x-correlation-id
​string · maxLength: 128

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

List carriers › Responses

Most recently active first.

​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


Provision a carrier

POST
https://api.shipping.nc
/v1/admin/carriers

Creates the tenant and, when asked, invites its first carrier admin by email. Platform admins only.

Provision a carrier › Headers

x-correlation-id
​string · maxLength: 128

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

Provision a carrier › Request Body

legal_name
​string · minLength: 1 · maxLength: 160 · required
name
​string · minLength: 1 · maxLength: 80 · required
ridet
​string · required
address
​string · minLength: 1 · maxLength: 200 · required
commune
​string · required

A commune of New Caledonia; case, accents and dashes are ignored.

Example: Nouméa
tracking_prefix
​string · pattern: ^[A-Z]{2}$ · required
subdomain
​string · minLength: 3 · maxLength: 40 · pattern: ^[a-z0-9]+(-[a-z0-9]… · required

The back-office subdomain, under shipping.nc.

Example: cote-est
primary_color
​string · pattern: ^#[0-9a-fA-F]{6}$ · required
plan
​string · enum · required
Enum values:
starter
standard
pro
​object · required
send_invitation
​boolean · required
sms_sender_name
​string · pattern: ^[A-Za-z0-9]{1,11}$

Provision a carrier › Responses

The created carrier.

id
​string · required
name
​string · required
legal_name
​string | null · required
ridet
​string | null · required
address
​string | null · required
commune
​string | null · required
subdomain
​string · required
tracking_prefix
​string · required
primary_color
​string | null · required
sms_sender_name
​string | null · required
plan
​string · enum · required
Enum values:
starter
standard
pro
region
​string | null · required
lifecycle
​string · enum · required
Enum values:
active
onboarding
suspended
contact_name
​string | null · required
contact_email
​string | null · required
contact_phone
​string | null · required
zones
​string[] · required
Enum values:
grand_noumea
brousse_west
brousse_east
loyalty_islands
isle_of_pines
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object | null · required
​object · required
​object · required
​object · required
​object[] · required
​object | null · required
​object[] · required
​object[] · required

Get a carrier

GET
https://api.shipping.nc
/v1/admin/carriers/{id}

Get a carrier › path Parameters

id
​string · minLength: 1 · required

Get a carrier › Headers

x-correlation-id
​string · maxLength: 128

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

Get a carrier › Responses

Profile, onboarding, usage, members, devices.

id
​string · required
name
​string · required
legal_name
​string | null · required
ridet
​string | null · required
address
​string | null · required
commune
​string | null · required
subdomain
​string · required
tracking_prefix
​string · required
primary_color
​string | null · required
sms_sender_name
​string | null · required
plan
​string · enum · required
Enum values:
starter
standard
pro
region
​string | null · required
lifecycle
​string · enum · required
Enum values:
active
onboarding
suspended
contact_name
​string | null · required
contact_email
​string | null · required
contact_phone
​string | null · required
zones
​string[] · required
Enum values:
grand_noumea
brousse_west
brousse_east
loyalty_islands
isle_of_pines
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object | null · required
​object · required
​object · required
​object · required
​object[] · required
​object | null · required
​object[] · required
​object[] · required

Update a carrier profile

PATCH
https://api.shipping.nc
/v1/admin/carriers/{id}

Update a carrier profile › path Parameters

id
​string · required

Update a carrier profile › Headers

x-correlation-id
​string · maxLength: 128

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

Update a carrier profile › Request Body

legal_name
​string · minLength: 1 · maxLength: 160
name
​string · minLength: 1 · maxLength: 80
ridet
​string
address
​string · minLength: 1 · maxLength: 200
commune
​string

A commune of New Caledonia; case, accents and dashes are ignored.

Example: Nouméa
region
​string | null · minLength: 1 · maxLength: 80
plan
​string · enum
Enum values:
starter
standard
pro
contact_name
​string · minLength: 1 · maxLength: 120
contact_phone
​string | null

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

Example: +687 78 12 34

Update a carrier profile › Responses

The updated carrier.

id
​string · required
name
​string · required
legal_name
​string | null · required
ridet
​string | null · required
address
​string | null · required
commune
​string | null · required
subdomain
​string · required
tracking_prefix
​string · required
primary_color
​string | null · required
sms_sender_name
​string | null · required
plan
​string · enum · required
Enum values:
starter
standard
pro
region
​string | null · required
lifecycle
​string · enum · required
Enum values:
active
onboarding
suspended
contact_name
​string | null · required
contact_email
​string | null · required
contact_phone
​string | null · required
zones
​string[] · required
Enum values:
grand_noumea
brousse_west
brousse_east
loyalty_islands
isle_of_pines
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object | null · required
​object · required
​object · required
​object · required
​object[] · required
​object | null · required
​object[] · required
​object[] · required

Suspend a carrier

POST
https://api.shipping.nc
/v1/admin/carriers/{id}/suspend

The back-office turns read-only for its members; tracking pages stay online.

Suspend a carrier › path Parameters

id
​string · required

Suspend a carrier › Headers

x-correlation-id
​string · maxLength: 128

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

Suspend a carrier › Request Body

reason
​string · minLength: 3 · maxLength: 500 · required

Suspend a carrier › Responses

Suspended.

No data returned

Reactivate a suspended carrier

POST
https://api.shipping.nc
/v1/admin/carriers/{id}/reactivate

Reactivate a suspended carrier › path Parameters

id
​string · required

Reactivate a suspended carrier › Headers

x-correlation-id
​string · maxLength: 128

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

Reactivate a suspended carrier › Responses

Reactivated.

No data returned

Resend the carrier admin invitation

POST
https://api.shipping.nc
/v1/admin/carriers/{id}/admin-invitation

Resend the carrier admin invitation › path Parameters

id
​string · required

Resend the carrier admin invitation › Headers

x-correlation-id
​string · maxLength: 128

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

Resend the carrier admin invitation › Responses

The address the new link was sent to, and the link itself on a stage that sends no email.

email
​string · required
accept_url
​string · uri

Open a support session

POST
https://api.shipping.nc
/v1/admin/carriers/{id}/support-sessions

Time-limited and audited. Write mode is for platform admins only.

Open a support session › path Parameters

id
​string · required

Open a support session › Headers

x-correlation-id
​string · maxLength: 128

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

Open a support session › Request Body

reason
​string · minLength: 10 · maxLength: 1000 · required
mode
​string · enum · required
Enum values:
read_only
write
​required
ticket
​string · minLength: 1 · maxLength: 40

Open a support session › Responses

The session.

id
​string · required
reference
​string · required
​object · required
​object · required
reason
​string · required
ticket
​string | null · required
mode
​string · enum · required
Enum values:
read_only
write
duration_minutes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
started_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
expires_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
ended_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
is_active
​boolean · required

List support sessions

GET
https://api.shipping.nc
/v1/admin/support-sessions

List support sessions › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
active
​string · enum
Enum values:
true
false
carrier_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

List support sessions › Headers

x-correlation-id
​string · maxLength: 128

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

List support sessions › Responses

Most recent first.

​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


Get a support session

GET
https://api.shipping.nc
/v1/admin/support-sessions/{id}

Get a support session › path Parameters

id
​string · required

Get a support session › Headers

x-correlation-id
​string · maxLength: 128

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

Get a support session › Responses

The session.

id
​string · required
reference
​string · required
​object · required
​object · required
reason
​string · required
ticket
​string | null · required
mode
​string · enum · required
Enum values:
read_only
write
duration_minutes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
started_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
expires_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
ended_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
is_active
​boolean · required

End a support session

POST
https://api.shipping.nc
/v1/admin/support-sessions/{id}/end

End a support session › path Parameters

id
​string · required

End a support session › Headers

x-correlation-id
​string · maxLength: 128

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

End a support session › Responses

The ended session.

id
​string · required
reference
​string · required
​object · required
​object · required
reason
​string · required
ticket
​string | null · required
mode
​string · enum · required
Enum values:
read_only
write
duration_minutes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
started_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
expires_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
ended_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
is_active
​boolean · required

Search shipments across carriers

GET
https://api.shipping.nc
/v1/admin/shipments/search

Search shipments across carriers › query Parameters

by
​string · enum · required
Enum values:
tracking_number
phone
q
​string · minLength: 3 · maxLength: 40 · required
limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ

Search shipments across carriers › Headers

x-correlation-id
​string · maxLength: 128

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

Search shipments across carriers › Responses

Personal data masked unless you have a support session open with that carrier.

​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


Count the team per role

GET
https://api.shipping.nc
/v1/admin/staff/stats

Count the team per role › Headers

x-correlation-id
​string · maxLength: 128

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

Count the team per role › Responses

Counts.

all
​integer · min: -9007199254740991 · max: 9007199254740991 · required
platform_admin
​integer · min: -9007199254740991 · max: 9007199254740991 · required
support
​integer · min: -9007199254740991 · max: 9007199254740991 · required
read_only
​integer · min: -9007199254740991 · max: 9007199254740991 · required
mfa_missing
​integer · min: -9007199254740991 · max: 9007199254740991 · required

List the shipping.nc team

GET
https://api.shipping.nc
/v1/admin/staff

List the shipping.nc team › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
role
​string · enum
Enum values:
platform_admin
support
read_only
mfa_missing
​string · enum
Enum values:
true
false

List the shipping.nc team › Headers

x-correlation-id
​string · maxLength: 128

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

List the shipping.nc team › Responses

One page of staff members.

​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


Invite a shipping.nc team member

POST
https://api.shipping.nc
/v1/admin/staff

Creates the staff sign-in (Cognito emails a temporary password). MFA is required at first sign-in.

Invite a shipping.nc team member › Headers

x-correlation-id
​string · maxLength: 128

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

Invite a shipping.nc team member › Request Body

email
​string · email · maxLength: 254 · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
full_name
​string · minLength: 1 · maxLength: 120 · required
role
​string · enum · required
Enum values:
platform_admin
support
read_only

Invite a shipping.nc team member › Responses

Invited.

user_id
​string · required

Change a team member role

PATCH
https://api.shipping.nc
/v1/admin/staff/{userId}

Change a team member role › path Parameters

userId
​string · required

Change a team member role › Headers

x-correlation-id
​string · maxLength: 128

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

Change a team member role › Request Body

role
​string · enum · required
Enum values:
platform_admin
support
read_only

Change a team member role › Responses

Changed.

No data returned

Remove a team member

DELETE
https://api.shipping.nc
/v1/admin/staff/{userId}

Remove a team member › path Parameters

userId
​string · required

Remove a team member › Headers

x-correlation-id
​string · maxLength: 128

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

Remove a team member › Responses

Removed.

No data returned

Export the audit log as CSV

GET
https://api.shipping.nc
/v1/admin/audit-log/export

Export the audit log as CSV › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
q
​string · minLength: 1 · maxLength: 100
from
​string · date · pattern: ^(?:(?:\d\d[2468][04…

First day, Noumea time, inclusive.

to
​string · date · pattern: ^(?:(?:\d\d[2468][04…

Last day, Noumea time, inclusive.

actor_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
carrier_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
action
​string · enum
Enum values:
carrier.created
carrier.updated
carrier.suspended
carrier.reactivated
invitation.resent
support_session.started
support_session.ended
support_session.request
support_session_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
support_only
​string · enum
Enum values:
true
false

Export the audit log as CSV › Headers

x-correlation-id
​string · maxLength: 128

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

Export the audit log as CSV › Responses

Up to 10 000 entries.

string

List the audit log

GET
https://api.shipping.nc
/v1/admin/audit-log

List the audit log › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
q
​string · minLength: 1 · maxLength: 100
from
​string · date · pattern: ^(?:(?:\d\d[2468][04…

First day, Noumea time, inclusive.

to
​string · date · pattern: ^(?:(?:\d\d[2468][04…

Last day, Noumea time, inclusive.

actor_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
carrier_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
action
​string · enum
Enum values:
carrier.created
carrier.updated
carrier.suspended
carrier.reactivated
invitation.resent
support_session.started
support_session.ended
support_session.request
support_session_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
support_only
​string · enum
Enum values:
true
false

List the audit log › Headers

x-correlation-id
​string · maxLength: 128

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

List the audit log › Responses

Most recent first.

​object[] · required
next_cursor
​string | null · required

Pass it as cursor to get the next page. null on the last page.


Export messaging per carrier as CSV

GET
https://api.shipping.nc
/v1/admin/messaging/export

Export messaging per carrier as CSV › query Parameters

period
​string · enum
Enum values:
24h
7d
30d
Default: 7d

Export messaging per carrier as CSV › Headers

x-correlation-id
​string · maxLength: 128

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

Export messaging per carrier as CSV › Responses

One row per carrier.

string

Get SMS and email delivery

GET
https://api.shipping.nc
/v1/admin/messaging

Get SMS and email delivery › query Parameters

period
​string · enum
Enum values:
24h
7d
30d
Default: 7d

Get SMS and email delivery › Headers

x-correlation-id
​string · maxLength: 128

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

Get SMS and email delivery › Responses

The report.

period
​string · enum · required
Enum values:
24h
7d
30d
​object · required
​object · required
​object[] · required
​object[] · required
​object · required
source
​string · enum · required
Enum values:
measured
simulated

Retry failed messages

POST
https://api.shipping.nc
/v1/admin/messaging/retry

Retry failed messages › Headers

x-correlation-id
​string · maxLength: 128

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

Retry failed messages › Request Body

ids
​string[] · maxItems: 100

Retry failed messages › Responses

How many were retried.

retried
​number · required

Get the stage health

GET
https://api.shipping.nc
/v1/admin/system-health

Get the stage health › query Parameters

period
​string · enum
Enum values:
1h
24h
7d
Default: 24h

Get the stage health › Headers

x-correlation-id
​string · maxLength: 128

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

Get the stage health › Responses

Metrics and alarms.

period
​string · enum · required
Enum values:
1h
24h
7d
stage
​string · required
​object · required
​object · required
​object[] · required
​object · required
​object[] · required
​object[] · required
source
​string · enum · required
Enum values:
measured
simulated

Export a month of usage as CSV

GET
https://api.shipping.nc
/v1/admin/usage/export

Export a month of usage as CSV › query Parameters

month
​string · pattern: ^\d{4}-(0[1-9]|1[0-2… · required

The month, as YYYY-MM.

Example: 2026-10

Export a month of usage as CSV › Headers

x-correlation-id
​string · maxLength: 128

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

Export a month of usage as CSV › Responses

One row per carrier, for billing.

string

Get a month of usage

GET
https://api.shipping.nc
/v1/admin/usage

Get a month of usage › query Parameters

month
​string · pattern: ^\d{4}-(0[1-9]|1[0-2… · required

The month, as YYYY-MM.

Example: 2026-10

Get a month of usage › Headers

x-correlation-id
​string · maxLength: 128

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

Get a month of usage › Responses

Per carrier.

month
​string · required
is_closed
​boolean · required
​object | null · required
​object[] · required
​object · required

Get the platform overview

GET
https://api.shipping.nc
/v1/admin/overview

Get the platform overview › Headers

x-correlation-id
​string · maxLength: 128

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

Get the platform overview › Responses

The overview.

​object · required
​object · required
first_attempt_delivery_rate
​number | null · required
​object · required
​object · required
​object · required
​array · required
​object · required
​object[] · required
​object[] · required

List the pickup points

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

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

Every point of the network, closed ones included, with its occupancy.

​object[] · required

Add a pickup point to the network

POST
https://api.shipping.nc
/v1/admin/relay-points

The point is active at once. Platform admins only.

Add a pickup point to the network › Headers

x-correlation-id
​string · maxLength: 128

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

Add a pickup point to the network › Request Body

name
​string · minLength: 1 · maxLength: 120 · required
address_lines
​string[] · minItems: 1 · maxItems: 4 · required

One to four address lines, street first.

Example: ["3 rue de Sébastopol","Quartier Latin"]
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
capacity
​integer · min: 1 · max: 10000 · required

How many parcels the shop can hold at once.

​object · required
postal_code
​string | null · pattern: ^988\d{2}$
Default: null
hold_days
​integer · min: 1 · max: 60

How many days a parcel waits for its recipient before it goes back to the carrier.

Default: 14

Add a pickup point to the network › Responses

The created pickup point.

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
capacity
​integer · min: -9007199254740991 · max: 9007199254740991 · required
hold_days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
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
​object · required
staff_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Get a pickup point

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

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 and its occupancy.

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
capacity
​integer · min: -9007199254740991 · max: 9007199254740991 · required
hold_days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
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
​object · required
staff_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Change a pickup point

PUT
https://api.shipping.nc
/v1/admin/relay-points/{id}

Replaces the description of the point. A closed point cannot change. Platform admins only.

Change a pickup point › path Parameters

id
​string · minLength: 1 · required

Change a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Change a pickup point › Request Body

name
​string · minLength: 1 · maxLength: 120 · required
address_lines
​string[] · minItems: 1 · maxItems: 4 · required

One to four address lines, street first.

Example: ["3 rue de Sébastopol","Quartier Latin"]
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
capacity
​integer · min: 1 · max: 10000 · required

How many parcels the shop can hold at once.

​object · required
postal_code
​string | null · pattern: ^988\d{2}$
Default: null
hold_days
​integer · min: 1 · max: 60

How many days a parcel waits for its recipient before it goes back to the carrier.

Default: 14

Change a pickup point › Responses

The changed pickup point.

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
capacity
​integer · min: -9007199254740991 · max: 9007199254740991 · required
hold_days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
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
​object · required
staff_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Pause a pickup point

POST
https://api.shipping.nc
/v1/admin/relay-points/{id}/pause

The point keeps handing over the parcels it holds, and takes no new one. Platform admins only.

Pause a pickup point › path Parameters

id
​string · minLength: 1 · required

Pause a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Pause a pickup point › Responses

The pickup point.

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
capacity
​integer · min: -9007199254740991 · max: 9007199254740991 · required
hold_days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
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
​object · required
staff_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Reopen a pickup point

POST
https://api.shipping.nc
/v1/admin/relay-points/{id}/reopen

The point takes new parcels again. Platform admins only.

Reopen a pickup point › path Parameters

id
​string · minLength: 1 · required

Reopen a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Reopen a pickup point › Responses

The pickup point.

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
capacity
​integer · min: -9007199254740991 · max: 9007199254740991 · required
hold_days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
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
​object · required
staff_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Close a pickup point

POST
https://api.shipping.nc
/v1/admin/relay-points/{id}/close

The point leaves the network for good, once no parcel is expected or held there. Platform admins only.

Close a pickup point › path Parameters

id
​string · minLength: 1 · required

Close a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Close a pickup point › Responses

The pickup point.

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
capacity
​integer · min: -9007199254740991 · max: 9007199254740991 · required
hold_days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
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
​object · required
staff_count
​integer · min: -9007199254740991 · max: 9007199254740991 · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

List the counter staff of a pickup point

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

List the counter staff of a pickup point › path Parameters

id
​string · minLength: 1 · required

List the counter staff of a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

List the counter staff of a pickup point › Responses

The people who can sign in at the counter.

​object[] · required

Invite a person to the counter of a pickup point

POST
https://api.shipping.nc
/v1/admin/relay-points/{id}/staff

Creates their counter sign-in, and emails them a temporary password. Platform admins only.

Invite a person to the counter of a pickup point › path Parameters

id
​string · minLength: 1 · required

Invite a person to the counter of a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Invite a person to the counter of a pickup point › Request Body

email
​string · email · maxLength: 254 · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
full_name
​string · minLength: 1 · maxLength: 120 · required

Invite a person to the counter of a pickup point › Responses

The invited person.

user_id
​string · required
full_name
​string · required
email
​string · required
status
​string · enum · required
Enum values:
invited
active
invited_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
last_seen_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Remove a person from the counter of a pickup point

DELETE
https://api.shipping.nc
/v1/admin/relay-points/{id}/staff/{userId}

Remove a person from the counter of a pickup point › path Parameters

id
​string · minLength: 1 · required
userId
​string · minLength: 1 · required

Remove a person from the counter of a pickup point › Headers

x-correlation-id
​string · maxLength: 128

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

Remove a person from the counter of a pickup point › Responses

Removed; their sign-in is disabled.

No data returned

List the merchants

GET
https://api.shipping.nc
/v1/admin/merchants

List the merchants › Headers

x-correlation-id
​string · maxLength: 128

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

List the merchants › Responses

Every merchant of the aggregator API, newest first.

​object[] · required

Newest first.


Create a merchant

POST
https://api.shipping.nc
/v1/admin/merchants

A business that ships through the aggregator API, whatever the carrier. It has no key until one is issued. Platform admins only.

Create a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Create a merchant › Request Body

name
​string · minLength: 1 · maxLength: 120 · required
contact_email
​string · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required

Create a merchant › Responses

The merchant, active at once.

id
​string · required
name
​string · required
contact_email
​string · required
status
​string · enum · required
Enum values:
active
suspended
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Get a merchant

GET
https://api.shipping.nc
/v1/admin/merchants/{id}

Get a merchant › path Parameters

id
​string · minLength: 1 · required

Get a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Get a merchant › Responses

The merchant.

id
​string · required
name
​string · required
contact_email
​string · required
status
​string · enum · required
Enum values:
active
suspended
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

List the API keys of a merchant

GET
https://api.shipping.nc
/v1/admin/merchants/{id}/api-keys

List the API keys of a merchant › path Parameters

id
​string · minLength: 1 · required

List the API keys of a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

List the API keys of a merchant › Responses

The keys, newest first, revoked ones included.

​object[] · required

Newest first, revoked keys included.


Issue an API key to a merchant

POST
https://api.shipping.nc
/v1/admin/merchants/{id}/api-keys

A test key reaches the sandbox carrier only; a live key books the real carriers. Platform admins only.

Issue an API key to a merchant › path Parameters

id
​string · minLength: 1 · required

Issue an API key to a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Issue an API key to a merchant › Request Body

name
​string · minLength: 1 · maxLength: 60 · required

Unique among the active keys of the merchant.

Example: Site de production
mode
​string · enum · required

test reaches the sandbox carrier only, live the real carriers.

Enum values:
test
live

Issue an API key to a merchant › Responses

The key, with its secret shown this once.

id
​string · required
mode
​string · enum · required
Enum values:
test
live
name
​string · required
prefix
​string · required

The start of the secret, to tell keys apart.

Example: mk_live_Xb3q
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
last_used_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
revoked_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
secret
​string · required

The key itself, shown this once: only its hash is kept. Hand it to the merchant over a safe channel.


Revoke an API key of a merchant

POST
https://api.shipping.nc
/v1/admin/merchants/{id}/api-keys/{keyId}/revoke

The key stops working at once. Revoking it again changes nothing.

Revoke an API key of a merchant › path Parameters

id
​string · minLength: 1 · required
keyId
​string · minLength: 1 · required

Revoke an API key of a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Revoke an API key of a merchant › Responses

The key, now revoked.

id
​string · required
mode
​string · enum · required
Enum values:
test
live
name
​string · required
prefix
​string · required

The start of the secret, to tell keys apart.

Example: mk_live_Xb3q
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
last_used_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
revoked_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

List the webhook endpoints of a merchant

GET
https://api.shipping.nc
/v1/admin/merchants/{id}/webhook-endpoints

List the webhook endpoints of a merchant › path Parameters

id
​string · minLength: 1 · required

List the webhook endpoints of a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

List the webhook endpoints of a merchant › Responses

The endpoints of both modes, newest first.

​object[] · required

Newest first, both modes.


Register a webhook endpoint for a merchant

POST
https://api.shipping.nc
/v1/admin/merchants/{id}/webhook-endpoints

A test endpoint receives the sandbox shipments of the merchant, a live one its live shipments. Hand the secret to the merchant over a safe channel. Platform admins only.

Register a webhook endpoint for a merchant › path Parameters

id
​string · minLength: 1 · required

Register a webhook endpoint for a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Register a webhook endpoint for a merchant › Request Body

url
​string · uri · maxLength: 2048 · required

An https URL on a public host name. Addresses that resolve to a private, loopback or link-local network are refused when the event is sent.

Example: https://shop.example.nc/hooks/shipping
event_types
​string[] · minItems: 1 · maxItems: 4 · required
Enum values:
shipment.created
shipment.status_changed
shipment.delivered
shipment.delivery_failed
mode
​string · enum · required

test: the endpoint receives the sandbox shipments. live: the live shipments.

Enum values:
test
live
description
​string · maxLength: 200

Register a webhook endpoint for a merchant › Responses

The endpoint, with its signing secret shown this once.

id
​string · required
url
​string · required
description
​string | null · required
status
​string · enum · required
Enum values:
enabled
disabled
disabled_reason
​string | null · enum · required

manual: someone disabled it. failing: every attempt failed for a day, so it was disabled.

Enum values:
manual
failing
secret_prefix
​string · required

The first characters of the signing secret, to recognise it.

Example: whsec_Q2vN
failure_streak
​integer · min: 0 · max: 9007199254740991 · required

Attempts that failed in a row since the last success.

failing_since
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
event_types
​string[] · required
Enum values:
shipment.created
shipment.status_changed
shipment.delivered
shipment.delivery_failed
mode
​string · enum · required

test: receives the sandbox shipments. live: receives the live shipments.

Enum values:
test
live
secret
​string · required

The signing secret, shown once. Use it to check the Shipping-Nc-Signature header of each delivery.

Example: whsec_Q2vN0cXyRk4mWb9TzL1pQe6sAfJd3uGh8iKo5aB7cD9

Change a webhook endpoint of a merchant

PATCH
https://api.shipping.nc
/v1/admin/merchants/{id}/webhook-endpoints/{endpointId}

Disabling an endpoint gives up its pending deliveries. Platform admins only.

Change a webhook endpoint of a merchant › path Parameters

id
​string · minLength: 1 · required
endpointId
​string · minLength: 1 · required

Change a webhook endpoint of a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Change a webhook endpoint of a merchant › Request Body

url
​string · uri · maxLength: 2048

An https URL on a public host name. Addresses that resolve to a private, loopback or link-local network are refused when the event is sent.

Example: https://shop.example.nc/hooks/shipping
description
​string | null · maxLength: 200
event_types
​string[] · minItems: 1 · maxItems: 4
Enum values:
shipment.created
shipment.status_changed
shipment.delivered
shipment.delivery_failed
status
​string · enum

Enabling an endpoint again clears its failure count.

Enum values:
enabled
disabled

Change a webhook endpoint of a merchant › Responses

The endpoint.

id
​string · required
url
​string · required
description
​string | null · required
status
​string · enum · required
Enum values:
enabled
disabled
disabled_reason
​string | null · enum · required

manual: someone disabled it. failing: every attempt failed for a day, so it was disabled.

Enum values:
manual
failing
secret_prefix
​string · required

The first characters of the signing secret, to recognise it.

Example: whsec_Q2vN
failure_streak
​integer · min: 0 · max: 9007199254740991 · required

Attempts that failed in a row since the last success.

failing_since
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
updated_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
event_types
​string[] · required
Enum values:
shipment.created
shipment.status_changed
shipment.delivered
shipment.delivery_failed
mode
​string · enum · required

test: receives the sandbox shipments. live: receives the live shipments.

Enum values:
test
live

Delete a webhook endpoint of a merchant

DELETE
https://api.shipping.nc
/v1/admin/merchants/{id}/webhook-endpoints/{endpointId}

Platform admins only.

Delete a webhook endpoint of a merchant › path Parameters

id
​string · minLength: 1 · required
endpointId
​string · minLength: 1 · required

Delete a webhook endpoint of a merchant › Headers

x-correlation-id
​string · maxLength: 128

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

Delete a webhook endpoint of a merchant › Responses

The endpoint and its delivery log are deleted.

No data returned

List the signup requests

GET
https://api.shipping.nc
/v1/admin/signup-requests

Each request carries the status of its establishment in the RIDET register now. Platform admins only.

List the signup requests › query Parameters

limit
​integer · min: 1 · max: 100

Maximum number of items in the page.

Example: 25
Default: 25
cursor
​string

The next_cursor of the previous page, passed back as is. Omit it to get the first page.

Example: WyIyMDI2LTExLTExVDA4OjQyOjEwLjAwMFoiLCIwYjZmOWMxZS01ZDJhLTRjM2UtOWYxYS03ZTJkOGM0YjZhMTAiXQ
status
​string · enum
Enum values:
pending_review
accepted
refused
Default: pending_review

List the signup requests › Headers

x-correlation-id
​string · maxLength: 128

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

List the signup requests › Responses

One page of a status, most recently submitted first, with the count of each status.

​object[] · required
next_cursor
​string | null · required
​object · required

Get a signup request

GET
https://api.shipping.nc
/v1/admin/signup-requests/{id}

Get a signup request › path Parameters

id
​string · minLength: 1 · required

Get a signup request › Headers

x-correlation-id
​string · maxLength: 128

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

Get a signup request › Responses

The request, the register now, the checks, and a free tracking prefix and subdomain to suggest.

id
​string · required
status
​string · enum · required
Enum values:
pending_verification
pending_review
accepted
refused
company_name
​string · required

The trade name, else the registered name.

legal_name
​string · required
ridet
​string · required
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
commune
​string · required
​object · required
locale
​string · enum · required
Enum values:
fr
en
registry_status
​string · enum · required
Enum values:
active
inactive
unknown
email_verified
​boolean · required
submitted_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the email was verified.

reviewed_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
carrier_id
​string | null · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object | null · required

The establishment as the register shows it now.

​object · required
​object · required
refusal_reason
​string | null · required
reviewed_by
​string | null · required

The name of the staff member who decided.


Accept a signup request

POST
https://api.shipping.nc
/v1/admin/signup-requests/{id}/accept

Creates the carrier from the facts of the request and invites the requester as its first carrier admin. A request already accepted or refused answers 409. Platform admins only.

Accept a signup request › path Parameters

id
​string · required

Accept a signup request › Headers

x-correlation-id
​string · maxLength: 128

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

Accept a signup request › Request Body

tracking_prefix
​string · pattern: ^[A-Z]{2}$ · required
subdomain
​string · minLength: 3 · maxLength: 40 · pattern: ^[a-z0-9]+(-[a-z0-9]… · required

The back-office subdomain, under shipping.nc.

Example: cote-est
plan
​string · enum · required
Enum values:
starter
standard
pro

Accept a signup request › Responses

The created carrier and the accepted request.

id
​string · required
status
​string · enum · required
Enum values:
pending_verification
pending_review
accepted
refused
company_name
​string · required

The trade name, else the registered name.

legal_name
​string · required
ridet
​string · required
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
commune
​string · required
​object · required
locale
​string · enum · required
Enum values:
fr
en
registry_status
​string · enum · required
Enum values:
active
inactive
unknown
email_verified
​boolean · required
submitted_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the email was verified.

reviewed_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
carrier_id
​string | null · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object | null · required

The establishment as the register shows it now.

​object · required
​object · required
refusal_reason
​string | null · required
reviewed_by
​string | null · required

The name of the staff member who decided.


Refuse a signup request

POST
https://api.shipping.nc
/v1/admin/signup-requests/{id}/refuse

Emails the reason to the requester. A request already accepted or refused answers 409.

Refuse a signup request › path Parameters

id
​string · required

Refuse a signup request › Headers

x-correlation-id
​string · maxLength: 128

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

Refuse a signup request › Request Body

reason
​string · minLength: 3 · maxLength: 500 · required

Refuse a signup request › Responses

The refused request.

id
​string · required
status
​string · enum · required
Enum values:
pending_verification
pending_review
accepted
refused
company_name
​string · required

The trade name, else the registered name.

legal_name
​string · required
ridet
​string · required
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
commune
​string · required
​object · required
locale
​string · enum · required
Enum values:
fr
en
registry_status
​string · enum · required
Enum values:
active
inactive
unknown
email_verified
​boolean · required
submitted_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the email was verified.

reviewed_at
​string | null · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
carrier_id
​string | null · required
created_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
​object | null · required

The establishment as the register shows it now.

​object · required
​object · required
refusal_reason
​string | null · required
reviewed_by
​string | null · required

The name of the staff member who decided.


Search the company register

GET
https://api.shipping.nc
/v1/admin/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 new carrier. Allowed to platform 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/admin/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 new carrier. Allowed to platform 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