CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. Customer
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
  • 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
      GET
    • Customer addresess
      GET
  • 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. Customer

Customer addresess

GET
/customer/address
Customer

Purpose and Usage#

The GET /customer/address method provides an overview of the information recorded in the PPL system for a specific customer. Specifically, it is a list of addresses stored for that customer. This can be used primarily for:
1.
Listing Company/Branch Addresses
The customer (sender) may have a primary headquarters address stored in the PPL system, as well as additional branch offices or warehouses.
This method allows you to determine which addresses the customer has registered, so you can, for example, use them as shipping or billing addresses when submitting shipments.
2.
Automating Address Selection
If a company has multiple locations, an e-shop or warehouse system can retrieve all addresses via the API and then let the user choose from which location the package will be dispatched.
The parameter default: true indicates which of the addresses is set as the default (primary).
3.
Consistent Data
Instead of manually storing addresses (which may change over time), you can directly utilize the data stored in the PPL system.
If the customer (sender) changes their address (e.g., relocates), it will be directly reflected in the API, eliminating the need for manual adjustments in another system.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/customer/address' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'
Response Response Example
200 - Example 1
[
  {
    "code": "string",
    "name": "string",
    "name2": "string",
    "street": "string",
    "city": "string",
    "zipCode": "string",
    "country": "string",
    "default": true
  }
]

Request

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

Responses

🟢200OK
application/json
Success
Headers
X-Correlation-ID
string 
optional
Correlation Id of request otherwise id of response
Body
array of:
code
string  | null 
optional
Short address identifier in the PPL system. It is an internal code that is used when ordering shipments to make it clear which stored address it is.
name
string  | null 
optional
Name
name2
string  | null 
optional
Name2
street
string  | null 
optional
Street
city
string  | null 
optional
City
zipCode
string  | null 
optional
Zip code
country
string  | null 
optional
Country code
default
boolean 
optional
Determines whether the given address is marked as default.
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
🔴503Service Unavailable
Previous
Customer information - permitted currencies
Next
/info
Built with