getLabel
The method allows you to download a shipping label (consignment) for a selected shipment.
Input parameters
Output data:
A sample request in PHP:
courier_code | varchar(20) | Courier code |
package_id | int | Shipment ID, optional if package_number was provided |
package_number | varchar(40) | Shipping number (consignment number), optional if package_id was provided |
Output data
The method returns the data in JSON format.
status | varchar(30) | SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code |
extension | varchar(4) | Label file extension (pdf, html, gif, png, epl, zpl, dpl). |
label | text | Label encoded with base64 algorithm. |
Sample
Input data:Output data:
A sample request in PHP: