CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. Codelist
  • Back to home
  • API Metody
  • AccessPoint
    • Seznam výdejních míst
  • AddressWhisper
    • Našeptávač adres
  • Codelist
    • Číselník pro službu kontroly věku příjemce
      GET
    • Číselník produktů
      GET
    • Číselník typů externích čísel
      GET
    • Číselník zemí + povolení COD
      GET
    • Číselník povolených měn
      GET
    • Metoda pro získání poskytovaných služeb k zásilkám.
      GET
    • Metoda pro získání minimálních a maximálních hodnot u služeb
      GET
    • Fáze zásilky
      GET
    • Statusy zásilky /shipment
      GET
    • Chybové hlášení
      GET
    • Typy osobních dokladů
      GET
  • Customer
    • Informace k zákazníkovi – povolené měny
    • Zákazníkovy adresy
  • Info
    • info
  • Order
    • Získání informace o objednávce přepravy
  • OrderBatch
    • Slouží k vytvoření objednávky. Odpověď je v header (Location)
    • Získaní stavu objednávky
  • OrderEvent
    • Zrušení objednání svozu nebo balíku z libovolné adresy
  • Shipment
    • Slouží k získání informací (trackingu) k zásilce
  • ShipmentBatch
    • Vytvoření zásilky
    • Slouží k úpravě výstupního formátu štítku
    • Získání stavu importu zásilky
    • Získání etikety
  • ShipmentEvent
    • storno zásilky
    • úprava kontaktu
  • VersionInformation
    • informace o novinkách
  1. Codelist

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

GET
/codelist/servicePriceLimit
Codelist
Maintainer:Not configured

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
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
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
Modified at 2025-02-05 12:42:23
Previous
Metoda pro získání poskytovaných služeb k zásilkám.
Next
Fáze zásilky
Built with