Delete All Deliveries
URL: |
|
HTTP POST REQUEST
Note: the request structure below is for Method #1: Name/Value Pair (NVP) + JSON String. For Method #2: Custom Header + JSON Body, please refer to the json parameter only.
Field | Description |
date | The delivery date. Format: YYYY-MM-DD e.g. 2014-02-28. Required field. |
HTTP POST RESPONSE (JSON)
Field | Description |
status | The status of the request. The value will be “ok” if request is processed successfully or “failed” if the key or json parameter is missing. |
failed | The number of deliveries that are not deleted due to error. |
deleted | The number of deliveries that deleted. |
error | Contains the error details if the request failed. Note: this field is set only if the request failed. |
SAMPLE REQUEST JSON
{
"date":"2014-02-13"
}SAMPLE RESPONSE JSON #1
{
"info":{
"status":"ok",
"failed":0,
"deleted":2
}
}SAMPLE RESPONSE JSON #2
{
"info":{
"status":"ok",
"failed":0,
"deleted":0
}
}