Mr. Mail Tracker API Documentation


Raw Scan Information

Purpose: Retrieve the raw scan information for a particular mailing.

Example URL:
https://MrMailTracker.com/api/scans?login_id=49&user_id=20&key=GsF6CkPmErRh&mailing_id=55382

Query String Parameters:
user_id
The ID of the user making the request.
login_id
The ID of the user to which the API key was assigned. (Can be the same as the user_id.)
key
The random key used to authenticate the user.
mailing_id
The unique identifier of the mailing you need to retrive tracking results for.

Sample response: 

[
    {
        "scan_file_id": 473,
        "imb_digits": "20270106848527962002",
        "facility": "95799",
        "scan_time": "10:56PM",
        "scan_date": "2/16/2012",
        "postnet": "95630864806",
        "op_code": "918"
    }, {
        "scan_file_id": 474,
        "imb_digits": "20270106848527962002",
        "facility": "95799",
        "scan_time": "04:29AM",
        "scan_date": "2/17/2012",
        "postnet": "95630864806",
        "op_code": "919"
    }, {
        "scan_file_id": 473,
        "imb_digits": "20270106848527962022",
        "facility": "95799",
        "scan_time": "10:56PM",
        "scan_date": "2/16/2012",
        "postnet": "95630805300",
        "op_code": "918"
    }
]

Response information:
The response is an array contianing each scan received from the USPS for this mailing. (Naturally, there will generally be many more scans received then in the sample above.)
scan_file_id
A unique identifier for the scan file received from the USPS.
imb_digits
The IMB digits scanned from the barcode - the component of the Intelligent Mail Barcode that includes the barcode ID, service type ID, mailer ID and serial number.
facility
The ZIP code for the USPS processing facility where the scan was made.
scan_time
The time of day the scan was made.
scan_date
The date the scan was made.
postnet
The postnet digits scanned from the barcode.
op_code
The USPS operation code for this scan.