Delete Warehouse
This DELETE API allows you to remove an existing warehouse identified by its unique ID.
Endpoint Details
- URL:
/wareHouse/{warehouse_id} - Method:
DELETE - Authentication: Bearer Token (required)
Path Parameters
| Parameter | Type | Description |
|---|---|---|
warehouse_id | string | The unique identifier of the warehouse that needs to be deleted. |
Authentication
You must provide a valid accessToken in the request headers to authenticate and access this endpoint.
Authentication Headers
| Header | Type | Description |
|---|---|---|
accessToken | string | A valid access token is required. |
Request Body
No request body is required for this DELETE operation.
Response
Success Response
| Status Code | Description |
|---|---|
| 200 OK | Warehouse was successfully deleted. |
Success Response Body Structure
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the deletion was successful. |
message | string | Message indicating the result of the delete operation. |
Sample Response Body
{
"success": true,
"message": "Warehouse deleted successfully"
}
Error Responses
| Status Code | Description |
|---|---|
| 400 Bad Request | Invalid request format or missing parameters. |
| 401 Unauthorized | Invalid or missing access token. |
| 403 Forbidden | Access denied. |
| 404 Not Found | Warehouse not found. |
| 500 Internal Server Error | Server encountered an error. |
Notes
- Ensure that the
warehouse_idin the URL corresponds to the actual ID of the warehouse you wish to delete. - The API requires a valid access token for authentication to successfully delete the warehouse.
- Deletions are permanent and cannot be undone. Confirm that you have entered the correct
warehouse_idbefore performing this operation.