CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. Codelist
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
  • Codelist
    • Codelist for the beneficiary's age verification service
      GET
    • Codelist product
      GET
    • Codelist externalNumbers
      GET
    • Codelist country + COD authorization
      GET
    • Codelist currency
      GET
    • Method for obtaining the services provided for shipments.
      GET
    • A method for obtaining minimum and maximum values ​​for services
      GET
    • Codelist shipment phase
      GET
    • Codelist status
      GET
    • Codelist of validation messages
      GET
    • Types of personal documents
      GET
  • Customer
    • Customer information - permitted currencies
    • Customer addresess
  • Data
    • Single label print
  • Info
    • /info
  • Order
    • Order tracking
  • OrderBatch
    • Create an order
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
  • ShipmentBatch
    • Shipment creation
    • Used to modify the output format of the label.
    • Getting import state
    • Pick up label
  • ShipmentEvent
    • Shipment cancel
    • Adding informations to shipment
  • VersionInformation
    • News
  1. Codelist

A method for obtaining minimum and maximum values ​​for services

GET
/codelist/servicePriceLimit
Maintainer:Not configured

Purpose and Usage#

This particular endpoint returns a list of pricing limits for the individual services available within the CPL API. Its primary uses include:
Obtaining a List of Limits:
Retrieve the pricing, weight, and insurance limits for specific services. PPL typically offers various types of shipping services (e.g., domestic parcel delivery, international shipments, cash on delivery, insured shipments, etc.). Each of these services may have certain restrictions, such as a maximum cash on delivery amount or a maximum insurance value.
Configuration in Your Application:
With this codelist, your application can correctly configure the limits for the offered services. For example, if the API indicates that the maximum cash on delivery amount (COD) is 50,000 CZK, you can prevent users from entering a cash on delivery amount that exceeds this value.
Updates:
If these limits change within PPL (e.g., an increase in the maximum cash on delivery amount), the integrator does not need to manually maintain this information. The application will automatically update the limits from the endpoint.

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/codelist/servicePriceLimit?Service&Currency&Country&Product&Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers

Body

Example
[
    {
        "service": "string",
        "currency": "string",
        "country": "string",
        "product": "string",
        "minPrice": 0,
        "maxPrice": 0
    }
]
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-07 08:21:54
Previous
Method for obtaining the services provided for shipments.
Next
Codelist shipment phase