Mr. Mail Tracker API Documentation

---

All Mailings

Purpose: Get a list of mailings that are in the tracking system.

Example URL:
https://MrMailTracker.com/api/mailings?login_id=49&user_id=20&search_string=null&key=GsF6CkPmErRh&search_field=null&archived=0

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.

search_field

You can search for specific mailings using the search parameters. If you would like all mailings on your account returned, set the search_field and search_string to "null."
The search_field is the field that you are searching within - the data type.

Available Fields:
must be one of the following...

null

JobID

MailingID

MailDate

search_string

This is the value you are searching for. For example, if you want to get all mailings with a mail date of Aug 9, 2012, set the search_field to "MailDate" and the search_string to "2012-08-09."
Note:

• Mail dates must be submitted in the format YYYY-MM-DD.
• If no search is being made, i.e. you are requesting all mailings, you must assign "null" to this parameter. See Example URL above.

archived

Determines whether current mailing/s (within the past 90 days) or archived mailing/s will be returned.

must be one of the following...

0 - not archived; current mailings

1 - archived mailings older than 90 days

Sample Response:

{
    "company": "Bulk Mail Inc.",
    "customer_id": 21,
    "mailings": 
        [
            {
                "job_id": "100868",
                "mailing_id": "57207",
                "pieces_delivered": 60,
                "mail_class": "Standard",
                "mail_piece": "Letter",
                "mail_date": "2012-03-07",
                "created_by": "Bob Smith",
                "pieces_tracked": 251
            }, {
                "job_id": "100868",
                "mailing_id": "57189",
                "pieces_delivered": 178,
                "mail_class": "First Class",
                "mail_piece": "Letter",
                "mail_date": "2012-03-07",
                "created_by": "Bob Smith",
                "pieces_tracked": 178
            }, {
                "job_id": "103840",
                "mailing_id": "57187",
                "pieces_delivered": 0,
                "mail_class": "Standard",
                "mail_piece": "Letter",
                "mail_date": "2012-03-07",
                "created_by": "Phil Johnson",
                "pieces_tracked": 551
            }
        ],
    "mailing_count": 3,
    "current_user": "Doug Williams"
}