Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The node.js SDK of AfterShip API
branch: master

README.md

Install

npm install aftership

Test

  • Paste your API key in test/tests.js
  • If you desire, update test tracking numbers in test/local.js

To test, run

npm test


In case there is any fail tests, please make sure to delete the testing tracking numbers from your aftership account before a new test.

Use

Reference the AfterShip library:

var Aftership = require('aftership')('API_KEY');

Couriers

Gets a list of available couriers. Returns the total number of couriers along with an array of available couriers.

Get couriers:

Callback:

err: the error message
result: the couriers object

Example:

Aftership.getCouriers(function(err, result) {
  console.log('Support courier count: ' + result.total);
  console.log('Couriers: ' + result.couriers);
});

Trackings

Create a new tracking number:

You must first create a new tracking number before getting the tracking result.

Accepts:

tracking_number: The tracking number to track
options: An object with options to set

https://www.aftership.com/docs/api/3.0/tracking/post-trackings

Callback:

function(err, result)

Example:

Aftership.createTracking('1Z21E98F0314447088', {slug: 'ups'}, function(err, result) {
  if (err) {
    console.log(err);
  } else {
    console.log('Created the tracking: ' + result);
  }
});

Get all trackings number in the acccount

Returns all available trackings from your account. Accepts:

Accepts:

options: An object with options to limit results
fields: Array of fields to return
https://www.aftership.com/docs/api/3.0/tracking/get-trackings

callback:

function(err, results)

Example get all trackings with courier: ups

Aftership.getTrackings({slug: 'ups'}, function(err, results) {
  if (err) {
    console.log(err);
  } else {
    console.log('Total Trackings in query: ' + results.count);
    console.log(results);
  }
});

Get a specific tracking number in the account

Gets information for a specific tracking number.

Accepts:

slug: The slug for the tracking number, e.g., 'ups'
tracking_number: The tracking number to retrieve.
fields: Array of fields to return

callback:


function(err, result)

Example:


Aftership.tracking('ups', '1Z21E98F0314447088', ['tracking_number','slug','checkpoints'], function(err, result) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

Update a tracking number information

Updates tracking information for an existing tracking number.

Accepts:

slug: The slug for the tracking number, e.g., 'ups'
tracking_number: The tracking number to retrieve.
options: Object of fields to update

https://www.aftership.com/docs/api/3.0/tracking/put-trackings-slug-tracking_number

callback:

function(err, result)

Example:

Aftership.updateTracking('ups', '1Z21E98F0314447088', {title: 'My Shipment'},
  function(err, result) {
    if (err) {
      console.log(err);
    } else {
      console.log(result);
    }
  });

Last Checkpoint

Gets the last checkpoint for a specific tracking number.

Accepts:

slug: The slug for the tracking number, e.g., 'ups'
tracking_number: The tracking number to retrieve.
fields: Array of fields to return

Callback:

function(err, result)

Example:

Aftership.last_checkpoint('ups', '1Z21E98F0314447088', ['tracking_number','slug','checkpoints'], function(err, result) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

License

GNU v2

Contributors

Kirk Morales - Intrakr

Something went wrong with that request. Please try again.