Retrieve a parcel document
Retrieve a specific document for a given parcel, and download it in your preferred format and resolution.
labelcustoms-declarationair-waybillproof-of-delivery
proof-of-delivery is retrieved directly from the carrier on request and is only available once the parcel has been delivered. It is only returned in PDF format (application/pdf), and availability depends on the carrier supporting proof of delivery.Authorizations
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Headers
The returned format of the document.
Note: If a label is requested as native ZPL from the carrier it can't be converted to another format and will always be returned in ZPL.
application/pdf, application/zpl, image/png "image/png"
Path Parameters
Identifier of the parcel which you want to retrieve a document from
x >= 11
Document type you want to retrieve.
Note: proof-of-delivery is only available in PDF format (application/pdf) and depends on the carrier supporting proof of delivery.
label, customs-declaration, air-waybill, proof-of-delivery "customs-declaration"
Query Parameters
DPI, or dots per inch, refers to the printing resolution of your shipping labels. Labels must be printed at a high enough resolution to ensure the clarity of address details and the barcode for scanning purposes.
Use the following table to find the appropriate DPI for each file format:
| File format | Default DPI | Valid DPI |
|---|---|---|
| 72 | 72 | |
| png | 300 | 150, 300 |
ZPL labels are not affected by the DPI setting, as the resolution is determined by the carrier itself. Most carriers use a resolution of 203 DPI. Zebra printers need to be configured to print at the specific DPI of the label if they have higher resolution capabilities.
72, 150, 203, 300, 600 x >= 1300
The paper size of the document you would like to retrieve. Paper size can be one of:
- A4
- A5
- A6
Omitting this query parameter leads to the internal paper size of the document being used. Generally this is A6 for labels and A4 for larger documents, like customs documents.
A4, A5, A6 "A4"
Response
Requested parcel document file
The response is of type file.