Skip to content
Komplett LogoKomplett Platform

Cancel order

PATCH
/v1/{orderId}/cancel
curl --request PATCH \
  --url https://example.com/orders/v1/example/cancel

Cancels an order by its unique identifier.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orderId
required
string

Responses

Section titled “Responses”

204

Section titled “204”

No Content

Media typeapplication/json

400

Section titled “400”

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
errors
required
Array<object>
object
fieldName
required
string
message
required
string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}