(Quick Reference)
Service: Delete an item
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/items/{id}
URL with external_id:
https://BASE_URL/api/VERSION/items/reference/{id}
Method: DELETE
Parameters:
Name | Description | Type | Required | Example values |
---|
id | The ID of the desired item | Long/String | yes | 123 |
Success Output
Status: HTTP/1.1 200 OK
{
"success": "true",
"success_description": "Instance deleted successfully"
}
Failure Output
Status: HTTP/1.1 400 Bad Request
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}
Status: HTTP/1.1 404 Not Found
{
"error": "not_found",
"error_description": "The item with the id 706 doesn't exist."
}