Mr. Mail Tracker API Documentation


Mail Piece Tracking

Purpose: Get all the scans for a particular mail piece.

Example URL:
https://MrMailTracker.com/api/track_mail_piece?login_id=49&user_id=20&key=GsF6CkPmErRh&mailing_id=55382&field=Address&value=south

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.
field
The data type you want to use when you search. Must be one of the following:
  • Address
  • SerialNumber
value
The address or serial number you wish to search for.

Sample response when there are multiple matches: 

{
    "matches": [
        {
            "city": "Dresher",
            "zip": "19025 ",
            "address2": "",
            "state": "PA",
            "address": "1429 Southwind Way",
            "serial": "527958632"
        }, {
            "city": "Midlothian",
            "zip": "23113 ",
            "address2": "",
            "state": "VA",
            "address": "14304 Southwell Ter",
            "serial": "527958195"
        }, {
            "city": "Lancaster",
            "zip": "17601 ",
            "address2": "",
            "state": "PA",
            "address": "2783 Southwick Dr",
            "serial": "527964657"
        }, {
            "city": "Chesterfield",
            "zip": "23832 ",
            "address2": "",
            "state": "VA",
            "address": "7424 Southwind Dr Apt 308",
            "serial": "527939448"
        }
    ],
    "results": 4
}

Response information:
When there are multiple matches to the search criteria submitted, the response will contain all the possible matches.
matches
An array containing each match. Each match consist of:
city
The city component of the address for the mail piece.
zip
The ZIP code of the address for the mail piece.
address2
The secondary address line for the mail peice.
state
The state component of the address for the mail piece.
address
The primary address line for the mail piece.
serial
The unique serial number encoded into the IMB for the mail piece.
results
Number of matches returned.


Example URL:
https://MrMailTracker.com/api/track_mail_piece?login_id=49&user_id=20&key=GsF6CkPmErRh&mailing_id=55382&field=SerialNumber&value=527958632

Sample response when there is a single match: 

{
    "city": "Dresher",
    "zip": "19025 ",
    "delivered": true,
    "address2": "",
    "results": 1,
    "imbdigits": "30270106848527958632",
    "state": "PA",
    "delivery_date": "2/18/2012",
    "address": "1429 Southwind Way",
    "crrt": "C015",
    "scans": [
        {
            "date": "2/17/2012",
            "status": "893",
            "st_descr": "General mail processing",
            "zipcode": "19176",
            "time": "03:51PM"
        }, {
            "date": "2/17/2012",
            "status": "918",
            "st_descr": "Final processing for delivery",
            "zipcode": "19176",
            "time": "10:26PM"
        }, {
            "date": "2/18/2012",
            "status": "919",
            "st_descr": "Final processing for delivery",
            "zipcode": "19176",
            "time": "03:35AM"
        }
    ],
    "dp": "52",
    "zip4": "1025"
}

Response information:
When there is a single match, the information for that mail piece will be provided along with the details of every scan received.
city
The city component of the address for the mail piece.
zip
The ZIP code of the address for the mail piece.
delivered
A boolean value indicating wether the mail piece has been confirmed delivered based on the scans received from the USPS.
address2
The secondary address line for the mail peice.
results
Number of matches returned.
imbdigits
The component of the Intelligent Mail Barcode that includes the barcode ID, service type ID, mailer ID and serial number.
state
The state component of the address for the mail piece
delivery_date
The delivery date calculated by Mr Mail Tracker based on the scan information from the USPS.
address
The primary address line for the mail piece.
crrt
The carrier route.
scans
An array containing each of the scans for this mail piece. Each scan consist of:
date
The date the scan was made.
status
The USPS operation code.
st_descr
The Mr Mail Tracker interpretation of the operation code.
zipcode
The ZIP code for the USPS processing facility where the scan was made.
time
The time of day the mail piece was scanned.
dp
The delivery point.
zip4
The +4 added to the ZIP code.