API

API endpoints > labels

The label endpoint can generate labels for your shipments.
This is done by POST-ing the shipment reference to the endpoint. Checking if the label is ready can be accomplished in 2 ways: either by polling at a minimum of 1 second intervals or setting a webhook for the label finished event.
Either way, you will end up GET-ing information from this endpoint, which at some point will report it's ready and return either a label or an error.

Most errors will be a result of a shipment not being accepted by the carrier for whatever reason. This error will be returned and also added to the shipment status list.
If the label creation was a success, the label data is delivered to you in 2 ways: directly as a base64 encoded datablob in the reply plus a URL where you can download that same label.

Notes

  • It is possible to re-request a label for an already pre-alerted shipment, the procedure and data is exactly the same.
  • The amount of labels to be created in one request is limited to 1. Only for special operations can this be changed.
  • The standard concurrent label requests that can run at any one time is limited to 1 process. As long as there is a process running, no second POST is allowed.
  • If for any reason the process might crash, then the running process counter is automatically reset after 5 minutes, so no action has to be taken in that instance.
GET/labels/:runid
POST/labels/