[1.23.0] Multiple shipments label download

Owned by anagorski (Unlicensed)
Last updated: Jul 06, 2023 by Michał Machowski
1 min read

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



Authentication

Access to the resource requires a valid access token.



Multiple shipments label download

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

Availability

Parameter

Type

Description

Validation

Default value

Availability

format

String

Label format

Available formats: Pdf, Epl, Zpl 

Pdf

PL, IT

shipment_ids

Array[Integer]

Shipment identifiers





PL, IT

type

String

Label type

Available types: normal, A6



PL, IT

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

 

Response