Codelist currency

GET

/codelist/currency

Maintainer:Not configured

Purpose and Usage

Returns a list of codes and names for supported currencies (for example, for cash on delivery, insurance, or other shipment-related payments). An application that integrates the CPL API can use this list to determine which currencies PPL supports for its services (e.g., for cash on delivery – Cash on Delivery, or for insurance – Insurance).

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/codelist/currency?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

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

Code

name

string | null

optional

Name

Example

[
    {
        "code": "string",
        "name": "string"
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-07 08:14:37

Codelist country + COD authorization

Method for obtaining the services provided for shipments.

Codelist currency

Purpose and Usage#

Request

Request samples

Responses

Purpose and Usage