Retrieves a status summary on individual items within a date range. Use a start date and end date in the following format: YYYY-MM-DD. The end date will include everything on that day.
| Parameter | Details | Description |
|---|---|---|
| received | str optional | We have received the request. |
| producing | str optional | We are printing or finishing the mailpiece. |
| handed_over | str optional | We have handed the mailpiece over to the delivery service (Royal Mail, etc.). |
| local_delivery | str optional | The item is at the final delivery office and will be delivered within 24 hours. |
| delivered | str optional | We estimate the item has been successfully delivered. |
| cancelled | str optional | The item has been cancelled before it was produced and posted. |
curl "https://api-eu1.stannp.com/v1/reporting/summary/:startdate/:enddate" \
-u {API_KEY}:
{
"success": true,
"data": {
"success": true,
"data": {
"total": 2000,
"received": 0,
"printing": 0,
"handed_over": 0,
"local_delivery": 400,
"delivered": 1599,
"returned": 1,
"cancelled": 0
}
}
}Retrieves a list of mailpiece objects sent within the specified date range. Status and tag filters are optional.
| Parameter | Details | Description |
|---|---|---|
| startdate | date required | Start date of the reporting period (YYYY-MM-DD). |
| enddate | date required | End date of the reporting period (YYYY-MM-DD). |
| status | str optional | Status filter (e.g., delivered, returned, etc.). |
| tag | str optional | Tag filter for searching by custom tags. |
curl "https://api-eu1.stannp.com/v1/reporting/list/:startdate/:enddate/[:status]/[:tag]" \
-u {API_KEY}:
{
"success": true,
"data": {
"success": true,
"data": {
"singles": [
{
"id": "6829954",
"timestamp": "2018-02-11 07:08:55",
"status": "delivered",
"type": "postcard",
"format": "A6",
"pdf_file": "https://dash.stannp.com/api/v1/storage/get/bourbon/1518386934/pdf-production/000000000000000-0000000.pdf",
"dispatched": "2018-02-11 15:12:52",
"country": "GB",
"cost": "0.42",
"addons": "",
"tags": "tag123,tag456",
"postcode": "SW1A 1AA",
"address": "10 Downing Street, London SW1A 2AA"
}
]
}
}
}