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)
      • Shipment - shipment set items
      • International Shipment with or without COD – Parcels in a Set
      • Multiple shipments in one request
      • Shipment connect
    • FAQ
    • Postman Collection
    • Postman Flows

    Changelog

    06.09.2025 R2509#

    New method "Routing" – transfer of GetCitiesRouting from myAPI. For future use
    Smart2Box products
    Adjustment of removing special characters (images from addresses)
    Adjustment of mandatory fields in the address when sending parcels
    Added information in the shipment method whether the product in the parcel was changed (related to S2BOX)
    Update of shipment set – new option to continuously add/group parcels afterwards
    Extension of the filter in services /codelist/Services with allowImpuit
    Extension of the filter in services /codelist/externalNumber with allowImpuit
    Continuation of customer migration from myAPI to CPL. New method: routing -> GetCitiesRouting from myAPI (this is the first version).

    June 21, 2025 R2506#

    Backend adjustment – it should no longer be possible to experience a several-second delay in the response
    Fixed behavior of special characters in some languages
    Sender mask is now passed into Track and Trace

    February 15, 2025 R2502#

    Adjustments related to German legislation (weight pictogram on the CL label). It is now mandatory to enter the weight for shipments to Germany.
    GET /shipment – new: packNumber route
    New parameters in GET /shipment – Access point remaining storage days + Access point remaining storage hours. accessPointDaysInStorageRemain & accessPointHoursInStorageRemain

    November 18, 2024 R2411#

    Check for creating a shipment destined for PL and support for COD at pickup points – In the country code list, there is a new filter: “show countries that support COD.”
    Added order type (pickup/shipping order) when retrieving the order list.
    Check that the customer has a registered bank account – It is not possible to send COD to CZ if an IBAN is provided.
    New parameter in shipment information – last status.

    September 07, 2024 R2409#

    New method /customer/adresses – possibility to change the label type afterward using PUT shipment.
    Generating custom text/barcode for the customer (so-called Extended Label, EL).
    accessPointDaysInStorage – number of days at the pickup point.

    June 12, 2024 R2406#

    System optimizations.

    March 26, 2024 R2404#

    Option to specify additional insurance for each parcel separately.
    Minor adjustments to “Common Label” – a new “scan me” feature.
    Slovakia now also has the “Common Label” type.
    The output file is named according to the parcel number/batchID.

    January 31, 2024 R2402#

    /shipment/batch
    It is now possible to send shipments to Germany to pickup points of the “PackStation” type (NOTE: the recipient’s Postnummer is required!).
    Adjustments to international labels.
    Routing to PL.
    CPL database optimization.
    /shipment
    lastUpdateDate: indicates when the shipment was last modified and when it received its latest status according to StatusDate.
    /shipment/batch
    It is now possible to specify the product Return Connect Europe.
    /shipment/batch
    The parameter isCompleteLabelRequest is now also available for the ZPL language.

    October 12, 2023 R2310#

    Choice of label type (for supported products) – QR/SmartLabel.
    For international shipments, directInjection has been added.

    September 05, 2023 R2309#

    /order/cancel
    Cancel a created pickup order or a parcel from any address.
    /shipment
    Possibility to log in as a parent entity to retrieve shipments of subordinate customers.
    /shipment
    New type “Dormant” in ShipmentStates – also shows data/unused RETURN shipments.
    /codelist/status
    A new method for possible/expected statuses in /shipment.

    June 22, 2023 R2306#

    Method: /shipment/batch
    It is now possible to generate a CUST reference for each parcel individually (in the case of a set).
    Method: /shipment
    It is now possible to find shipments with the shipmentState of Cancel.
    Method: /customer
    Information about the customer (allowed currencies).
    Method: /codelist/proofOfIdentityType
    Types of ID documents.
    Method: /codelist/country
    A new option "cashOnDelivery": true/false – indicates whether COD is permitted.

    April 18, 2023 R2304#

    New methods
    AddressWhisper – Code list reference.
    servicePriceLimit – Description of limits (COD, additional insurance, etc.).
    validationMessage – Error responses.
    Order – Orders
    order – Create an order (pickup (CollectionOrder) or shipping order (TransportOrder)).
    order/batch – Check the creation status of an order.
    Method: AccessPoint
    New parameters:
    tribalServicePoint – main PPL ParcelShop.
    pickupEnabled – indicates whether parcel drop-off is possible.
    activeCashPayment – indicates whether cash payment is accepted.
    capacitySettings – contains size, length, height, width.

    October 22, 2022 R2210#

    Check and validate the ZIP code on input.
    New flag type: QR – the customer sends a Return-type shipment labeled as QR.
    Modified at 2025-09-09 13:01:37
    Previous
    Creation of orders and shipments
    Next
    Authentication