CPL API

Create an order

POST

/order/batch

OrderBatch

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/order/batch' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orders": [
        {
            "orderType": "CollectionOrder",
            "referenceId": "string",
            "shipmentCount": 1,
            "email": "string",
            "note": "string",
            "customerReference": "string",
            "sendDate": "2019-08-24T14:15:22Z",
            "sendTimeFrom": "string",
            "sendTimeTo": "string",
            "productType": "string",
            "sender": {
                "name": "string",
                "name2": "string",
                "street": "string",
                "city": "string",
                "zipCode": "string",
                "country": "string",
                "contact": "string",
                "phone": "string",
                "email": "string"
            },
            "recipient": {
                "name": "string",
                "name2": "string",
                "street": "string",
                "city": "string",
                "zipCode": "string",
                "country": "string",
                "contact": "string",
                "phone": "string",
                "email": "string"
            }
        }
    ]
}'

Response Example

201 - Example 1

{}

Request

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

Body Params application/json

orders

array [object {12}]

required

Orders

>= 1 items

orderType

enum<string>

required

Order Type:
CollectionOrder – pickup order
TransportOrder – package order (Package from any address)

Allowed values:

CollectionOrderTransportOrder

referenceId

string

required

referenceId

>= 1 characters<= 50 characters

shipmentCount

integer <int32>

required

number of packages Max: 50 Délka: 2

>= 1

string | null

optional

Notification email for the customer Length: 2

<= 100 characters

note

string | null

optional

Note length: 50

<= 300 characters

customerReference

string | null

optional

customer reference. length: 9,2

<= 40 characters

sendDate

string <date-time>

required

send date length: 9,2

sendTimeFrom

string <date-span> | null

optional

sendTimeFrom

sendTimeTo

string <date-span> | null

optional

sendTimeTo

productType

string | null

optional

BUSS / IMPO length: 4

sender

optional

recipient

optional

Recipient
If collection ( CollectionOrder )
NOT COMPLETED

Examples

Responses

🟢201Created

application/json

Created

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

Location

string

optional

Newly created entity location

Body

object {0}

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Order tracking

Get order status