Delete an Order: /orders/{order_id}
Purpose
This endpoint permanently delete a specific order from the system using its unique identifier. Once deleted, the order and all its associated details will be removed and cannot be restored.
Use Case
The endpoint is used in scenarios where an order needs to be permanently removed from the system. This might be necessary if the order was created by mistake, is a duplicate, or part of a test run. For instance, during QA testing or system resets, test orders may be deleted to maintain a clean and accurate dataset. This endpoint ensures that no residual data remains for deleted orders.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | Unique identifier of the order to delete. |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
This endpoint does not return a response body. Upon successful execution, the order is deleted and an HTTP 204 No Content status code is returned.
Delete a Note from an Order: /orders/{id}/notes/{noteUuid}
Purpose
Permanently remove a single note from an order, identified by the order's ID and the note's UUID. The endpoint scopes the delete operation to one specific note record without affecting the parent order, other notes attached to the order, or any related child entities such as files, watchers, or custom attributes that exist on sibling notes. On success, the API responds with HTTP 204 No Content and an empty body, signalling that the note record has been removed and is no longer retrievable through the standard order-notes lookup endpoints. Subsequent attempts to fetch the deleted note by its UUID will return a not-found error.
Use Case
Order notes accumulate across the lifetime of an order — customer service comments, fulfilment instructions, internal escalations, ad-hoc reminders, and automated annotations from upstream systems. Over time, some notes become stale, contain incorrect information, or carry data that must be removed to satisfy compliance or data hygiene requirements (e.g., personally identifiable information caught by a periodic audit, duplicates produced during a sync, or notes added in error). Customer service supervisors, data stewards, and compliance teams need a clean, scoped way to remove individual notes without touching the rest of the order's history. Automated retention pipelines may also call this endpoint at the end of a defined retention window to prune older notes that have been archived elsewhere. Because the deletion is precisely targeted via UUID, sibling notes and the parent order remain untouched.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier of the parent order. |
| noteUuid | String (UUID) | UUID of the note to delete. |
Query Parameters
No query parameters required.
Request Body
This endpoint does not require a request body.
Response
Returns HTTP 204 No Content on successful deletion with an empty response body. The absence of an error indicates the note was permanently removed from the order. Errors are returned with the standard error envelope: 404 Not Found if the order ID does not exist, the note UUID does not exist, or the note does not belong to the specified order; 401/403 if the caller lacks delete permissions; and 5xx for server-side failures. Callers that require post-delete confirmation can re-fetch the order's notes list and verify that the deleted UUID is no longer present.