API

API endpoints > labels > get

Check if the previously started label create process has finished. This can result in 3 different responses:

  • You receive an error code, which means that no label was created for the reason given in the error.
  • You receive a CallbakUrl, and Finished is not 100. This means that the process is still ongoing and you have to recheck again after (at least) 1 second.
  • You receive Finished as 100 and there is a LabelPDF. This means that the process was finished and there is a label available.

During label creation, the Finished counter will count up to 100%, and no other attributes will be given except ofcourse the CallbackUrl.

If a shipment was not pre-alerted to the carrier, this pre-alert will be attempted. If that fails, an error code will be returned including information what was wrong.
Before attempting to create the label again, first solve the issue with that shipment.

JSON data structure

No data is expected for this operation.

JSON reply data

  • CallbackURLurlMinimum length: 1, maximum length: 100The URL for your poll/callback while the process is running
  • CustomsInvoiceStringIf needed, this will have the customs invoices needed for your shipments. Only here for backward compatibility, will be removed in future releases.
  • CustomsInvoicePDFbase64 endoded dataBase64 encoded PDF containing the customs invoice pdf if available.
  • FinishedInteger numberAlways returnedMaximum value: 100The percentage ready
  • LabelFileStringIf finished, this will have a url to the created labels. The data in the file depends on the FileType option in the request. Only here for backward compatibility, will be removed in future releases.
  • LabelPDFbase64 endoded dataBase64 encoded PDF containing the requested labels for which there was no error found.
  • LabelZPLbase64 endoded dataBase64 encoded ZPL labels for which there was no error found.
  • ClientReferenceCodeListsublistAlways returnedMinimum items/keys: 1, maximum items/keys: 50A listing of the results per shipment, only available when all shipments are processed.
    • ReferenceCodeStringAlways returnedMinimum length: 1, maximum length: 100A reference code to identify your shipment
    • ShopItemIdStringIf available, the litteral ID of the shipment or order in the e-commerce platform as is given when the shipment was entered via the e-commerce plugin.
    • TrackingIdStringMaximum length: 60The tracking id of the shipment/order, if available
    • TrackingUrlStringMaximum length: 100The correct url for redirecting to the tracking page, this is usually for the recipient.
    • ErrorsublistAlways returnedAny error will be reported here, see the error list for error codes and their meaning.
      • IdInteger numberAlways returnedMaximum value: 999The id of the error
      • InfoStringTextual error
  • ErrorsublistAlways returnedAny error will be reported here, see the error list for error codes and their meaning.
    • IdInteger numberAlways returnedMaximum value: 999The id of the error
    • InfoStringTextual error

GET/labels/:runid
POST/labels/