IBC MailPlus Track

Introduction

This REST service allows our partners to retrieve tracking details on the MailPlus (e-Commerce) items.

How to retrieve your data

Your client must use GET HTTP method to successfully retrieve your track information. You may use JSONP to retrieve your data as well.

The service URL is:
 https://api.pactrak.com/mailplus/events 

Request Samples

You can retrieve the tracking data RESTFully for a given track number such as: LX112300950US with the URL
 https://api.pactrak.com/mailplus/events/LX112300950US 
or as a parameter named trackNumbers:
 https://api.pactrak.com/mailplus/events?trackNumbers=LX112300950US 
You may also request the order of the track results in ascending order, by appending '_ascending' to the URL as a parameter:
 https://api.pactrak.com/mailplus/events/LX112300950US?_ascending 
The parameter trackNumbers accepts a "\n" delimited list of tracking numbers to track. There is a limit of 10 numbers.
You may also change the source of the tracking events to the USPS tracking service by adding "_usps" to the end of your track URL.
 https://api.pactrak.com/mailplus/events/LX112300950US?_usps 

The format of the JSON response

After making a successful submission you should expect a return of one of the following JSON structures:

• Successful JSON response

  {
  

  /**
  * The HTTP response code
  * @type Integer.
  */
  "code": 200,
  
  /**
  * Response message relevant to the action requested.
  * @type String.
  */
  "message":"",
  
  /**
  * Message to developer to help troubleshoot issues with the service.
  * @type String.
  */
  "developerMessage":"",
  /**
  * A link to the resource.
  * @type String.
  */
  "href":"https://api.pactrak.com/mailplus/events",
  
  /**
  * The HTTP method of the request.
  * @type String.
  */
  "http_method":"GET",
  
  /**
  * Used to confirm if we are responding to JSONP requests.
  * @type boolean.
  */
  "jsonpresponse": false,
  
  /**
  * The JSON object response with your tracking results.
  * @type Object.
  */
  "trackResults": "" /

  }

• trackResults structure: The following structure is the definition of the trackResults object

  {
  

  /**
  * The name of the vendor supplying the track results.
  * @type String.
  */
  "vendor_name":"",
  
  /**
  * The track number.
  * @type String.
  */
  "trackNumber":"",
  
  /**
  * The package ID.
  * @type String.
  */
  "packageId":"",
  
  /**
  * The reference number.
  * @type String.
  */
  "referenceNumber":"",
  
  /**
  * The zip code of the consignee
  * @type String.
  */
  "shipToZip":"",
  
  /**
  * The country name of the consignee
  * @type String.
  */
  "shipToCountry":"",
  
  /**
  * The country code of the consignee
  * @type String.
  */
  "shipToCountryCode":"",
  
  /**
  * A status message from the vendor
  * @type String.
  */
  "status":"",
  
  /**
  * The source of the event data.
  * @type String.
  */
  "source":"",
  
  /**
  * A URL with the tracking information from source.
  * @type String.
  */
  "public_url":"",
  
  /**
  * A boolean flag to highlight if there are tracking events.
  * @type boolean.
  */
  "has_events":true,
  
  /**
  * The array with the event information
  * @type Array of Event objects.
  */
  "events":[ ]
  

  }

• Event Structure: The following structure is the definition of the Event object.

  {
  

  /**
  * Event activity code.
  * @type String.
  */
  "code":"",
  
  /**
  * Event description.
  * @type String.
  */
  "description":"",
  
  /**
  * The timestamp of the event. (YYYY-MM-DD HH:MM:SS)
  * @type String.
  */
  "timestamp":"",
  
  /**
  * The event location.
  * @type String.
  */
  "location":"",
  
  

  }