X

Reporting Summary

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.

[GET] https://api-us1.stannp.com/v1/reporting/summary/:startdate/:enddate

Parameters

received string We have received the request.
producing string We are printing or finishing the mailpiece.
handed_over string We have handed the mailpiece over to the delivery service (Canada Post, etc.).
local_delivery string The item is at the final delivery office and will be delivered within 24 hours.
delivered string We estimate the item has been successfully delivered.
returned string The item was returned. Normally due to incorrect recipient details.
cancelled string The item has been cancelled before it was produced and posted.

Request

                <?php
define("API_KEY", "YOUR API KEY");
$opts = array(
    'http' => array(
        'method'  => 'GET',
        'header'  => 'Content-type: application/x-www-form-urlencoded'
    )
);
$context  = stream_context_create($opts);
$result = file_get_contents("https://api-us1.stannp.com/v1/reporting/summary/:startdate/:enddate?api_key=" . API_KEY, false, $context);
$response = json_decode($result, true);

print_r($response);
?>

Response

{
    "success": true,
    "data": {
        "success": true,
        "data": {
            "total": 2000,
            "received": 0,
            "printing": 0,
            "handed_over": 0,
            "local_delivery": 400,
            "delivered": 1599,
            "returned": 1,
            "cancelled": 0
        }
    }
}

List Mailpieces

Retrieves a list of mailpiece objects sent within the specified date range. Status and tag filters are optional.

[GET] https://api-us1.stannp.com/v1/reporting/list/:startdate/:enddate/[:status]/[:tag]

Parameters

startdate date Start date of the reporting period (YYYY-MM-DD).
enddate date End date of the reporting period (YYYY-MM-DD).
status string Status filter (e.g., delivered, returned, etc.).
tag string Tag filter for searching by custom tags.

Request

                <?php
define("API_KEY", "YOUR API KEY");
$opts = array(
    'http' => array(
        'method'  => 'GET',
        'header'  => 'Content-type: application/x-www-form-urlencoded'
    )
);
$context  = stream_context_create($opts);
$result = file_get_contents("https://api-us1.stannp.com/v1/reporting/list/:startdate/:enddate/[:status]/[:tag]?api_key=" . API_KEY, false, $context);
$response = json_decode($result, true);

print_r($response);
?>

Response

{
    "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": "CA",
                    "cost": "0.42",
                    "addons": "",
                    "tags": "tag123,tag456",
                    "postcode": "M5G 1X8",
                    "address": "1234 Maple Street, Toronto, ON M5G 1X8"
                }
            ]
        }
    }
}