Customer addresess

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:

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.

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

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.

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.

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

Customer addresess

Purpose and Usage#

Request

Request samples

Responses

Purpose and Usage