Print the 10x15 labels of shipments, as PDF or ZPL, and follow which ones are printed.
List shipments to label
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.
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.
labelKeep shipments whose label is or is not printed yet.
created_fromCreated at or after this instant, or from the start of this Noumea day.
created_toCreated before this instant, or up to the end of this Noumea day.
shipper_account_id^([0-9a-fA-F]{8}-[0-…zonestatusComma-separated shipment statuses to keep.
Headers
x-correlation-idYour 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.
next_cursorPass it as cursor to get the next page. null on the last page.
Generate 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.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Generate labels › Request Body
shipment_idsUp to 200 shipments.
formatsort_by_sectorOrders the labels by sector code, so a driver loads them in route order.
localeLanguage of the label captions.
Generate labels › Responses
A short-lived link to the document.
urlA short-lived download link of the document.
expires_at^(?:(?:\d\d[2468][04… · requiredformatlabel_countOne label per parcel.
shipment_countMark labels as 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.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Mark labels as printed › Request Body
shipment_idsUp to 200 shipments.
formatMark labels as printed › Responses
The shipments whose labels are now marked printed.
printed_at^(?:(?:\d\d[2468][04… · requiredshipment_ids