Delete and Item from a Delivery

This API allowes removing an item from an on going delivery request.

Update Amount to Collect

Deleting an item from a delivery will update the delivery sub total, but will not update the amount to be collected automatically. This will allow removing items and accepting payments for them without effecting the total needed to be collected. To update the amount to be collected, you need to include 'updateAmountToCollect' in the request.

Request

Method : DELETE
URI : https://core.xameel.com/api/v1/call/delivery-item/{item-uuid}

Param	Required	Details
item-uuid	Yes	The item identification string

Header

{
    "Content-Type": "application/json",
    "Accept": "application/json",
    "api_key": "your-api-key",
    "api_aceess": "your-api-access",
    "api_pass": "your-api-password"
}

Key	Required	Type	Details
api_key	Yes	String	Your API key generated from the user portal
api_access	Yes	String	Your API access generated from the user portal
api_password	Yes	String	Your API password generated from the user portal

Expected Response

Success

{
    "code": 200,
    "status": "success",
    "message": "Deleted successfully"
}

Failure

This response is just a sample, the content may differ based on the type of error

{
    "code": 400,
    "err_code": "1x00024-049",
    "status": "fail",
    "message": "Unauthorized",
    "errors": [
        "Your account is not authorized to delete."
    ]
}

Code	Error	Details
400	1x00024-109	Missing requirements to complete the request
400	1x00024-129	Input error
401	1x00024-015	API data provided are incorrect
403	1x00024-166	Unauthorized to preform the request
500	1x00024-055	Couldn't update the delivery total
500	1x00024-088	Couldn't delete the item