CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. AddressWhisper
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
      GET
  • Codelist
    • Codelist for the beneficiary's age verification service
    • Codelist product
    • Codelist externalNumbers
    • Codelist country + COD authorization
    • Codelist currency
    • Method for obtaining the services provided for shipments.
    • A method for obtaining minimum and maximum values ​​for services
    • Codelist shipment phase
    • Codelist status
    • Codelist of validation messages
    • Types of personal documents
  • 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. AddressWhisper

Address Whisperer

GET
/addressWhisper
Maintainer:Not configured

Purpose and Usage#

Provides address "autocomplete" for users or applications. When a user begins typing into a form (e.g., street name, city, postal code, etc.), the method returns a list of possible relevant addresses or their components. It is primarily used for:
Accelerating address entry when creating a shipment.
Ensuring the accuracy (validity) and proper formatting of an address before it is submitted to the PPL system.
Minimizing errors during manual address entry.

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 '/addressWhisper?Street&ZipCode&City&CalledFrom' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers

Body

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
Modified at 2025-02-07 07:45:12
Previous
List of access points
Next
Codelist for the beneficiary's age verification service