A method for obtaining minimum and maximum values for services

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

Service

string

optional

Service code

Currency

string

optional

Currency code

Country

string

optional

Country code

Product

string

optional

Product code

Limit

integer <int32>

required

>= 1<= 1000

Offset

integer <int32>

required

>= 0

Header Params

Accept-Language

string

optional

Language specification, default language: cs-CZ

X-Correlation-ID

string

optional

Correlation Id of request

X-LogLevel

enum<string>

optional

The forced log level

Allowed values:

TraceDebugInformationWarningErrorCritical

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

X-Paging-Total-Items-Count

string

optional

Total items in result

X-Paging-Offset

string

optional

Paging offset

X-Paging-Limit

string

optional

Page size

Body

array of:

service

string | null

optional

Service code

currency

string | null

optional

Currency code

country

string | null

optional

Country code

product

string | null

optional

Product code

minPrice

number <double>

optional

MinPrice

maxPrice

number <double>

optional

MaxPrice

Example

[
    {
        "service": "string",
        "currency": "string",
        "country": "string",
        "product": "string",
        "minPrice": 0,
        "maxPrice": 0
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

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

Purpose and Usage#

Request

Request samples

Responses

A method for obtaining minimum and maximum values for services

Purpose and Usage