Metoda pro získání minimálních a maximálních hodnot u služeb

Význam a použití

Tento konkrétní endpoint navrací seznam cenových limitů pro jednotlivé služby, které lze využívat v rámci CPL API. Využití najde především v:

Získání seznamu „limitů“ (cenových / hmotnostních / pojišťovacích) pro konkrétní služby
PPL zpravidla poskytuje různé druhy přepravních služeb (např. vnitrostátní balíkovou přepravu, mezinárodní, dobírku, pojištěné zásilky apod.). Každá z těchto služeb může mít jistá omezení, např. maximální částku dobírky nebo maximální hodnotu pojištění.

Konfigurace ve vaší aplikaci
Díky tomuto codelistu může vaše aplikace správně nastavit limity pro nabízené služby. Pokud je například z API zjištěno, že pro službu COD (dobírka) je maximální částka 50 000 Kč, můžete uživateli zabránit zadat vyšší dobírku než je tato hodnota.

Aktualizace
V případě, že se tyto limity v PPL změní (např. navýšení maximální dobírky), integrátor nemusí ručně udržovat tuto informaci. Aplikace si limit automaticky aktualizuje z endpointu.

Request

Query Params

Service

string

optional

kód služby viz GET codelist/service

Currency

string

optional

kód měny viz GET codelist/currency

Country

string

optional

kód země viz GET codelist/country

Product

string

optional

kód typu produktu viz GET codelist/product

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

kód služby viz GET codelist/service

currency

string | null

optional

kód měny viz GET codelist/currency

country

string | null

optional

kód země viz GET codelist/country

product

string | null

optional

kód typu produktu viz GET codelist/product

minPrice

number <double>

optional

minimální povolená cena

maxPrice

number <double>

optional

maximální povolená cena

Example

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

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Metoda pro získání minimálních a maximálních hodnot u služeb

Význam a použití#

Request

Request samples

Responses

Význam a použití