(Quick Reference)
Service: Delete an item category
Description: This web service is used in order to delete an existing item category object from the database
URL:
https://BASE_URL/api/VERSION/itemCategories/{id}
URL with external_id:
https://BASE_URL/api/VERSION/itemCategories/reference/{id}
Method: DELETE
Parameters:
Name | Description | Type | Required | Examples values |
---|
id | Id of the desired item category to delete | Long/String | Yes | 777 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
}
Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The item category with the id 3 doesn't exist."
}
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
{
"error": "delete_failed",
"error_description": "Failed to delete instance"
}
{
"error": "delete_not_authorized",
"error_description": "item category with id 1 is the last root category in the organization."
}
Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}