(Quick Reference)
Service: Delete
Description: This web service is used in order to delete an existing customer promotion list object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/customerPromotionLists/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | Id of the customer promotion list object to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerPromotionLists/reference/{customerId}/{promotionListId}:
| Name | Description | Type | Required | Examples values |
|---|
| customerId | reference of the customer | String | Yes | C-002 |
| promotionListId | reference of the promotion list | String | Yes | PL-001 |
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 customer promotion list with the id 999 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"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
