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
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | Unique ID of the order to delete |
Status Rules
Orders may only be deleted in the following statuses.
| Current Status | Can be Deleted? |
|---|---|
| new | Yes |
| hold | Yes |
| failed | Yes |
| cancelled | Yes |
| processing | No |
| shipped | No |
| completed | Yes |
| refunded | Yes |
Example Requests
- 🐍 Python
- 🌐 Curl
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 deletion1curl -X DELETE "http://www.example.com/api/orders/123" -H "Authorization: Token <your_api_key>"'Response Fields
| Field | Type | Description |
|---|---|---|
| None | None | No response body returned |
Notes
- You can not delete an order in the
processingorshippedstatus. To do so, you may first change the status to another relevant and valid status.