Hey there tracking number enthusiast! I don't use this project in any production capacity, and really never have. I am not a tracking number expert, and I don't have inside connections to a shipping company—I'm just a guy that once tried to make a package tracking app and this gem is all that survived. When I have absolutely nothing to do it's kinda fun to tinker with, but time has become more and more of a precious resource. Anyway, maintaining this is thankless work, and if this project has been useful for you I sure would appreciate a cup or two of coffee slid my way as a token of appreciation. A PR would also be nice.

About

This repository contains json files that programatically describe how to detect, validate, and decode the following types of tracking numbers:

Supported Tracking Numbers

JSON Format

• *couriers/.json** - identifies the standard couriers that might send mail

  • Each courier is defined by json hash with the following keys

  • name - Identifies the courier

  • courier_code - short code to identify the courier. Alphanumeric only, no spaces.

  • tracking_numbers - an array of possible tracking number formats for this courier

  • Each tracking number type is defined by a json hash with the following keys:

  • name - A name to identify this type of tracking number. Usually includes the carrier in the name, i.e. FedExGround

  • regex - A pcre compatible regular expression that identifies the tracking number regardless of spaces in-between characters.

    Every regex must contain the named groups SerialNumber and CheckDigit and depending on the tracking number can optionally contain the following common attributes:

    • ServiceType: indicating the type of delivery service
    • ShipperId: indicating the shipper id
    • PackageId: indicating the package id
    • DestinationZip: indicating the destination zip code

  • validation - Specifies how the tracking number is validated

    • checksum: if the tracking number has a checksum, include a checksum key with the details.
    • name: specifies the algorithm. Supported algorithms and parameters are mod10 mod7 s10, and sum_product_with_weightings_and_modulo. Look at existing examples for parameters.

      "validation": {
      "checksum": {
        "name": "mod10",
        "evens_multiplier": 1,
        "odds_multiplier": 2
      }
      }

    • serial_number_format: some tracking numbers require some modification of the group before validation. In the example below, the serial number needs a "91" prepended before validation unless the number starts with a 91, 92, 93, 94, or 95

      "serial_number_format": {
      "prepend_if": {
        "matches_regex": "^(?!9[1-5]).+",
        "content": "91"
      }
      }

  • tracking_url - A url that we can use to find the tracking history for a particular tracking number. It assumes the tracking number can be entered using python style string formatting "www.courier.com?trackingnumber=%s".

  • test_numbers:

    • valid: an array of valid tracking numbers for testing
    • invalid: an array of invalid tracking numbers for testing

  • additional - (optional) further information relating to a named regex group can be specified. For instance, a lookup table for the ServiceType regex group, relating the two digit letter code with the type of service.

      "additional": [
        {
          "name": "Service Type",
          "regex_group_name": "ServiceType",
          "lookup": [
            {
              "matches": "01",
              "name": "UPS United States Next Day Air (Red)"
            },
            {
              "matches": "02",
              "name": "UPS United States Second Day Air (Blue)"
            }
          ]
        }
      ]

  Each hash in the lookup array should contain a key called matches or matces_regex, specifying how the value of regex_group_name should be compared.

  • partners - Each entry of the partners array describes a possible partnership between carriers. A partnership is only valid if both ends of the partnership pass the checks. If the tracking number passes both sets of validation, this indicates that the shipment was handled by both parties, usually one acting as the shipper, and the other as the last mile carrier. Each item in the partners array should have:

    • partner_id: (required) reference indicating the related definition
    • partner_type: (required) indicating the type of relationship. Currently the two supported relationship types are shipper and carrier.
    • description: (optional) mainly for humans reading this
    • validation: (optional) a validation block that determins if this partnership applies
    • matches_all or matches_any: array of match conditions. Each match condition must have a regex_group_name indicating the name of the regex group to match against, and then either a matches key or a matches_regex key with a string or a regex to match against

        //usps.json
    
        "partners": [{
          "partner_id": "fedex_smartpost",
          "partner_type": "origin",
          "description": "FedEx SmartPost uses USPS for last mile delivery, but not all USPS91 numbers are SmartPosts",
          "validation": {
            "matches_all": [
               {
                 "regex_group_name": "ServiceType",
                 "matches": "29"
               },
               {
                 "regex_group_name": "SCNC",
                 "matches": "62"
               }
            ]
          }
        }],

Making a contribution

• Modify or add definitions in the couriers/*.json files. Take a look at the existing ones, and follow the guidance above.
• Run the tests locally. bundle exec rake If they pass, it's good, submit a PR!

Standard implementations of

• Check digit algorithms
• Serial number parsers

Using this repo:

List of Libraries using this repository, by Language

We suggest you check these out before rolling your own implementation.

Ruby:

• tracking_number

JS/TS:

• ts-tracking-number

Java:

• MysteryTrackingNumber

Python:

• TrackingNumbers

Go:

• go-package-tracking

I am creating a new library

If you are using this repo, it is most likely because you are writing a library to get information out of tracking numbers.

1. Please check that your chosen programming language does not already have an implementation of a tracking number parser that uses these json files.
2. If you are creating a new library, great! Open an issue and let us know. We're happy to help!

I found a bug or missing couriers.

• Open an issue and specify the tracking numbers and courier service.
• PRs: Feel free to modify any json file that does not specify it is auto-generated by a script. Run ./lint_json.sh to clean up and validate the json file (you may need jq or other dependencies).

Reference Documents

Located/uploaded to the wiki for preservation