Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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 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.
On this page
Table of Contents |
---|
Multiple shipments label download
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:organization_id/shipments/labels?format=zpl&shipemntsshipemnt_ids[]=1&shipemntsshipemnt_ids[]=12&shipemntsshipemnt_ids[]=123&shipemntsshipemnt_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
Code Block |
---|
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
Code Block | ||
---|---|---|
| ||
The server will return the .pdf/.epl/.epl2/.zpl/.zip file |
Example request
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
The server will return the .pdf/.epl/.epl2/.zpl/.zip file |