Return label download
- Former user (Deleted)
- Michał Machowski
Return label generation is available only for courier services (excluding allegro).
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
On this page
Return label download
GET /v1/organizations/:organization_id/shipments/return_labelsParameters
Parameter | Type | Description | Validation | Default value |
|---|---|---|---|---|
|
| Label format | Available formats: |
|
|
| Shipment identifiers |
Example request
curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/return_labels?shipment_ids[]=4257802&shipment_ids[]=4257803&format=zpl" -H 'Authorization: Bearer token' -H 'Content-Type: application/json'Response
file with one of the following formats is returned: .pdf/.epl/.epl2/.zpl/.zipError information
Errors that may occur during return 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.