CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. Info
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
  • Codelist
    • Codelist for the beneficiary's age verification service
    • Codelist product
    • Codelist externalNumbers
    • Codelist country + COD authorization
    • Codelist currency
    • Method for obtaining the services provided for shipments.
    • A method for obtaining minimum and maximum values ​​for services
    • Codelist shipment phase
    • Codelist status
    • Codelist of validation messages
    • Types of personal documents
  • Customer
    • Customer information - permitted currencies
    • Customer addresess
  • Info
    • /info
      GET
  • 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. Info

/info

GET
/info
Info
Maintainer:Not configured

Purpose and usage#

The info method serves both as a quick check to verify that the API is running and as a provider of additional information (e.g., application version, server time, etc.).
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/info' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'
Response Response Example
200 - Example 1
{
    "version": "string",
    "state": "string",
    "time": "2019-08-24T14:15:22Z",
    "node": "string",
    "application": "string",
    "startTime": "2019-08-24T14:15:22Z"
}

Request

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
Body
version
string  | null 
optional
state
string  | null 
optional
time
string <date-time>
optional
node
string  | null 
optional
application
string  | null 
optional
startTime
string <date-time>
optional
🔵304304
🔴500Server Error
🔴503Service Unavailable
Previous
Customer addresess
Next
Order tracking
Built with