Delete Shopping List
This DELETE API allows you to remove an existing shopping list identified by its unique ID.
Endpoint Details
- URL:
/shoppingList/{shopping_list_id} - Method:
DELETE - Authentication: Bearer Token (required)
Path Parameters
| Parameter | Type | Description |
|---|---|---|
shopping_list_id | string | The unique identifier of the shopping list to delete. |
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 | Shopping list 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": "Shopping list 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 | Shopping list not found. |
| 500 Internal Server Error | Server encountered an error. |
Notes
- Ensure that the
shopping_list_idin the URL corresponds to the actual ID of the shopping list you wish to delete. - The API requires a valid access token for authentication to successfully delete the shopping list.
- Deletions are permanent and cannot be undone, so ensure that the correct shopping list is targeted before performing this operation.