Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Warning!

The resource is available only in the following countries: PL, IT.

  • 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.


On this page

Table of Contents


Authentication

Access to the resource requires a valid access token.



Shipment label download

Code Block
GET /v1/shipments/:shipment_id/label

Parameters

Parameter

Type

Description

Validation

Default value

Availability

format

String

Label format

Available formats: Pdf, Zpl, Epl

Pdf

PL, IT

type

String

Label type

Available types: normal, A6


PL, IT

Info

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:

Code Block
languagejson
curl "https://api-shipx-pl.easypack24.net/v1/shipments/4257799/label?format=zpl" -X GET -H "Authorization: Bearer token"  

Response

Code Block
languagejson
File in .pdf/.epl/.epl2/.zpl/.zip format

Warning

Error information

Errors that may occur during label download:

  • label_generation_failed - the label could not be generated, detailed information can be found in the  message and/or details attributes.

  • 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 - before confirmed status.