Get the carrier profile
The legal identity, address, contact and opening hours; null until first saved. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the carrier profile › Responses
The profile, or null.
legal_nametrade_nameShown to recipients and shippers.
ridet^\d{7}\.\d{3}$ · requiredThe business identifier in New Caledonia.
legal_formheadquarters_is_depotcontact_phoneIn E.164 format.
support_email^(?:[A-Za-z0-9_'+\-]… · requiredclosed_on_public_holidaysSave the carrier profile
Replaces the whole profile. The trade name is the name recipients see. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Save the carrier profile › Request Body
legal_nametrade_nameShown to recipients and shippers.
ridet^\d{7}\.\d{3}$ · requiredThe business identifier in New Caledonia.
legal_formheadquarters_is_depotcontact_phoneA phone number. Six digits without a prefix are read as a New Caledonia number (+687).
support_email^(?:[A-Za-z0-9_'+\-]… · requiredclosed_on_public_holidaysSave the carrier profile › Responses
The saved profile.
legal_nametrade_nameShown to recipients and shippers.
ridet^\d{7}\.\d{3}$ · requiredThe business identifier in New Caledonia.
legal_formheadquarters_is_depotcontact_phoneIn E.164 format.
support_email^(?:[A-Za-z0-9_'+\-]… · requiredclosed_on_public_holidaysGet the branding
Name, color, logo, sender names and tracking domain, with the verification state of each sender. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the branding › Responses
The branding.
display_nameprimary_color^#[0-9a-fA-F]{6}$ · requiredlogo_urlPublic URL of the logo, or null when none is uploaded.
logo_keylogo_file_nameThe name the logo was uploaded under, made safe; null when unknown.
sms_sender_name^[A-Za-z0-9]{1,11}$ · requiredsms_sender_statusemail_sender_nameemail_from_address^(?:[A-Za-z0-9_'+\-]… · requiredemail_domain_statusSave the branding
Pass a logo_key returned by a logo upload to change the logo, or null to remove it. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Save the branding › Request Body
display_nameprimary_color^#[0-9a-fA-F]{6}$ · requiredlogo_keyA key returned by the logo upload, or null.
sms_sender_name^[A-Za-z0-9]{1,11}$ · requiredemail_sender_nameemail_from_address^(?:[A-Za-z0-9_'+\-]… · requiredtracking_domain^(?=.{1,253}$)([a-z0… · requiredSave the branding › Responses
The saved branding.
display_nameprimary_color^#[0-9a-fA-F]{6}$ · requiredlogo_urlPublic URL of the logo, or null when none is uploaded.
logo_keylogo_file_nameThe name the logo was uploaded under, made safe; null when unknown.
sms_sender_name^[A-Za-z0-9]{1,11}$ · requiredsms_sender_statusemail_sender_nameemail_from_address^(?:[A-Za-z0-9_'+\-]… · requiredemail_domain_statusStart a logo upload
Returns a presigned POST valid ten minutes, limited to the declared type and size. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Start a logo upload › Request Body
content_typesize_bytesfile_nameThe name of the file chosen, to show it again after a reload.
Start a logo upload › Responses
Where to post the file.
logo_keyPass it as logo_key when saving the branding.
expires_at^(?:(?:\d\d[2468][04… · requiredGet zones and services
Every zone and service, served or not, and the delivery attempts before return. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get zones and services › Responses
The coverage.
max_delivery_attemptsSave zones and services
Zones and services left out keep their settings. Pickup points cannot be switched on before phase 2. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Save zones and services › Request Body
max_delivery_attemptsSave zones and services › Responses
The saved coverage.
max_delivery_attemptsGet the aggregator opt-in
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.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get the aggregator opt-in › Responses
The opt-in.
opt_inTrue 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
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.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Opt in or out of the aggregator › Request Body
opt_inTrue 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_inTrue 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.