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
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the signed-in staff member › Responses
Profile and counters.
user_idemailfull_nameroleCheck a tracking prefix and a subdomain
query Parameters
tracking_prefix^[A-Z]{2}$subdomain^[a-z0-9]+(-[a-z0-9]…The back-office subdomain, under shipping.nc.
Headers
x-correlation-idYour 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.
List carriers
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
qName, RIDET or subdomain.
lifecycleplanregionHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List carriers › Responses
Most recently active first.
next_cursorPass it as cursor to get the next page. null on the last page.
Provision a carrier
Creates the tenant and, when asked, invites its first carrier admin by email. Platform admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Provision a carrier › Request Body
legal_namenameridetaddresscommuneA commune of New Caledonia; case, accents and dashes are ignored.
tracking_prefix^[A-Z]{2}$ · requiredsubdomain^[a-z0-9]+(-[a-z0-9]… · requiredThe back-office subdomain, under shipping.nc.
primary_color^#[0-9a-fA-F]{6}$ · requiredplansend_invitationsms_sender_name^[A-Za-z0-9]{1,11}$Provision a carrier › Responses
The created carrier.
idnamelegal_nameridetaddresscommunesubdomaintracking_prefixprimary_colorsms_sender_nameplanregionlifecyclecontact_namecontact_emailcontact_phonezonescreated_at^(?:(?:\d\d[2468][04… · requiredGet a carrier
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a carrier › Responses
Profile, onboarding, usage, members, devices.
idnamelegal_nameridetaddresscommunesubdomaintracking_prefixprimary_colorsms_sender_nameplanregionlifecyclecontact_namecontact_emailcontact_phonezonescreated_at^(?:(?:\d\d[2468][04… · requiredUpdate a carrier profile
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Update a carrier profile › Request Body
legal_namenameridetaddresscommuneA commune of New Caledonia; case, accents and dashes are ignored.
regionplancontact_namecontact_phoneA phone number. Six digits without a prefix are read as a New Caledonia number (+687).
Update a carrier profile › Responses
The updated carrier.
idnamelegal_nameridetaddresscommunesubdomaintracking_prefixprimary_colorsms_sender_nameplanregionlifecyclecontact_namecontact_emailcontact_phonezonescreated_at^(?:(?:\d\d[2468][04… · requiredSuspend a carrier
The back-office turns read-only for its members; tracking pages stay online.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Suspend a carrier › Responses
Suspended.
Resend the carrier admin invitation
path Parameters
idHeaders
x-correlation-idYour 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.
emailaccept_urlOpen a support session
Time-limited and audited. Write mode is for platform admins only.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Open a support session › Request Body
reasonmodeticketOpen a support session › Responses
The session.
idreferencereasonticketmodeduration_minutesstarted_at^(?:(?:\d\d[2468][04… · requiredexpires_at^(?:(?:\d\d[2468][04… · requiredended_at^(?:(?:\d\d[2468][04… · requiredis_activeList support sessions
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
activecarrier_id^([0-9a-fA-F]{8}-[0-…Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List support sessions › Responses
Most recent first.
next_cursorPass it as cursor to get the next page. null on the last page.
Get a support session
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a support session › Responses
The session.
idreferencereasonticketmodeduration_minutesstarted_at^(?:(?:\d\d[2468][04… · requiredexpires_at^(?:(?:\d\d[2468][04… · requiredended_at^(?:(?:\d\d[2468][04… · requiredis_activeEnd a support session
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
End a support session › Responses
The ended session.
idreferencereasonticketmodeduration_minutesstarted_at^(?:(?:\d\d[2468][04… · requiredexpires_at^(?:(?:\d\d[2468][04… · requiredended_at^(?:(?:\d\d[2468][04… · requiredis_activeSearch shipments across carriers
query Parameters
byqlimitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
Headers
x-correlation-idYour 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.
next_cursorPass it as cursor to get the next page. null on the last page.
Count the team per role
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Count the team per role › Responses
Counts.
allplatform_adminsupportread_onlymfa_missingList the shipping.nc team
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
rolemfa_missingHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the shipping.nc team › Responses
One page of staff members.
next_cursorPass it as cursor to get the next page. null on the last page.
Invite a shipping.nc team member
Creates the staff sign-in (Cognito emails a temporary password). MFA is required at first sign-in.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Invite a shipping.nc team member › Request Body
email^(?:[A-Za-z0-9_'+\-]… · requiredfull_nameroleInvite a shipping.nc team member › Responses
Invited.
user_idChange a team member role
path Parameters
userIdHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Change a team member role › Request Body
roleChange a team member role › Responses
Changed.
Export the audit log as CSV
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
qfrom^(?:(?:\d\d[2468][04…First day, Noumea time, inclusive.
to^(?:(?:\d\d[2468][04…Last day, Noumea time, inclusive.
actor_id^([0-9a-fA-F]{8}-[0-…carrier_id^([0-9a-fA-F]{8}-[0-…actionsupport_session_id^([0-9a-fA-F]{8}-[0-…support_onlyHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Export the audit log as CSV › Responses
Up to 10 000 entries.
List the audit log
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
qfrom^(?:(?:\d\d[2468][04…First day, Noumea time, inclusive.
to^(?:(?:\d\d[2468][04…Last day, Noumea time, inclusive.
actor_id^([0-9a-fA-F]{8}-[0-…carrier_id^([0-9a-fA-F]{8}-[0-…actionsupport_session_id^([0-9a-fA-F]{8}-[0-…support_onlyHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List the audit log › Responses
Most recent first.
next_cursorPass it as cursor to get the next page. null on the last page.
Get SMS and email delivery
query Parameters
periodHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get SMS and email delivery › Responses
The report.
periodsourceGet the stage health
query Parameters
periodHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the stage health › Responses
Metrics and alarms.
periodstagesourceExport a month of usage as CSV
query Parameters
month^\d{4}-(0[1-9]|1[0-2… · requiredThe month, as YYYY-MM.
Headers
x-correlation-idYour 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.
Get a month of usage
query Parameters
month^\d{4}-(0[1-9]|1[0-2… · requiredThe month, as YYYY-MM.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a month of usage › Responses
Per carrier.
monthis_closedGet the platform overview
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the platform overview › Responses
The overview.
first_attempt_delivery_rateAdd a pickup point to the network
The point is active at once. Platform admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Add a pickup point to the network › Request Body
nameaddress_linesOne to four address lines, street first.
communeA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityHow many parcels the shop can hold at once.
postal_code^988\d{2}$hold_daysHow many days a parcel waits for its recipient before it goes back to the carrier.
Add a pickup point to the network › Responses
The created pickup point.
idnameaddress_linespostal_codecommuneA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityhold_daysstatusactive: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.
staff_countcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredGet a pickup point
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a pickup point › Responses
The pickup point and its occupancy.
idnameaddress_linespostal_codecommuneA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityhold_daysstatusactive: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.
staff_countcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredChange a pickup point
Replaces the description of the point. A closed point cannot change. Platform admins only.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Change a pickup point › Request Body
nameaddress_linesOne to four address lines, street first.
communeA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityHow many parcels the shop can hold at once.
postal_code^988\d{2}$hold_daysHow many days a parcel waits for its recipient before it goes back to the carrier.
Change a pickup point › Responses
The changed pickup point.
idnameaddress_linespostal_codecommuneA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityhold_daysstatusactive: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.
staff_countcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredPause a pickup point
The point keeps handing over the parcels it holds, and takes no new one. Platform admins only.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Pause a pickup point › Responses
The pickup point.
idnameaddress_linespostal_codecommuneA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityhold_daysstatusactive: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.
staff_countcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredReopen a pickup point
The point takes new parcels again. Platform admins only.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Reopen a pickup point › Responses
The pickup point.
idnameaddress_linespostal_codecommuneA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityhold_daysstatusactive: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.
staff_countcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredClose a pickup point
The point leaves the network for good, once no parcel is expected or held there. Platform admins only.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Close a pickup point › Responses
The pickup point.
idnameaddress_linespostal_codecommuneA commune of New Caledonia.
A GPS position in decimal degrees (WGS 84).
capacityhold_daysstatusactive: takes new parcels. paused: hands over the parcels it holds but takes no new one. closed: left the network.
staff_countcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredList the counter staff of a pickup point
path Parameters
idHeaders
x-correlation-idYour 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.
Invite a person to the counter of a pickup point
Creates their counter sign-in, and emails them a temporary password. Platform admins only.
path Parameters
idHeaders
x-correlation-idYour 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^(?:[A-Za-z0-9_'+\-]… · requiredfull_nameInvite a person to the counter of a pickup point › Responses
The invited person.
user_idfull_nameemailstatusinvited_at^(?:(?:\d\d[2468][04… · requiredlast_seen_at^(?:(?:\d\d[2468][04… · requiredRemove a person from the counter of a pickup point
path Parameters
iduserIdHeaders
x-correlation-idYour 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.
Create a merchant
A business that ships through the aggregator API, whatever the carrier. It has no key until one is issued. Platform admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Create a merchant › Request Body
namecontact_email^(?:[A-Za-z0-9_'+\-]… · requiredCreate a merchant › Responses
The merchant, active at once.
idnamecontact_emailstatuscreated_at^(?:(?:\d\d[2468][04… · requiredGet a merchant
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a merchant › Responses
The merchant.
idnamecontact_emailstatuscreated_at^(?:(?:\d\d[2468][04… · requiredList the API keys of a merchant
path Parameters
idHeaders
x-correlation-idYour 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.
Newest first, revoked keys included.
Issue an API key to a merchant
A test key reaches the sandbox carrier only; a live key books the real carriers. Platform admins only.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Issue an API key to a merchant › Request Body
nameUnique among the active keys of the merchant.
modetest reaches the sandbox carrier only, live the real carriers.
Issue an API key to a merchant › Responses
The key, with its secret shown this once.
idmodenameprefixThe start of the secret, to tell keys apart.
created_at^(?:(?:\d\d[2468][04… · requiredlast_used_at^(?:(?:\d\d[2468][04… · requiredrevoked_at^(?:(?:\d\d[2468][04… · requiredsecretThe 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
The key stops working at once. Revoking it again changes nothing.
path Parameters
idkeyIdHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Revoke an API key of a merchant › Responses
The key, now revoked.
idmodenameprefixThe start of the secret, to tell keys apart.
created_at^(?:(?:\d\d[2468][04… · requiredlast_used_at^(?:(?:\d\d[2468][04… · requiredrevoked_at^(?:(?:\d\d[2468][04… · requiredList the webhook endpoints of a merchant
path Parameters
idHeaders
x-correlation-idYour 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.
Newest first, both modes.
Register a webhook endpoint for a merchant
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.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Register a webhook endpoint for a merchant › Request Body
urlAn 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.
event_typesmodetest: the endpoint receives the sandbox shipments. live: the live shipments.
descriptionRegister a webhook endpoint for a merchant › Responses
The endpoint, with its signing secret shown this once.
idurldescriptionstatusdisabled_reasonmanual: someone disabled it. failing: every attempt failed for a day, so it was disabled.
secret_prefixThe first characters of the signing secret, to recognise it.
failure_streakAttempts that failed in a row since the last success.
failing_since^(?:(?:\d\d[2468][04… · requiredcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredevent_typesmodetest: receives the sandbox shipments. live: receives the live shipments.
secretThe signing secret, shown once. Use it to check the Shipping-Nc-Signature header of each delivery.
Change a webhook endpoint of a merchant
Disabling an endpoint gives up its pending deliveries. Platform admins only.
path Parameters
idendpointIdHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Change a webhook endpoint of a merchant › Request Body
urlAn 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.
descriptionevent_typesstatusEnabling an endpoint again clears its failure count.
Change a webhook endpoint of a merchant › Responses
The endpoint.
idurldescriptionstatusdisabled_reasonmanual: someone disabled it. failing: every attempt failed for a day, so it was disabled.
secret_prefixThe first characters of the signing secret, to recognise it.
failure_streakAttempts that failed in a row since the last success.
failing_since^(?:(?:\d\d[2468][04… · requiredcreated_at^(?:(?:\d\d[2468][04… · requiredupdated_at^(?:(?:\d\d[2468][04… · requiredevent_typesmodetest: receives the sandbox shipments. live: receives the live shipments.
Delete a webhook endpoint of a merchant
Platform admins only.
path Parameters
idendpointIdHeaders
x-correlation-idYour 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.
List the signup requests
Each request carries the status of its establishment in the RIDET register now. Platform admins only.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
statusHeaders
x-correlation-idYour 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.
next_cursorGet a signup request
path Parameters
idHeaders
x-correlation-idYour 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.
idstatuscompany_nameThe trade name, else the registered name.
legal_nameridetlegal_formcommunelocaleregistry_statusemail_verifiedsubmitted_at^(?:(?:\d\d[2468][04… · requiredWhen the email was verified.
reviewed_at^(?:(?:\d\d[2468][04… · requiredcarrier_idcreated_at^(?:(?:\d\d[2468][04… · requiredThe establishment as the register shows it now.
refusal_reasonreviewed_byThe name of the staff member who decided.
Accept a signup request
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.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Accept a signup request › Request Body
tracking_prefix^[A-Z]{2}$ · requiredsubdomain^[a-z0-9]+(-[a-z0-9]… · requiredThe back-office subdomain, under shipping.nc.
planAccept a signup request › Responses
The created carrier and the accepted request.
idstatuscompany_nameThe trade name, else the registered name.
legal_nameridetlegal_formcommunelocaleregistry_statusemail_verifiedsubmitted_at^(?:(?:\d\d[2468][04… · requiredWhen the email was verified.
reviewed_at^(?:(?:\d\d[2468][04… · requiredcarrier_idcreated_at^(?:(?:\d\d[2468][04… · requiredThe establishment as the register shows it now.
refusal_reasonreviewed_byThe name of the staff member who decided.
Refuse a signup request
Emails the reason to the requester. A request already accepted or refused answers 409.
path Parameters
idHeaders
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Refuse a signup request › Responses
The refused request.
idstatuscompany_nameThe trade name, else the registered name.
legal_nameridetlegal_formcommunelocaleregistry_statusemail_verifiedsubmitted_at^(?:(?:\d\d[2468][04… · requiredWhen the email was verified.
reviewed_at^(?:(?:\d\d[2468][04… · requiredcarrier_idcreated_at^(?:(?:\d\d[2468][04… · requiredThe establishment as the register shows it now.
refusal_reasonreviewed_byThe name of the staff member who decided.
Search the company register
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.
query Parameters
qA company name, trade name or acronym, or the start of a RID or RIDET.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Search the company register › Responses
The matching establishments.
Get an establishment of the company register
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.
path Parameters
ridetThe RIDET: 7 figures, a dot and the 3-figure establishment rank.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get an establishment of the company register › Responses
The establishment.
ridet^\d{7}\.\d{3}$ · requiredThe business identifier in New Caledonia.
legal_nameThe registered name.
trade_nameThe sign of the establishment.
acronymlegal_formlegal_form_labelThe legal form as the register names it.
activityThe NAF activity of the establishment.
communeNull when the establishment is outside New Caledonia.
province