CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. ShipmentEvent
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
  • Codelist
    • Codelist for the beneficiary's age verification service
    • Codelist product
    • Codelist externalNumbers
    • Codelist country + COD authorization
    • Codelist currency
    • Method for obtaining the services provided for shipments.
    • A method for obtaining minimum and maximum values ​​for services
    • Codelist shipment phase
    • Codelist status
    • Codelist of validation messages
    • Types of personal documents
  • Customer
    • Customer information - permitted currencies
    • Customer addresess
  • Info
    • /info
  • Order
    • Order tracking
  • OrderBatch
    • Create an order
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
  • ShipmentBatch
    • Shipment creation
    • Used to modify the output format of the label.
    • Getting import state
    • Pick up label
  • ShipmentEvent
    • Shipment cancel
      POST
    • Adding informations to shipment
      POST
  • VersionInformation
    • News
  1. ShipmentEvent

Shipment cancel

POST
/shipment/{shipmentNumber}/cancel
ShipmentEvent
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/shipment//cancel' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'
Response Response Example
202 - 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

🟢202Accepted
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
Previous
Pick up label
Next
Adding informations to shipment
Built with