npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

consignment-tracker

v0.2.5

Published

A unified consignment tracker

Downloads

10

Readme

This is a NodeJS module to simplify the process of tracking consignments. Tracking numbers are magically resolved, and results will always be in a uniform format. Currently supports UPS, Yodel & Truline in the United Kingdom.

Install

npm i consignment-tracker

Example

const config = {
    ups: { // UPS config (required for UPS tracking only)
        user: "xxxx",  // UPS username
        pass: "xxxx",  // UPS password
        access: "xxxx" // UPS Access License Number
    },
    truline: { // Truline config (require for Truline tracking only)
        account: "00000"
    }
};
const track = require('consignment-tracker')(config);

let result = await track('XXXXXXXXXXXXXXXX');

let results = await track([
    '1111111111111',
    '2222222222222',
    '3333333333333'
]);

Usage

Track a single consignment

let result = await track(reference);

Track a batch of consignments

let results = await track([ref1, ref2, ref3]);

Track a single consignment and request full tracking history.

let result = await track(reference, {history: true});

Notes

  • In the case of tracking a single reference, track() will throw an error if there is a failure performing the tracking.
  • If you provide an array to track(), it will not throw. Instead, each individual error in the batch will be returned in the results along with the corresponding tracking reference.
  • If performing many lookups, it is always preferable to track an array of references, rather than individually. The tracking has appropriate built-in rate limiting (independent for each courier), and can sometimes eliminate some requests altogether.
  • The result from a batch-track will not be returned in the same order as requested.

Result schema

Status codes

  • D : Delivered
  • I : In Transit
  • X : Exception (failure in the delivery process, e.g. address not found)
  • M : Manifested (parcel not yet handed to the courier)

Result object

{
	courier: {type:"string"},
	service: {type:"string"},
	tracking_ref: {type:"string"},
	consignment_ref: {type:"string"},
	parcel_ref: {type:"string"},
	po_number: {type:"string"},
	dest_postal_code: {type:"string"},
	dest_country_code: {type:"string"},
	status_code: {type:"string", enum:["D", "I", "X", "M"]},
	description: {type:"string"},
	location: {type:"string"},
	pod_signatory: {type:"string"},
	pod_image_url: {type:"string"},
	date: {type:"date"},
	comments:  {type:"string"},
	history: [
		{
			status_code: {type:"string", enum:["D", "I", "X", "M"]},
			description: {type:"string"},
			location: {type:"string"},
			pod_signatory: {type:"string"},
			pod_image_url: {type:"string"},
			date: {type:"date"},
			comments: {type:"string"}
		}
	]
}