Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This endpoint requires the user to be authenticated. Refer to the documentationĀ here for more information on how to obtain a valid token to use in your request.Ā 

Making a request

The shipment must be registered before the label is available. If registering a shipment (e.g. through the Parcel Booking API ) and fetching label is done in one action we recommend you verify a successful respons from the registration before you make a request to the label API. It's recommended to have at least a 2 second latency if using the booking API (we do not guaranty this will always be enough), and if registrering the parcel is done through file or other formats we recommend a longer latency.

Request header

key

value example

comment

Authorization

Code Block
Bearer $SECRET_WS_TOKEN"

seeĀ Authentication

Content-Type

application/json


Accept

application/pdf
OR
image/svg+xml
OR
application/zpl

label in pdf format
OR
label in svg formatĀ 
OR
label in zpl format

Accept

application/json

warnings/ error messages in json format

...

Info

General notes for API response

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

  • If a 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)

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

...