CPL API

Codelist shipment phase

GET

/codelist/shipmentPhase

Codelist

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

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

Code

name

string | null

optional

Name

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

A method for obtaining minimum and maximum values for services

Codelist status