shipping.nc API

Labels

Server

Print the 10x15 labels of shipments, as PDF or ZPL, and follow which ones are printed.


List shipments to label

GET
https://api.shipping.nc
/v1/shipments/labels/queue

Newest first, cursor paginated, with the sector code each parcel is sorted to. Allowed to carrier admins and dispatchers, and to shipper users for the shipments of their account.

List shipments to label › 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
label
​string · enum

Keep shipments whose label is or is not printed yet.

Enum values:
not_printed
printed
created_from
​

Created at or after this instant, or from the start of this Noumea day.

created_to
​

Created before this instant, or up to the end of this Noumea day.

shipper_account_id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
zone
​string · enum
Enum values:
grand_noumea
brousse_west
brousse_east
loyalty_islands
isle_of_pines
status
​string

Comma-separated shipment statuses to keep.

Example: created

List shipments to label › Headers

x-correlation-id
​string · maxLength: 128

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

List shipments to label › Responses

One page of shipments with their label state.

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

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


Generate labels

POST
https://api.shipping.nc
/v1/shipments/labels

One label per parcel, with the S10 tracking number as a Code 128 barcode and a QR code to the public tracking page. 10x15 is one label per page for thermal printers, A4 four per sheet, zpl the same labels for Zebra-compatible printers. The document is kept in the labels bucket. Allowed to carrier admins and dispatchers, and to shipper users for the shipments of their account.

Generate labels › Headers

x-correlation-id
​string · maxLength: 128

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

Generate labels › Request Body

shipment_ids
​string[] · minItems: 1 · maxItems: 200 · required

Up to 200 shipments.

Example: ["0b6f9c1e-5d2a-4c3e-9f1a-7e2d8c4b6a10"]
format
​string · enum
Enum values:
10x15
A4
zpl
Default: 10x15
sort_by_sector
​boolean

Orders the labels by sector code, so a driver loads them in route order.

Default: true
locale
​string · enum

Language of the label captions.

Enum values:
fr
en
Default: fr

Generate labels › Responses

A short-lived link to the document.

url
​string · required

A short-lived download link of the document.

expires_at
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required
format
​string · enum · required
Enum values:
10x15
A4
zpl
label_count
​integer · max: 9007199254740991 · required

One label per parcel.

Example: 9
shipment_count
​integer · max: 9007199254740991 · required

Mark labels as printed

POST
https://api.shipping.nc
/v1/shipments/labels/printed

Marks the labels already generated in this format; printing again stays possible. Allowed to carrier admins and dispatchers, and to shipper users for the shipments of their account.

Mark labels as printed › Headers

x-correlation-id
​string · maxLength: 128

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

Mark labels as printed › Request Body

shipment_ids
​string[] · minItems: 1 · maxItems: 200 · required

Up to 200 shipments.

Example: ["0b6f9c1e-5d2a-4c3e-9f1a-7e2d8c4b6a10"]
format
​string · enum · required
Enum values:
10x15
A4

Mark labels as printed › Responses

The shipments whose labels are now marked printed.

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