Zákazníkovy adresy

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:

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.

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í).

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.

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

Zákazníkovy adresy

Význam a použití#

Request

Request samples

Responses

Význam a použití