Shipment label download
- Former user (Deleted)
- Michał Machowski
On this page
Shipment label download
Shipment label can be downloaded only for already bought shipments -
confirmedor later status.Only users that are the shipments sender can download the label.
For single parcel shipments a single file is returned in the following format .pdf, .epl/.epl2, .zpl,
For multiple parcel shipments a single file is returned in the following format .pdf, .epl, .zpl containing labels for all the parcels
Attention! Choosing EPL format for courier parcels will result in an EPL file, for locker and allegro parcels the format will be EPL2.
GET /v1/shipments/:shipment_id/labelParameters
Parameter | Type | Description | Validation | Default value |
|---|---|---|---|---|
| String | Label format. | Available formats: | |
| String | Label type | Available types:
|
If you do not specify the type parameter, it will return a normal label. The exception is courier services, as there is no type normal, A6 will be returned.
Example requests:
curl "https://api-shipx-pl.easypack24.net/v1/shipments/4257799/label?format=zpl" -X GET -H "Authorization: Bearer token"
Response
File in .pdf/.epl/.epl2/.zpl/.zip format
Error information
Errors that may occur during label download:
label_generation_failed- the label could not be generated, detailed information can be found in themessageand/ordetailsattributes.label_template_not_found- label template could not be found in the system,invalid_action- when trying to download the label for a shipment not yet bought - beforeconfirmedstatus.
Multiple shipments label download
Shipment label can be downloaded only for already bought shipments -
confirmedor later status.Only users that are the shipments sender can download the label.
For single parcel shipments a single file is returned in the following format .pdf, .epl/.epl2, .zpl,
For multiple shipments:
- if shipments are the same service one file containing all shipment labels is returned
- for different services one .zip file containing .epl/.epl2 , .zpl, .pdf files, one for each service is returnedmaximum number of labels downloaded in one request is 100
Attention! Choosing EPL format for courier parcels will result in an EPL file, for locker and allegro parcels the format will be EPL2.
Parameters
Parameter | Type | Description | Validation | Default value |
|---|---|---|---|---|
| String | Label format | Available formats: |
|
| Array[Integer] | Shipment identifiers |
|
|
| String | Label type | Available types:
|
|
Example request
Response
Example request
Response