shipping.nc API

Carrier settings

Server

Get the carrier profile

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

The legal identity, address, contact and opening hours; null until first saved. Allowed to carrier admins only.

Get the carrier profile › Headers

x-correlation-id
​string · maxLength: 128

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

Get the carrier profile › Responses

The profile, or null.

legal_name
​string · minLength: 1 · maxLength: 160 · required
trade_name
​string · minLength: 1 · maxLength: 80 · required

Shown to recipients and shippers.

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

The business identifier in New Caledonia.

Example: 1234567.001
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
​object · required
headquarters_is_depot
​boolean · required
contact_phone
​string · required

In E.164 format.

Example: +687274518
support_email
​string · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
​array · minItems: 7 · maxItems: 7 · required
closed_on_public_holidays
​boolean · required

Save the carrier profile

PUT
https://api.shipping.nc
/v1/settings/profile

Replaces the whole profile. The trade name is the name recipients see. Allowed to carrier admins only.

Save the carrier profile › Headers

x-correlation-id
​string · maxLength: 128

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

Save the carrier profile › Request Body

legal_name
​string · minLength: 1 · maxLength: 160 · required
trade_name
​string · minLength: 1 · maxLength: 80 · required

Shown to recipients and shippers.

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

The business identifier in New Caledonia.

Example: 1234567.001
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
​object · required
headquarters_is_depot
​boolean · required
contact_phone
​string · required

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

Example: +687 78 12 34
support_email
​string · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
​array · minItems: 7 · maxItems: 7 · required
closed_on_public_holidays
​boolean · required

Save the carrier profile › Responses

The saved profile.

legal_name
​string · minLength: 1 · maxLength: 160 · required
trade_name
​string · minLength: 1 · maxLength: 80 · required

Shown to recipients and shippers.

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

The business identifier in New Caledonia.

Example: 1234567.001
legal_form
​string · enum · required
Enum values:
sarl
sas
eurl
sole_proprietorship
other
​object · required
headquarters_is_depot
​boolean · required
contact_phone
​string · required

In E.164 format.

Example: +687274518
support_email
​string · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
​array · minItems: 7 · maxItems: 7 · required
closed_on_public_holidays
​boolean · required

Get the branding

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

Name, color, logo, sender names and tracking domain, with the verification state of each sender. Allowed to carrier admins only.

Get the branding › Headers

x-correlation-id
​string · maxLength: 128

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

Get the branding › Responses

The branding.

display_name
​string · minLength: 1 · maxLength: 80 · required
primary_color
​string | null · pattern: ^#[0-9a-fA-F]{6}$ · required
logo_url
​string | null · uri · required

Public URL of the logo, or null when none is uploaded.

logo_key
​string | null · required
logo_file_name
​string | null · required

The name the logo was uploaded under, made safe; null when unknown.

Example: logo-coursier.svg
sms_sender_name
​string | null · pattern: ^[A-Za-z0-9]{1,11}$ · required
sms_sender_status
​string · enum · required
Enum values:
not_set
pending
verified
failed
email_sender_name
​string | null · required
email_from_address
​string | null · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
email_domain_status
​string · enum · required
Enum values:
not_set
pending
verified
failed
​object · required

Save the branding

PUT
https://api.shipping.nc
/v1/settings/branding

Pass a logo_key returned by a logo upload to change the logo, or null to remove it. Allowed to carrier admins only.

Save the branding › Headers

x-correlation-id
​string · maxLength: 128

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

Save the branding › Request Body

display_name
​string · minLength: 1 · maxLength: 80 · required
primary_color
​string | null · pattern: ^#[0-9a-fA-F]{6}$ · required
logo_key
​string | null · maxLength: 200 · required

A key returned by the logo upload, or null.

