Cancel an order

Updated on Mar 27, 2025
Published on Feb 20, 2025

3 minute(s) read

Prev Next

Put

/orders/v1/orders/{orderId}/_cancel

Cancel a specific order.

Security

HTTP

Type bearer

Path parameters

orderId

stringRequired

Min length1

Responses

204

Order Cancelled

400

Bad Request

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

401

Unauthorized

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

403

Forbidden

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

404

Not Found

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

422

Unprocessable Entity

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

429

Too Many Requests

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

500

Internal Server Error

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

503

Service Unavailable

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

source

object

The source of the error.

pointer

string

A pointer to the request field related to the problem.

parameter

string

A parameter related to the problem.

header

string

A header related to the problem.

meta

object

Additional metadata about the error.

Was this article helpful?