(Quick Reference) Service: Delete

Description: This web service is used in order to delete a customer category object from the database

URL:

https://BASE_URL/api/VERSION/customerCategories/{id}

URL with external_id:

https://BASE_URL/api/VERSION/customerCategories/reference/{id}

Method: DELETE

Parameters:

NameDescriptionTypeRequiredExamples values
idId of the desired customer category to deleteLong/StringYes777

Success Output

Success case: response.status=200
{
    "success": "true",
    "success_description": "Instance deleted successfully"
}

Failure Output

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_not_authorized",
    "error_description": "Root category must not be deleted"
}
{
    "error": "delete_failed",
    "error_description": "Failed to delete instance"
}

Failure case:response.status = 404
{
    "error": "not_found",
    "error_description": "The customer category with the id 1 doesn't exist."
}

Failure case:response.status = 500
{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}