General

The Create package label web service (hereinafter “CPL,” also referred to as “CPL2”) is intended for customers and partners of PPL CZ s.r.o. (hereinafter “PPL”), who need to exchange data bidirectionally between their information system and PPL’s information system via this service.

Integrating the CPL API into corporate processes helps simplify logistics operations, reduces administrative burdens, and improves the overall user experience for both senders and end customers.

CPL is accessible over the internet using a secure protocol.

It provides a set of methods enabling the exchange of data about shipments, shipment statuses, and pickup (collection) orders. It also provides an always up-to-date list of Parcelshops and a large number of code lists.

The CPL project is continuously evolving, and new services are regularly added to its set of methods. For this reason, it is essential to always check the most current version of this documentation, or to monitor updates via the relevant CPL method.

We recommend that you first visit the “how to get started” pages, which will guide you in the right direction.

This is an asynchronous REST API.

To use it, you must meet the following requirements:

Access must be via the secure HTTPS protocol.

Authentication must use HTTP Bearer authentication.

To obtain access for finalized/approved solutions, please contact your sales representative.

If you are interested in becoming an approved integrator, please contact ithelp@ppl.cz.

Limitations

Maximum number of shipments per request: 1,000

Maximum number of parcels per address: 20 in one request

The validity of the batchID for label retrieval is a maximum of 30 days

The maximum number of requests for generating tokens is 12 requests/minute

The minimum interval between sending two consecutive requests is 40 ms

Labels

The minimum label size, if the customer prints on separate labels (e.g., thermal labels), is:

For shipments within CZ: 127×110 mm

For international shipments: 150×100 mm
(see the products and countries code list)
An alternative is to print labels on A4 paper (4 labels per page).

Integration

Integration/Authentication follows the OAuth 2.0 standard. See:

OAuth on Wikipedia (in Czech)
OAuth official site
Swagger: (GET) https://api.dhl.com/ecs/ppl/myapi2/swagger/v1/swagger.json

The generated token is valid for 30 minutes – please use the entire validity period and do not generate a new token for each request.

Access token URL: https://api.dhl.com/ecs/ppl/myapi2/login/getAccessToken
Grant type: Client credentials
Client ID: individual
Client secret: individual
Scope: myapi2

Production environment: https://api.dhl.com/ecs/ppl/myapi2
Testing environment: https://api-dev.dhl.com/ecs/ppl/myapi2

Development and Testing

We will provide you with access to the testing environment for development and testing. This is a separate environment with a separate database where real shipping orders are not processed, but it behaves the same as the production environment. Response times in the testing environment may be slower than in production.

Sandbox

The Sandbox is an additional testing environment that allows developers and integrators to safely and risk‑free develop, test, and debug their integration with the CPL API. In the Sandbox, you can verify label generation functionality, retrieve shipment information, and perform other integration steps without actually creating and dispatching a shipment. This helps reveal and fix errors before going live.

Access the Sandbox at https://sandbox.ppl.cz/. Support will grant you access credentials along with your main login details. Once logged in to the Sandbox, authentication via a bearer token is performed automatically. Therefore, there is no need for separate authentication calls to individual methods. After the token expires, you will need to refresh the page to load a new token.

Limitations#

Labels#

Integration#

Development and Testing#

Sandbox#

Limitations

Labels

Integration

Development and Testing

Sandbox