Guides

Getting started

The shipping.nc API lets a carrier or a merchant create shipments, follow them, and show a public tracking view to recipients in New Caledonia.

An online shop that books every carrier through one API starts with Book your first shipment.

Base URL

Every path starts with /v1. The API will answer on https://api.shipping.nc (production) and https://api.demo.shipping.nc (demo); neither domain is live yet.

Correlation IDs

Send an x-correlation-id header with your own request identifier. When you omit it, the API generates one. Every response returns it in the x-correlation-id header: quote it when you contact support.

Pagination

List endpoints return one page at a time:

JSONCode
{ "data": [], "next_cursor": "WyIyMDI2LTExLTExVDA4OjAwOjAwLjAwMFoiLCJhYmMiXQ" }

Pass next_cursor back as the cursor query parameter to get the next page. When next_cursor is null, you have reached the last page. limit defaults to 25 and accepts up to 100.

Amounts

Amounts are in whole XPF, with no decimals. Prices include the TGC, returned separately in tgc_xpf.

Errors

Every error has the same shape:

JSONCode
{ "error": { "code": "validation_error", "message": "The request is invalid", "details": [] } }
Last modified on