CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  • Introduction
  • General
  • Creation of orders and shipments
  • Changelog
  • Authentication
    • Getting Bearer token
  • API Methods
  • Examples
    • Response - pick up labels (PDF A4)
    • Response - pickup label (ZPL)
    • Response - pick up label (JPG)
  • FAQ

Creation of orders and shipments

Shipments#

The core functionality of the CPL API revolves around shipments. A shipment must first be created using POST shipment/batch. You can then print a label, modify the label, or retrieve the shipment status. After obtaining the status of a shipment (GET shipment/batch/{batchID}), you can retrieve shipment information, add additional details to the shipment, or cancel the shipment. You can also print the shipment label using the URL contained in the response body.
diagram_EN.png

Orders#

Another CPL API function is creating orders. An order must first be created using POST order/batch. You can then retrieve the order status, get additional order information, or cancel the order. An order can be created either as a Pickup (Collection) Order or as an Order from Any Address.
diagram_order_EN.png

Pickup (Collection) Order#

Description:
A standard service in which PPL picks up shipments from the sender’s registered address. This address is typically linked to the customer’s account (e.g., a company headquarters, warehouse, or default location).
Usage:
Suitable for regular shippers who send shipments from a single specific location.
Process:
A pickup time window is scheduled (e.g., afternoon hours).
A driver arrives at the known address and collects the shipments.
Flexibility:
Limited to one registered address.
Typical Scenario:
A company sending a larger number of shipments daily needs a pickup from an office or warehouse.
JSON Definition:
In the JSON body of the order/batch method, define "orderType": "CollectionOrder"

Order from Any Address#

Description:
An extended service that allows PPL to pick up a shipment from any address provided by the customer.
Usage:
Ideal for customers who do not have a fixed shipping location (e.g., individuals, small businesses).
Also useful for one-off shipments from addresses other than the company headquarters.
Process:
When placing the order, the customer specifies the address where the shipment is located, and the driver collects it there.
Flexibility:
You can specify different addresses with each order.
Useful if shipments are sent from various locations rather than a single site.
Typical Scenario:
A shipment is sent directly from the sender’s home or from wherever the package was prepared (e.g., manufacturer, third party).
JSON Definition:
In the JSON body of the order/batch method, define "orderType": "TransportOrder".

Main differences#

ParameterPickup orderOrder from any address
Pickup locationRegistered addressAny address specified when ordering
FlexibilityFixed addressVariable address
Customer typeRegular shippersOccasional or irregular shippers
UsageRecurring shipmentsOne-time or ad-hoc shipments
Definition in JSONCollectionOrderTransportOrder
Modified at 2025-02-06 08:58:28
Previous
General
Next
Changelog
Built with