CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. Customer
  • 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
    • Čí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
      GET
    • Zákazníkovy adresy
      GET
  • 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. Customer

Zákazníkovy adresy

GET
/customer/address
Customer
Maintainer:Not configured

Význam a použití#

Metoda GET /customer/address poskytuje přehled informací, které jsou v systému PPL evidovány ke konkrétnímu zákazníkovi. Zde jde konkrétně o seznam adres, které jsou u zákazníka uloženy. To lze využít především pro:
1.
Výpis firemních/pobočkových adres
Zákazník (odesílatel) může mít v systému PPL uloženou primární adresu sídla, ale také další pobočky či sklady.
Tato metoda umožňuje zjistit, jaké adresy má zákazník zaregistrované, abyste je mohli například použít jako odesílací nebo fakturační adresy při podávání zásilek.
2.
Automatizace výběru adresy
Pokud má společnost více provozoven, může si e-shop nebo skladový systém vytáhnout z API všechny adresy a poté nechat uživatele vybrat, odkud balík odchází.
Parametr default: true ukazuje, která z adres je nastavená jako výchozí (hlavní).
3.
Konzistentní data
Místo ručního ukládání adres (které se mohou časem změnit), využijete přímo údaje uložené u PPL.
Pokud zákazník (odesílatel) adresu změní (např. přestěhuje se), projeví se to přímo v API, a není nutné dělat ruční úpravy v dalším systému.

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

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 '/customer/address' \
--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:
code
string  | null 
optional
Krátký identifikátor adresy v systému PPL. Je to interní kód, který se používá při objednávání zásilek, aby bylo jasné, o kterou uloženou adresu se jedná.
name
string  | null 
optional
Jméno
name2
string  | null 
optional
street
string  | null 
optional
Ulice a popisné/orientační číslo.
city
string  | null 
optional
Město
zipCode
string  | null 
optional
PSČ
country
string  | null 
optional
kód země viz codelist/country
default
boolean 
optional
Určuje, zda je daná adresa označena jako výchozí.
Example
[
  {
    "code": "string",
    "name": "string",
    "name2": "string",
    "street": "string",
    "city": "string",
    "zipCode": "string",
    "country": "string",
    "default": true
  }
]
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
🔴503Service Unavailable
Previous
Informace k zákazníkovi – povolené měny
Next
Info
Built with