CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. AddressWhisper
  • Back to home
  • API Metody
  • AccessPoint
    • Seznam výdejních míst
  • AddressWhisper
    • Našeptávač adres
      GET
  • Codelist
    • Číselník pro službu kontroly věku příjemce
    • Číselník produktů
    • Číselník typů externích čísel
    • Číselník zemí + povolení COD
    • Číselník povolených měn
    • Metoda pro získání poskytovaných služeb k zásilkám.
    • Metoda pro získání minimálních a maximálních hodnot u služeb
    • Fáze zásilky
    • Statusy zásilky /shipment
    • Chybové hlášení
    • Typy osobních dokladů
  • 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. AddressWhisper

Našeptávač adres

GET
/addressWhisper
AddressWhisper
Maintainer:Not configured

Význam a použití#

Poskytuje tzv. „našeptávání“ (autocomplete) adres uživatelům či aplikacím. Když uživatel začne do formuláře psát (např. název ulice, město, PSČ atd.), metoda vrací seznam možných relevantních adres či jejich částí. Používá se především k:
Urychlení zadávání adres při vytváření zásilky.
Zajištění správnosti (validity) a formátu adresy před jejím odesláním do systému PPL.
Minimalizace chyb při ručním psaní adres.

Request

Query Params
Street
string 
optional
Ulice
ZipCode
string 
optional
PSČ
City
string 
optional
Město
CalledFrom
enum<string> 
optional
Našeptávání z Ulice/PSČ/Město
Allowed values:
StreetZipCodeCity
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 '/addressWhisper?Street&ZipCode&City&CalledFrom' \
--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
Body
array of:
city
string  | null 
optional
Město
place
string  | null 
optional
Místo
street
string  | null 
optional
Ulice
houseNumber
string  | null 
optional
Číslo domu
referenceNumber
string  | null 
optional
referenceNumberChar
string  | null 
optional
evidenceNumber
boolean 
optional
Označ true pokud je číslo domu podtypem evidenčního čísla
zipCode
string  | null 
optional
PSČ
admCode
string  | null 
optional
valid
boolean 
read-onlyoptional
Validní adresa
fullStreet
string  | null 
read-onlyoptional
Adresa ulice
Example
[
  {
    "city": "string",
    "place": "string",
    "street": "string",
    "houseNumber": "string",
    "referenceNumber": "string",
    "referenceNumberChar": "string",
    "evidenceNumber": true,
    "zipCode": "string",
    "admCode": "string",
    "valid": true,
    "fullStreet": "string"
  }
]
🔵304304
🟠400Bad Request
🟠405405
🔴500Server Error
🔴503Service Unavailable
Previous
AddressWhisper
Next
Codelist
Built with