Versions Compared

Old Version 6

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

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

Authentication

Access to the resource requires a valid access token.

On this page

Table of Contents

Shipment 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 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

format

String

Label format.

Available formats: Pdf, Zpl, Epl

Pdf

type

String

Label type

Available types:
normal, A6

dpi300 - available only for zpl format and services:

inpost_locker_standard, inpost_locker_allegro, inpost_locker_pass_thru, inpost_letter_allegro, inpost_courier_allegro, inpost_courier_c2c


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.

Multiple shipments 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.

Code Block
languagejson
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

format

String

Label format

Available formats: Pdf, Epl, Zpl 

Pdf

shipment_ids

Array[Integer]

Shipment identifiers

type

String

Label type

Available types:

normal, A6

dpi300 - available only for zpl format and services:

inpost_locker_standard, inpost_locker_allegro, inpost_locker_pass_thru, inpost_letter_allegro, inpost_courier_allegro, inpost_courier_c2c

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
languagejson
The server will return the .pdf/.epl/.epl2/.zpl/.zip file

Example request

Code Block
languagejson
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
languagejson
The server will return the .pdf/.epl/.epl2/.zpl/.zip file