Order cancel

POST

/order/cancel

OrderEvent

Maintainer:Not configured

Purpose and usage

The POST order/cancel method is used to cancel a specific pickup order or package order from any address. A specific identifier—either customerReference or orderReference—is used to determine which order is being cancelled.

Request

Query Params

customerReference

string

optional

customerReference

orderReference

string

optional

orderReference

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

Cancel order event model

note

string | null

optional

Note

Example

{
    "note": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/order/cancel?customerReference&orderReference' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "note": "string"
}'

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

Body

object {0}

Example

{}

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

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

Get order status

Shipment tracking

Order cancel

Purpose and usage#

Request

Request samples

Responses

Purpose and usage