README

The PHP SDK of TrackingMore API

Contact: manage@trackingmore.org

Official document

Document

Index

1. Installation
2. Testing
3. SDK
   1. Couriers
   2. Trackings
   3. Air Waybill

Installation

Option 1 (recommended): Download and Install Composer.

Run the following command to require TrackingMore PHP SDK

composer require trackingmore/trackingmore-sdk-php

Use autoloader to import SDK files

require('vendor/autoload.php');
 
use Trackingmore\TrackingMoreException;
use TrackingMore\AirWaybills;
use TrackingMore\Couriers;
use TrackingMore\Trackings;

$key = 'your api key';

$response = null;

$couriers = new Couriers($key);
$trackings = new Trackings($key);
$airWaybill = new AirWaybills($key);

try {
    //Get all couriers (couriers/all)
    $response = $couriers->getAllCouriers();
} catch (TrackingMoreException $e) {
    echo $e->getMessage();
}

print_r($response);

Option 2: Manual installation

1. Download or clone this repository to desired location
2. Reference files of this SDK in your project. Absolute path should be prefered.

<?php

require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/TrackingMoreException.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/ErrorMessages.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/Request.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/Interfaces/CouriersInterface.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/Couriers.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/Interfaces/TrackingsInterface.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/Trackings.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/Interfaces/AirWaybillsInterface.php');
require(__DIR__ . '/trackingmore/trackingmore-sdk-php/src/AirWaybills.php');

$key = 'your api key';

$couriers = new TrackingMore\Couriers($key);
$trackings = new TrackingMore\Trackings($key);
$airWaybill = new TrackingMore\AirWaybills($key);

$response = null;

try {
    //Get all couriers (couriers/all)
    $response = $couriers->getAllCouriers();
} catch (TrackingMore\TrackingMoreException $e) {
    echo $e->getMessage();
}

print_r($response);

Testing

1. Execute the file:

• If you are install manually, please execute 'trackingmore/trackingmore-sdk-php/examples/testing.php' on your browser.
• If you are install by composer, please execute 'vendor/trackingmore/trackingmore-sdk-php/examples/testing.php' on your browser.

1. Insert your TrackingMore API Key. How to generate TrackingMore API Key
2. Click the request all button or the button of the represented request.

Error handling

Simply add a try-catch block

try {
  $couriers = new TrackingMore\Couriers('your api key');
  $response = $couriers->getAllCouriers();
}catch(\TrackingMoreException $e) {
    echo $e->getMessage();
}

Couriers

Return a list of all supported couriers.

https://api.trackingmore.com/v4/couriers/all

$couriers = new TrackingMore\Couriers('your api key');
$response = $couriers->getAllCouriers();

Return a list of matched couriers based on submitted tracking number.

https://api.trackingmore.com/v4/couriers/detect

$couriers = new TrackingMore\Couriers('your api key');
$params = ['tracking_number'=>'92612903029511573030094531'];
$response = $couriers->detect($params);

Trackings

Create a tracking.

https://api.trackingmore.com/v4/trackings/create

$trackings = new TrackingMore\Trackings('your api key');
$params = ['tracking_number'=>'9400111899562537624646','courier_code'=>'usps'];
$response = $trackings->createTracking($params);

Get tracking results of multiple trackings.

https://api.trackingmore.com/v4/trackings/get

$trackings = new TrackingMore\Trackings('your api key');
$params = ['tracking_numbers'=>'92612903029511573030094532,9400111899562539126562','courier_code'=>'usps','created_date_min'=>'2023-08-23T06:00:00+00:00','created_date_max'=>'2023-09-05T07:20:42+00:00'];
$response = $trackings->getTrackingResults($params);

Create multiple trackings (Max. 40 tracking numbers create in one call).

https://api.trackingmore.com/v4/trackings/batch

$trackings = new TrackingMore\Trackings('your api key');
$params = [
    ['tracking_number'=>'92612903029511573030094531','courier_code'=>'usps'],
    ['tracking_number'=>'92612903029511573030094532','courier_code'=>'usps']
];
$response = $trackings->batchCreateTrackings($params);

Update a tracking by ID.

https://api.trackingmore.com/v4/trackings/update/{id}

$trackings = new TrackingMore\Trackings('your api key');
$params = ['customer_name'=>'New name','note'=>'New tests order note'];
$idString = '9a035f5cdd0437c55d48e223c705a66c';
$response = $trackings->updateTrackingByID($idString,$params);

Delete a tracking by ID.

https://api.trackingmore.com/v4/trackings/delete/{id}

$trackings = new TrackingMore\Trackings('your api key');
$idString = '99f8a21408be0b436705aa84d6f91806';
$response = $trackings->deleteTrackingByID($idString);

Retrack expired tracking by ID.

https://api.trackingmore.com/v4/trackings/retrack/{id}

$trackings = new TrackingMore\Trackings('your api key');
$idString = '9a035f5cdd0437c55d48e223c705a66c';
$response = $trackings->retrackTrackingByID($idString);

Air Waybill

Create an air waybill.

https://api.trackingmore.com/v4/awb

$airWaybill = new TrackingMore\AirWaybills('your api key');
$params = ['awb_number'=>'235-69030430'];
$response = $airWaybill->createAnAirWayBill($params);

Response Code

Trackingmore uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an TrackingMore's server error.