Codelist of validation messages

Purpose and Usage

This method is used to retrieve a list of validation error messages (or, more generally, validation messages) that can be utilized in communication with the CPL API. It is primarily used so that the application employing the interface knows:

Which error (or warning) codes may occur during calls to other API methods (e.g., when creating a shipment, validating inputs, generating labels, etc.).

The textual representation of a specific error code (typically available in multiple languages, most commonly Czech and English).

The recommended troubleshooting steps or a detailed description of the error (sometimes provided as part of the message, while in other cases the code is intended solely for programmatic handling).

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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:

message

string | null

optional

Gets or sets the message.

Example

[
    {
        "message": "string"
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Codelist of validation messages

Purpose and Usage#

Request

Request samples

Responses

Purpose and Usage