https://github.com/slince/shipment-tracking-foundation

:sparkles: A flexible and shipment tracking library for multi carriers
https://github.com/slince/shipment-tracking-foundation

carrier china-post dhl dhl-ecommerce shipment shipment-tracker shipment-tracking

Last synced: 2 months ago
JSON representation

:sparkles: A flexible and shipment tracking library for multi carriers

• Host: GitHub
• URL: https://github.com/slince/shipment-tracking-foundation
• Owner: slince
• Created: 2017-08-09T06:13:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-01T02:00:01.000Z (about 7 years ago)
• Last Synced: 2024-04-22T08:43:56.835Z (9 months ago)
• Topics: carrier, china-post, dhl, dhl-ecommerce, shipment, shipment-tracker, shipment-tracking
• Language: PHP
• Homepage:
• Size: 13.7 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Shipment Tracking Foundation

[![Build Status](https://img.shields.io/travis/slince/shipment-tracking-foundation/master.svg?style=flat-square)](https://travis-ci.org/slince/shipment-tracking-foundation)

[![Coverage Status](https://img.shields.io/codecov/c/github/slince/shipment-tracking-foundation.svg?style=flat-square)](https://codecov.io/github/slince/shipment-tracking-foundation)

[![Latest Stable Version](https://img.shields.io/packagist/v/slince/shipment-tracking-foundation.svg?style=flat-square&label=stable)](https://packagist.org/packages/slince/shipment-tracking-foundation)

[![Scrutinizer](https://img.shields.io/scrutinizer/g/slince/shipment-tracking-foundation.svg?style=flat-square)](https://scrutinizer-ci.com/g/slince/shipment-tracking-foundation/?branch=master)

A flexible and shipment tracking library for multi carriers.

## Basic Usage

```php

$tracker = new Slince\ShipmentTracking\DHLECommerce\DHLECommerceTracker(CLIENT_ID, PASSWORD);

try {

   $shipment = $tracker->track('CNAQV100168101');

   

   if ($shipment->isDelivered()) {

       echo "Delivered";

   }

   echo $shipment->getOrigin();

   echo $shipment->getDestination();

   print_r($shipment->getEvents());  //print the shipment events

   

} catch (Slince\ShipmentTracking\Exception\TrackException $exception) {

    exit('Track error: ' . $exception->getMessage());

}

```

## How to create your own tracker?

All shipment trackers must implement `Slince\ShipmentTracking\Foundation\TrackerInterface`, and will usually extend `Slince\ShipmentTracking\Foundation\HttpAwareTracker` for basic functionality if the carrier's api is based on

HTTP

```php

namespace My\Tracker;

use Slince\ShipmentTracking\Foundation\HttpAwareTracker;

use Slince\ShipmentTracking\Foundation\Shipment;

class MyTracker extends HttpAwareTracker

{

   /**

    * {@inheritdoc}

    */

    public function track($trackingNumber)

    {

        $response = $this->getHttpClient()->get('/../endpoint', [

            'query' => [

                'tracking_number' => $trackingNumber

            ]

        ]);

        return static::buildShipment($response):

    }

    

    /**

     * @return Shipment

     */

    public function buildShipment($response)

    {

        //....

    }

}

$tracker = new MyTracker();

$shipment = $tracker->track('foo-tracking-number');

print_r($shipment):

```

You can extend all existing classes if you need.

 

## Shipment trackers:

The following carriers are available:

| Tracker | Composer Package | Maintainer |

| --- | --- | --- |

| [DHL eCommerce](https://github.com/slince/shipment-tracking)| slince/shipment-tracking | [Tao](https://github.com/slince) |

| [Yanwen Exprerss(燕文物流)](https://github.com/slince/shipment-tracking)| slince/shipment-tracking | [Tao](https://github.com/slince) |

| [快递100](https://github.com/slince/shipment-tracking)| slince/shipment-tracking | [Tao](https://github.com/slince) |

| [E邮宝/E包裹/E特快/国际EMS](https://github.com/slince/shipment-tracking)| slince/shipment-tracking | [Tao](https://github.com/slince) |

## License

 

The MIT license. See [MIT](https://opensource.org/licenses/MIT)