Contact: support@aftership.com
Download and Install Composer. https://getcomposer.org/download/ Create a composer.json
{
"require": {
"aftership/aftership-php-sdk": "4.0.0"
}
}
Please ensure you have installed the PHP extension CURL, you could run the following command to install it
sudo apt-get install php5-curl
and restart the web server and PHP process.
Run the following command in the command line
composer install
or
php composer.phar install
- Copy the test folder to the same folder of composer.json
cp -r -f vendor/aftership/aftership-php-sdk/test ./
- Execulte the file: aftership-php/test/testing.php at your browser
- Insert your AfterShip API Key. How to generate AfterShip API Key
- Click the request all button or the button of the represented request
https://www.aftership.com/docs/api/4/couriers/get-couriers
require 'vendor/autoload.php';
$couriers = new AfterShip\Couriers('AFTERSHIP_API_KEY');
$response = $couriers->get();
https://www.aftership.com/docs/api/4/couriers/get-couriers-all
require 'vendor/autoload.php';
$couriers = new AfterShip\Couriers('AFTERSHIP_API_KEY');
$response = $couriers->get_all();
https://www.aftership.com/docs/api/4/couriers/post-couriers-detect
require 'vendor/autoload.php';
$courier = new AfterShip\Couriers('AFTERSHIP_API_KEY');
$response = $courier->detect('1234567890Z');
https://www.aftership.com/docs/api/4/trackings/post-trackings
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$tracking_info = array(
'slug' => 'dhl',
'title' => 'My Title',
);
$response = $trackings->create('RA123456789US', $tracking_info);
(Will be available soon)
https://www.aftership.com/docs/api/4/trackings/delete-trackings
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->delete('dhl', 'RA123456789US');
https://www.aftership.com/docs/api/4/trackings/delete-trackings
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->delete_by_id('53df4a90868a6df243b6efd8');
https://www.aftership.com/docs/api/4/trackings/get-trackings
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$options = array(
'page'=>1,
'limit'=>10
);
$response = $trackings->get_all($options)
https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->get('dhl', 'RA123456789US', array('title','order_id'));
https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->get_by_id('53df4a90868a6df243b6efd8', array('title','order_id'));
https://www.aftership.com/docs/api/4/trackings/put-trackings-slug-tracking_number
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$params = array(
'smses' => array(),
'emails' => array(),
'title' => '',
'customer_name' => '',
'order_id' => '',
'order_id_path' => '',
'custom_fields' => array()
);
$response = $trackings->update('dhl', 'RA123456789US', $params);
https://www.aftership.com/docs/api/4/trackings/put-trackings-slug-tracking_number
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$params = array(
'smses' => array(),
'emails' => array(),
'title' => '',
'customer_name' => '',
'order_id' => '',
'order_id_path' => '',
'custom_fields' => array()
);
$response = $trackings->update_by_id('53df4a90868a6df243b6efd8', $params);
https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->retrack('dhl','RA123456789US');
https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack
require 'vendor/autoload.php';
$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->retrack_by_id('53df4a90868a6df243b6efd8');
Return the tracking information of the last checkpoint of a single tracking by slug and tracking number
https://www.aftership.com/docs/api/4/last_checkpoint/get-last_checkpoint-slug-tracking_number
require 'vendor/autoload.php';
$last_check_point = new AfterShip\LastCheckPoint('AFTERSHIP_API_KEY');
$response = $last_check_point->get('dhl','RA123456789US');
https://www.aftership.com/docs/api/4/last_checkpoint/get-last_checkpoint-slug-tracking_number
require 'vendor/autoload.php';
$last_check_point = new AfterShip\LastCheckPoint('AFTERSHIP_API_KEY');
$response = $last_check_point->get_by_id('53df4a90868a6df243b6efd8');
require 'vendor/autoload.php';
$history = new HistoryPlugin();
$async = new AsyncPlugin();
$logPlugin = new LogPlugin($adapter, MessageFormatter::DEBUG_FORMAT);
$guzzlePlugins = array($history, $async, $logPlugin);
$tracking = new AfterShip\Tracking('AFTERSHIP_API_KEY', $guzzlePlugins);
$couriers = new AfterShip\Couriers('AFTERSHIP_API_KEY', $guzzlePlugins);
These amazing people have contributed code to this project:
- Teddy Chan - view contributions
- Sunny Chow - view contributions
- Abishek R Srikaanth - view contributions
- Luis Cordova - view contributions
- Russell Davies - view contributions
- akovalyov - view contributions
- Robert Basic - view contributions