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
  • 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 externalNumbers

GET
/codelist/externalNumber
Codelist

Purpose and Usage#

This method is used to retrieve lists of codes and names that are used in the CPL API to identify external numbers. External numbers serve as external identifiers for customers—such as an order number or a product code. Most commonly, the code CUST is used for customer identification. This number is subsequently printed directly on the label and is also entered into the customer's invoice.
It is primarily used for:
1.
External References
In logistics processes, it is common for the sender or e-shop to use their own identifiers (e.g., order number, invoice number, client number, etc.).
PPL may then need to indicate which type of external number the provided data relates to.
The codelist/externalNumbers method provides the supported codes for these types of numeric or alphanumeric references, ensuring they are correctly recorded in the system.
2.
System Integration
If there are multiple types of numbers/IDs, PPL wants to know which one the e-shop or sender provides.
This way, the correct code can be selected when creating a shipment record.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/codelist/externalNumber?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'
Response Response Example
200 - Example 1
[
  {
    "code": "string",
    "name": "string",
    "allowInput": true
  }
]

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 code of external number (short identifier used when ordering, in forms, in API)
name
string  | null 
optional
readable text (description of the type of external number)
allowInput
boolean 
optional
AllowInput
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Previous
Codelist product
Next
Codelist country + COD authorization
Built with