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
Query Params
Header Params
Request 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/externalNumber?Limit&Offset' \
--header'Accept-Language;' \
--header'X-Correlation-ID;' \
--header'X-LogLevel;'
