GuideAPI reference

Generate a label

Learn about the the label endpoint to generate and return a shipping label for an order that has been registered in the system.

Overview

The label endpoint returns a complete standard shipping label, formats will vary slightly depending on the associated freight product.

The shipment must be registered before the label is available. If registering a shipment (e.g. through the Book a parcel API) and fetching label is done in one action we recommend you verify a successful response from the registration before you make a request to the label API. If registering the parcel is done through file or other formats we recommend a longer latency.

Label Formats

  • Returns shipping labels in multiple formats: PDF, PNG, SVG, ZPL.

  • Standard "unified-large" - labels measure 102 mm x 192mm

  • Barcode format: GS1 128

General notes for API response

The API will response with a file in the specified file format.

  • If shipmentId is specified the response will return a file containing one page pr. item for that shipment

  • If trackingReference is specified the response will return a file containing one page for that item

  • ZPL labels measures 4x9 inches ( 101,6mm x 228,6 mm) in 200dpi

  • Response time for ZPL format is significantly slower than other formats

Custom Labels

We recommend using the standard label endpoint. You can also design the label yourself. Please reach out to us and we can discuss options and guide you through creating a custom label.