Wrapper for various shipping APIs that returns standardized javascript objects.
JavaScript
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
README.md
index.js
package.json

README.md

packmule

Wrapper that returns standardized javascript objects from various shipping APIs.

Usage:

Get tracking information:

var packet = {
    "carrier":      "usps",
    "number":       "EJ958088694US"
};

var credentials = {id: 'YOUR_USER_ID', testing: true};
//use testing: true to use testing rather than production servers

tracking.track(credentials, packet, function (tracking) {
    console.log("USPS");
    if (tracking.status)
        console.log(tracking.data); 
    else
        console.log(tracking.issues);
});

Active Carriers:

  • fedex
    • Example Credentials: {key: 'YOUR_KEY', password: 'YOUR_PASSWORD', number: 'YOUR_ACCOUNT_NUMBER', meter: 'YOUR_METER_NUMBER'}
  • ups
    • Example Credentials: {key: 'YOUR_KEY', user: 'YOUR_USERNAME', password: 'YOUR_PASSWORD'}
  • usps
    • Example Credentials: {id: 'YOUR_USER_ID'}

Installation:

npm install packmule

... or to install the package globally:

npm install -g packmule

Thank You To:

Michael Nowack (github.com/syranez), who originally created the dhl module, which scrapes from carrier tracking sites. Much of the organization of this module is based on his.

License:

Copyright (c) 2013 Patrick Facheris, MIT LICENSE