CPL API

Shipment cancel

POST

/shipment/{shipmentNumber}/cancel

ShipmentEvent

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/shipment//cancel' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Response Example

200 - Example 1

{}

Request

Path Params

shipmentNumber

string

required

>= 1 characters

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

Body

object {0}

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-07 13:57:49

Pick up label

Adding informations to shipment