Codelist country + COD authorization

GET

/codelist/country

Codelist

Purpose and Usage

The codelist/country method provides a list of supported countries with which PPL operates in its system. Typically, you will use this information when creating international shipments or when determining whether cash on delivery is supported in a given country.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Request

Query Params

cashOnDelivery

boolean

optional

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:

cashOnDelivery

boolean

optional

Boolean (true/false) vyjadřující, zda je u dané země podporována služba dobírky (Cash on Delivery).

code

string | null

optional

Krátký kód dané země (CZ, SK, DE, apod.).

name

string | null

optional

Čitelný název země, např. „Česká republika“ . Slouží pro zobrazování uživatelům, např. ve výběru země při vytváření zásilky.

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Codelist externalNumbers

Codelist currency

Codelist country + COD authorization

Purpose and Usage#

Request

Responses

Purpose and Usage