Delete an order

Delete the order. To keep the order history, the order should be canceled instead of deleted.

delete/orders/{orderId}

Security

This operation accepts the following authorization requirements.

Required credentials

One credential is required.

OAuth2oauth2

OAuth2 authorization for API access.

orders:write

Request

Path parameters

orderIdstringrequired

ID of the order to retrieve.

Response

Order deleted successfully.

This response has no body schema.

DELETE /orders/<orderId> HTTP/1.1
Host: cafe.cloud.redocly.com
Authorization: Bearer <access_token>

curl -X DELETE 'https://cafe.cloud.redocly.com/orders/<orderId>' \
  -H 'Authorization: Bearer <access_token>'

import requests

url = "https://cafe.cloud.redocly.com/orders/<orderId>"
headers = {
    "Authorization": "Bearer <access_token>",
}

response = requests.delete(
    url,
    headers=headers,
)
print(response.status_code)

require 'net/http'
require 'uri'

uri = URI("https://cafe.cloud.redocly.com/orders/<orderId>")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer <access_token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts response.code

Response

Order deleted successfully.

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}

{
  "type": "about:blank",
  "title": "string",
  "status": 1,
  "instance": "/some/uri-reference#specific-occurrence-context",
  "details": {}
}