An sdk to the USPS APIs for node.js
JavaScript Makefile
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.npmignore
Makefile
README.md
index.js
package.json

README.md

Node USPS SDK

Node.js SDK for the USPS tracking and shipping APIs.

More data on the APIs can be found at https://www.usps.com/business/webtools-technical-guides.htm

##Usage

###Tracking API

Use the Tracking API to track packages.

####Tracking a Single Tracking #

    var usps = require('./node_modules/usps');
    var ShippingApi = usps.ShippingApi;

    var userId = '' //Insert your user id

    shipping = new ShippingApi( userId );

    shipping.track("EJ958083578US");

    shipping.on('data', function(data) {
        console.log(data); 
        /* '$': { ID: 'EJ958083578US' },
            TrackSummary: [ 'Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.' ],
            TrackDetail: [ 
                'May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.',
                'May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.',
                'May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.',
            ] */
        
    });

####Tracking Multiple Tracking #s

    var usps = require('./node_modules/usps');
    var ShippingApi = usps.ShippingApi;

    var userId = '' //Insert your user id

    shipping = new ShippingApi( userId );

    shipping.track("EJ958083578US", "EJ958088694US");

    var collectedData = [];
    var numTrackIDsEnded = 0;

    shipping.on('data', function(data) {
        console.log(data);
    });

###Testing

First you need to enter your User ID into the test/config.js file.

exports.Config = { 
    userId: 'UR_USER_ID'
}

Then you can run all the tests from the command line with:

    Make test

You can run individual tests from the command line with:

    node test/test_multiple_track.js