sms_sender_name
​string | null · pattern: ^[A-Za-z0-9]{1,11}$ · required
email_sender_name
​string | null · minLength: 1 · maxLength: 80 · required
email_from_address
​string | null · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
tracking_domain
​string | null · pattern: ^(?=.{1,253}$)([a-z0… · required

Save the branding › Responses

The saved branding.

display_name
​string · minLength: 1 · maxLength: 80 · required
primary_color
​string | null · pattern: ^#[0-9a-fA-F]{6}$ · required
logo_url
​string | null · uri · required

Public URL of the logo, or null when none is uploaded.

logo_key
​string | null · required
logo_file_name
​string | null · required

The name the logo was uploaded under, made safe; null when unknown.

Example: logo-coursier.svg
sms_sender_name
​string | null · pattern: ^[A-Za-z0-9]{1,11}$ · required
sms_sender_status
​string · enum · required
Enum values:
not_set
pending
verified
failed
email_sender_name
​string | null · required
email_from_address
​string | null · email · pattern: ^(?:[A-Za-z0-9_'+\-]… · required
email_domain_status
​string · enum · required
Enum values:
not_set
pending
verified
failed
​object · required

Start a logo upload

POST
https://api.shipping.nc
/v1/settings/branding/logo-uploads

Returns a presigned POST valid ten minutes, limited to the declared type and size. Allowed to carrier admins only.

Start a logo upload › Headers

x-correlation-id
​string · maxLength: 128

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

Start a logo upload › Request Body

content_type
​string · enum · required
Enum values:
image/svg+xml
image/png
size_bytes
​integer · min: 1 · max: 1048576 · required
file_name
​string · minLength: 1 · maxLength: 255

The name of the file chosen, to show it again after a reload.

Example: Logo Coursier.svg

Start a logo upload › Responses

Where to post the file.

logo_key
​string · required

Pass it as logo_key when saving the branding.

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

Get zones and services

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

Every zone and service, served or not, and the delivery attempts before return. Allowed to carrier admins only.

Get zones and services › Headers

x-correlation-id
​string · maxLength: 128

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

Get zones and services › Responses

The coverage.

​object[] · required
​object[] · required
max_delivery_attempts
​integer · min: 1 · max: 3 · required

Save zones and services

PUT
https://api.shipping.nc
/v1/settings/coverage

Zones and services left out keep their settings. Pickup points cannot be switched on before phase 2. Allowed to carrier admins only.

Save zones and services › Headers

x-correlation-id
​string · maxLength: 128

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

Save zones and services › Request Body

​object[] · minItems: 1 · required
​object[] · minItems: 1 · required
max_delivery_attempts
​integer · min: 1 · max: 3 · required

Save zones and services › Responses

The saved coverage.

​object[] · required
​object[] · required
max_delivery_attempts
​integer · min: 1 · max: 3 · required

Get the aggregator opt-in

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

Whether merchants may book the carrier through the aggregator API, which quotes only the carriers that opt in. A new carrier is opted out. Opting out keeps the merchant shipments booked already. Allowed to carrier admins only.

Get the aggregator opt-in › Headers

x-correlation-id
​string · maxLength: 128

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

Get the aggregator opt-in › Responses

The opt-in.

opt_in
​boolean · required

True when merchants may book the carrier through the aggregator API. A carrier that opts out leaves the quotes and takes no new merchant shipment; the ones booked already go on.


Opt in or out of the aggregator

PUT
https://api.shipping.nc
/v1/settings/aggregator

Whether merchants may book the carrier through the aggregator API, which quotes only the carriers that opt in. A new carrier is opted out. Opting out keeps the merchant shipments booked already. Allowed to carrier admins only.

Opt in or out of the aggregator › Headers

x-correlation-id
​string · maxLength: 128

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

Opt in or out of the aggregator › Request Body

opt_in
​boolean · required

True when merchants may book the carrier through the aggregator API. A carrier that opts out leaves the quotes and takes no new merchant shipment; the ones booked already go on.

Opt in or out of the aggregator › Responses

The saved opt-in.

opt_in
​boolean · required

True when merchants may book the carrier through the aggregator API. A carrier that opts out leaves the quotes and takes no new merchant shipment; the ones booked already go on.