(Quick Reference)
Service: Delete a prepayment allocation
Description: Returns a JSON response.
URL:
https://BASE_URL/api/VERSION/orderPrepaymentAllocations/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired prepayment allocation | Long | yes | 123 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
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 = 404
{
"error": "not_found",
"error_description": "The prepayment allocation with the id 706 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
