Skip to main content

Delete Order

Delete an existing order.

HTTP Request​

DELETE/api/orders/:id

Authorization​

Authorization

  • Required: Yes
  • Permission: Staff with OrderPermission or Admin
  • Permission Code: 2204
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters​

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the order to delete

Status Rules​

Orders may only be deleted in the following statuses.

Current StatusCan be Deleted?
newYes
holdYes
failedYes
cancelledYes
processingNo
shippedNo
completedYes
refundedYes

Example Requests​

1import requests
2
3response = requests.delete('http://www.example.com/api/orders/123', 
4  headers={'Authorization': 'Token <your_api_key>'}
5)
6print(response.status_code)  # Should be 204 for successful deletion

Response Fields​

FieldTypeDescription
NoneNoneNo response body returned

Notes​

  • You can not delete an order in the processing or shipped status. To do so, you may first change the status to another relevant and valid status.