CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. VersionInformation
  • 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
  • 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
      GET
  1. VersionInformation

News

GET
/versionInformation
VersionInformation

Purpose and usage#

The versionInformation method is used to obtain details about the API versions as well as the new features or changes introduced in each version. This allows the integrator to determine:
What the current (latest) version of the API is.
What changes and new features the given version brings (e.g., added methods, modified parameters, bug fixes).
What the previous versions are and how they differ from the current state.
What planned downtimes and other important information related to (but not limited to) CPL.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/versionInformation?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'
Response Response Example
200 - Example 1
[
  {
    "language": "string",
    "title": "string",
    "description": "string",
    "url": "string",
    "informationType": "string",
    "priority": 0,
    "version": "string",
    "validFrom": "2019-08-24T14:15:22Z",
    "validTo": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z"
  }
]

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:
language
string  | null 
optional
title
string  | null 
optional
description
string  | null 
optional
url
string  | null 
optional
informationType
string  | null 
optional
priority
integer <int32>
optional
version
string  | null 
optional
validFrom
string <date-time> | null 
optional
validTo
string <date-time> | null 
optional
created
string <date-time>
optional
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Previous
Adding informations to shipment
Built with