Skip to content

Commit

Permalink
DHL and UPS updates to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antman10001 committed Jul 15, 2019
1 parent 7120fcf commit 15518c8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Expand Up @@ -33,7 +33,9 @@ Bloodhound can guess the carrier given a tracking number explicity through the `
Bloodhound also examines each of the activity/movement/scan events for "shipped" and "delievered" event types (beyond simple electronic events like "shipping label created" or "manifest file sent"). When a matching event type is encountered Bloodhound returns a `shippedAt` and `deliveredAt` date.

## Supported Carriers
- DHL
- FedEx
- UPS
- USPS

## Getting Started
Expand Down Expand Up @@ -94,6 +96,10 @@ bloodhound.track('tracking number', 'FedEx', function(err, data) {
});
```

**dhl**

DHL just requires an API key as an option: https://api-eu.dhl.com/track/shipments?trackingNumber=${trackingNumber}.

**fedEx**

FedEx options are passed to the [shipping-fedex](https://www.npmjs.com/package/shipping-fedex) module.
Expand All @@ -106,6 +112,10 @@ By default Bloodhound uses the OpenStreetMap geocode provider. You can optionall

By default Bloodhound caches geocode results in-memory locally. You can optionally enable caching of geocoder results to a remote Redis server. These options are passed to the [petty-cache](https://www.npmjs.com/package/petty-cache) module.

**ups**

The UPS API requires a username, password, and an access key as options. If you are trying to test UPS, access https://wwwcie.ups.com/rest/Track for test tracking information. Otherwise, Bloodhound will default to the production url: https://onlinetools.ups.com/rest/Track.

**usps**

The USPS API simply requires a user ID: https://www.usps.com/business/web-tools-apis/track-and-confirm-api.htm
Expand Down

0 comments on commit 15518c8

Please sign in to comment.