Deletes/Cancels an existing order.

curl --request DELETE \
  --url https://api.example.com/api/v1/Orders/{accountNumber}/{orderNumber} \
  --header 'Authorization: <api-key>'

{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    "<string>"
  ]
}

DELETE

api

Orders

{accountNumber}

{orderNumber}

Deletes/Cancels an existing order.

curl --request DELETE \
  --url https://api.example.com/api/v1/Orders/{accountNumber}/{orderNumber} \
  --header 'Authorization: <api-key>'

{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    "<string>"
  ]
}

Authorization

string

header

required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

orderNumber

string

required

The customer order number

accountNumber

string

required

The customer account number

renameOrder

boolean

default:false

False: Should the order, once Cancelled/Deleted, be renamed.

200 - application/json

Generic container for all service responses

isSuccess

boolean

Was the request successful. If not, the message will have more information.

message

string | null

Any error message

payload

string[] | null

The payload object of the response

⌘I