On this page
Shipment label can be downloaded only for already bought shipments - confirmed
or 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/label |
Parameters
Parameter | Type | Description | Validation | Default value |
---|---|---|---|---|
| String | Label format. | Available formats: | |
| String | Label type | Available types:
|
If you do not specify the |
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:
|
Shipment label can be downloaded only for already bought shipments - confirmed
or 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 returned
maximum 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.
GET /v1/organizations/:organization_id/shipments/labels?format=zpl&shipemnt_ids[]=1&shipemnt_ids[]=12&shipemnt_ids[]=123&shipemnt_ids[]=1234 |
Parameters
Parameter | Type | Description | Validation | Default value |
---|---|---|---|---|
| String | Label format | Available formats: |
|
| Array[Integer] | Shipment identifiers | ||
| String | Label type | Available types:
|
Example request
curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/labels?shipment_ids[]=4257802&shipment_ids[]=4257803&format=zpl" -H "Content-Type: application/json" -H "Authorization: Bearer token" |
Response
The server will return the .pdf/.epl/.epl2/.zpl/.zip file |
Example request
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/labels -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "type": "A6", "format": "pdf", "shipment_ids": [41938,41937] } |
Response
The server will return the .pdf/.epl/.epl2/.zpl/.zip file |