Codelist product

GET

/codelist/product

Codelist

Purpose and Usage

This method is used to retrieve lists of codes and names that are utilized in the CPL API to identify shipping services. In this case, it pertains to the products (i.e., types of shipping) offered by PPL. If you are interested in a detailed description of the products, you can find it in the PPL product terms and conditions.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/codelist/product?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Response Example

200 - Example 1

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

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

internal service/product code (short identifier used when ordering, in forms, in API)

name

string | null

optional

legible text (e.g. description of the type of shipment, official designation of the service)

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Codelist for the beneficiary's age verification service

Codelist externalNumbers

Codelist product

Purpose and Usage#

Request

Responses

Purpose and Usage