delivery-tracker

delivery-tracker is delivery tracking library for Node.js

Courier List

Installation

$ npm install delivery-tracker

Usage

var tracker = require('delivery-tracker')
var courier = tracker.courier(tracker.COURIER.KOREAPOST.CODE)

courier.trace('TRACE_NUMBER', function (err, result) {
  console.log(result)
})

Command Line

$ npm install -g delivery-tracker
$ delivery-tracker -h

Usage: index [options] <tracecode>

  Options:

    -h, --help               output usage information
    -c, --courier <courier>  Courier Namespace
    -k, --apikey <apikey>  Courier API key

$ delivery-tracker -c EMS EBXXXXXXXXXKR

Response

Courier Object

Checkpoint Object

CODE

COURIER

tracker.COURIER.{NAMESPACE}

STATUS

tracker.STATUS.{CODE}

ERROR

tracker.STATUS.{CODE}

Sample

// KOREAPOST
{
  "courier": {
    "code": "koreapost",
    "name": "Korea Post"
  },
  "number": "EBCOMPLETE0KR",
  "status": "Delivered",
  "checkpoints": [
    {
      "courier": {
        "code": "koreapost",
        "name": "Korea Post"
      },
      "location": "MY4332",
      "message": "Delivery complete\nRecipient : K*NG()\nResult : Delivery complete",
      "time": "2016-07-04T11:40:00"
    },
    // ...
  ]
}

// FEDEX
{
  "courier": {
    "code": "fedex",
    "name": "FedEx"
  },
  "number": "DELIVEREDNUM",
  "status": "Delivered",
  "checkpoints": [
    {
      "courier": {
        "code": "fedex",
        "name": "FedEx"
      },
      "location": "SOUTH JORDAN, UT",
      "message": "Package delivered by U.S. Postal Service to addressee",
      "status": "Delivered",
      "time": "2016-12-14T13:17:00-07:00"
    },
    // ...
  ]
}

// PANTOS
{
  "courier": {
    "code": "pantos",
    "name": "Pantos"
  },
  "number": "DELIVEREDNUM-AUSPOST",
  "status": "Delivered",
  "checkpoints": [
    {
      "courier": {
        "code": "auspost",
        "name": "Australia Post"
      },
      "location": "Canning Vale, WA",
      "message": "Delivered",
      "status": "Delivered",
      "time": "2017-01-03T15:24:00+08:00"
    },
    // ...
    {
      "courier": {
        "code": "pantos",
        "name": "Pantos"
      },
      "location": "KRICN",
      "message": "Pick-Up (Pick-Up)",
      "status": "InfoReceived",
      "time": "2016-12-20T11:25"
    }
  ]
}

Test

Test with mocha

$ grunt

like watch

$ grunt watch

Contributing

Bug reports and pull requests are welcome on Github at https://github.com/egg-/delivery-tracker

1. Fork it
2. Create your feature branch.
3. Commit your changes.
4. Push to the branch.
5. Create a new Pull Request.

Release History

See the CHANGELOG.md

License

delivery-tracker is licensed under the MIT license.

2.8.0

• add paxel

2.7.3

• fixed an issue in USPS is not working

2.7.2

• fixed an issue in JNT is not working

2.7.1

• fixed an issue in JNT is not working

2.7.0

• add canada post

2.6.1

• add courier namespace for DHL.

2.6.0

• add DHL.

2.5.8

• add an exception logic for internal server error in JNT.

2.5.7

• add an exception logic for internal server error in SICEPAT.

2.5.6

• add an exception logic in SICEPAT.

2.5.5

• fixed an issue in SICEPAT is not working.

2.5.4

• fixed RTS issue in JNT.

2.5.3

• fixed an issue in EPARCEL is not working.

2.5.2

• updating dependencies

2.5.1

• change the error type when an unexpected error occurs. (string -> object)

2.5.0

• add j&t express

2.4.5

• fixed an issue in UPS is not working.

2.4.4

• fixed an issue in CJKOREAEXPRESS is not working.

2.4.3

• fixed an issue of UPS that always marked as InTransit

2.4.2

• update eparcel check point area

2.4.1

• disable strictSSL for CJ

2.4.0

• added courier LBC

2.3.11

• sicepat: add 'rejectUnauthorized' option to ignore ssl error.

2.3.10

• sicepat: updated the changed date time format.

2.3.9

• kerrythai: changed tracking endpoint

2.3.8

• sicepat: apply updated return value

2.3.7

• sicepat: fixed delivery status check issue.

2.3.6

• eparcel: fixed delivery status check issue and change test dummy data.

2.3.5

• eparcel: fixed delivery status check issue.

2.3.4

• sicepat: add status for INFO_RECEIVED

2.3.3

• sicepat: add apikey for option

2.3.2

• sicepat: change to work without apikey

2.3.1

• fit to standard format

2.3.0

• add eparcel express
• fixed ups tracker

2.2.3

• update xpost api endpoint

2.2.0

• add xio express

2.1.3

2.1.2

• add handle for sicepat unknown error.

2.1.1

• update sicepat error.

2.1.0

• add sicepat.

2.0.4

• add error auspost

2.0.3

• add message cesco tracking information.

2.0.2

• change cesco host

2.0.1

• change cesco host (disable ssl)

2.0.0

• add KERRY THAI

1.9.1

• fixed XPOST pending state. (for pickup)

1.9.0

• add XPOST.

1.8.0

• add CESCO.

1.7.2

• fixed PANTOS not exist tracking number.

1.7.1

• fixed UPS time format bug

1.7.0

• add TNT.

1.6.3

• fixed UPS time format bug

1.6.2

• update UPS time format

1.6.1

• sort UPS checkpoints.

1.6.0

• add UPS.

1.5.5

• update cj korea express.
• fixed can not load external courier (pantos)

1.5.4

• add exception courier error message.

1.5.3

• add external courier to pantos.

1.5.2

• add exception courier error message.

1.5.1

• fixed can not load pantos data.

1.5.0

• add Air Bridge.

1.4.4

• update USPS site changes.

1.4.3

• update CJ Korea Express timezone.

1.4.2

• update yello express, rincos delivery message

1.4.0

• add EFS.

1.3.1

• update yello express state

1.3.0

• add Yello Express.

1.2.1

• add POS Laju delivery complete message type.

1.2.0

• add POS Laju.

1.1.0

• update rincos pending status.

1.0.0

• add CJ Korea Express.

0.9.4

• Added exception logic for unaligned shipping information.

0.9.3

• add a status value to the rincos checkpoint message information.

0.9.2

• Added USPS description text to README.md.

0.9.1

• Added rincos delivery complete message type.

0.9.0

• added USPS.

0.8.5

• fixed timeout pantos.

0.8.4

• update pantos shiment error handle.

0.8.0

• add royalmail.

0.7.3

• add koreapost shipping completion condition.

0.7.2

• checking the style of all javascript files.

0.7.1

• added exception logic when wrong number is entered. (rincos)

0.7.0

• add rincos.

0.6.1

• add courier to commander

0.6.0

• add exception logic when one package is shipped via multiple carriers. (Pantos)
• update test logic.

0.5.0

• add australia post.
• add pantos.

0.4.1

• add a status value to the fedex checkpoint message information.
• change the delimiter of checkpoint message.

0.4.0

• add command line.

0.3.0

• add fedex.

0.2.0

• add ecargo.

0.1.0

• add korea post.