Codelist status

Purpose and Usage

The codelist/status method is used to obtain an overview of defined codes and descriptions that, in this case, represent shipment statuses. With this method, you can determine which statuses are present in the PPL system (e.g., "Shipment ready for delivery", "Shipment out for delivery today", "Not delivered – sender’s request"). This code list is primarily useful for:

Displaying Shipment Status in the User Interface

If you need to show the shipment status to a user (or within an administration interface) and want to use the official PPL naming, you can retrieve these names directly from the codelist/status.

Integration and Mapping

In some systems (e.g., an e-shop or ERP), there are already internal order statuses (such as Paid, Shipped, Delivered).

Connecting with PPL requires mapping the PPL codes to your internal codes (if you wish to standardize them).

The codelist/status helps you understand all the possible status variants you may encounter.

Request

Query Params

Limit

integer <int32>

required

>= 1<= 1000

Offset

integer <int32>

required

>= 0

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

X-Paging-Total-Items-Count

string

optional

Total items in result

X-Paging-Offset

string

optional

Paging offset

X-Paging-Limit

string

optional

Page size

Body

array of:

code

string | null

optional

Code

name

string | null

optional

Name

Example

[
    {
        "code": "string",
        "name": "string"
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Codelist status

Purpose and Usage#

Request

Request samples

Responses

Purpose and Usage