Description: this web service is used in order to delete an existing delivery assignment
URL:
https://BASE_URL/api/VERSION/assignDelivery/{id}URL with external_id:
https://BASE_URL/api/VERSION/assignDelivery/reference/{id}Method: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|---|---|---|---|
| id | The ID of the delivery assignment to delete | Long/String | yes | 123 |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
The order should be assigned to an employee and not already delivered
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 Delivery assignment with the id 1796 doesn't exist."
}Failure case:response.status = 400
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}{
"error":"invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}