CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. Codelist
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
  • Codelist
    • Codelist for the beneficiary's age verification service
      GET
    • Codelist product
      GET
    • Codelist externalNumbers
      GET
    • Codelist country + COD authorization
      GET
    • Codelist currency
      GET
    • Method for obtaining the services provided for shipments.
      GET
    • A method for obtaining minimum and maximum values ​​for services
      GET
    • Codelist shipment phase
      GET
    • Codelist status
      GET
    • Codelist of validation messages
      GET
    • Types of personal documents
      GET
  • Customer
    • Customer information - permitted currencies
    • Customer addresess
  • Data
    • Single label print
  • Info
    • /info
  • Order
    • Order tracking
  • OrderBatch
    • Create an order
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
  • ShipmentBatch
    • Shipment creation
    • Used to modify the output format of the label.
    • Getting import state
    • Pick up label
  • ShipmentEvent
    • Shipment cancel
    • Adding informations to shipment
  • VersionInformation
    • News
  1. Codelist

Codelist of validation messages

GET
/codelist/validationMessage
Maintainer:Not configured

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

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/codelist/validationMessage?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers

Body

Example
[
    {
        "message": "string"
    }
]
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-07 08:29:06
Previous
Codelist status
Next
Types of personal documents