Download the PHP package aftership/aftership-php-sdk without Composer

On this page you can find all versions of the php package aftership/aftership-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of aftership/aftership-php-sdk

Informations about the package aftership-php-sdk

Deprecation notice: New Version Available

This version of the SDK has been deprecated and replaced with the newly reconstructed SDK.

For the latest API features and improved integration, please visit our updated repository at https://github.com/AfterShip/tracking-sdk-php and follow the provided instructions.

AfterShip API PHP SDK

Build Status Code Climate Issue Count Latest Stable Version Monthly Downloads License

aftership-php is a PHP SDK (module) for AfterShip API. Module provides clean and elegant way to access API endpoints.

Contact: [email protected]

Index

  1. Installation
  2. Testing
  3. SDK
    1. Couriers
    2. Trackings
    3. Last Check Point
    4. Notifications
  4. Webhook
  5. Contributors

Installation

Option 1 (recommended): Download and Install Composer. https://getcomposer.org/download/

Run the following command to require AfterShip PHP SDK

Use autoloader to import SDK files

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.

Please ensure you have installed the PHP extension CURL, you could run the following command to install it

and restart the web server and PHP process.

Use signature headers

Custom CURL opt

Testing

  1. Execute the file:
    • If you are install manually, please execute 'test/testing.php' on your browser.
    • If you are install by composer, please execute 'vendor/aftership/aftership-php-sdk/test/testing.php' on your browser.
  2. Insert your AfterShip API Key. How to generate AfterShip API Key
  3. Click the request all button or the button of the represented request.

Error handling

Simply add a try-catch block

Couriers

Get your selected couriers list

https://www.aftership.com/docs/api/4/couriers/get-couriers

Get all our supported couriers list

https://www.aftership.com/docs/api/4/couriers/get-couriers-all

Detect courier by tracking number

https://www.aftership.com/docs/api/4/couriers/post-couriers-detect

Trackings

Tracking additional_fields

Couriers below need pass additional_fields when create, update, or delete tracking

Courier Slug Required Fields
abcustom [tracking_postal_code]
alliedexpress [tracking_postal_code]
amazon-fba-us [tracking_key]
apc-overnight-connum [tracking_postal_code]
ark-logistics [tracking_postal_code]
arrowxl [tracking_postal_code]
asm [tracking_postal_code]
australia-post-sftp [tracking_account_number]
b2ceurope [tracking_postal_code & tracking_destination_country]
bestwayparcel [tracking_key]
bluestar [tracking_postal_code]
bpost [tracking_postal_code]
brt-it-sender-ref [tracking_account_number]
capital [tracking_account_number]
chrobinson [tracking_key]
colis-prive [tracking_postal_code]
courant-plus [tracking_account_number]
deutsch-post [tracking_ship_date]
dhl-reference [tracking_ship_date]
dpd-fr-reference [tracking_account_number]
dx [tracking_account_number]
dynamic-logistics [tracking_account_number]
endeavour-delivery [tracking_postal_code]
eu-fleet-solutions [tracking_postal_code]
geodis-espace [tracking_key]
gls-netherlands [tracking_postal_code]
gls-spain [tracking_key]
interlink-express-reference [tracking_postal_code]
international-seur-api [tracking_ship_date]
mikropakket [tracking_postal_code]
mikropakket-be [tracking_postal_code]
mondialrelay [tracking_postal_code]
nacex [tracking_account_number]
nacex-spain [tracking_postal_code]
newzealand-couriers [tracking_account_number]
packs [tracking_postal_code]
palletways [tracking_postal_code]
panther-order-number [tracking_postal_code]
panther-reference [tracking_account_number]
paper-express [tracking_postal_code]
parcelpoint [tracking_key]
planzer [tracking_postal_code]
postnl [tracking_postal_code]
postnl-3s [tracking_destination_country & tracking_postal_code]
relaiscolis [tracking_key]
star-track-courier [tracking_state]
tfm [tracking_postal_code]
thedeliverygroup [tracking_postal_code]
total-express [tracking_account_number & tracking_key]
transmission-nl [tracking_postal_code]
tuffnells [tracking_account_number & tracking_postal_code]
tuffnells-reference [tracking_postal_code]
virtransport [tracking_account_number]
xdp-uk [tracking_postal_code]
xdp-uk-reference [tracking_postal_code]
Create a new tracking

https://www.aftership.com/docs/api/4/trackings/post-trackings

Create multiple trackings

(Will be available soon)

Delete a tracking by slug and tracking number

https://www.aftership.com/docs/api/4/trackings/delete-trackings

Delete a tracking by slug and tracking number and additional_fields

https://www.aftership.com/docs/api/4/trackings/delete-trackings

Delete a tracking by tracking ID

https://www.aftership.com/docs/api/4/trackings/delete-trackings

Get tracking results of multiple trackings

https://www.aftership.com/docs/api/4/trackings/get-trackings

Get tracking results of a single tracking by slug and tracking number

https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number

Get tracking results of a single tracking by slug and tracking number with custom display fields

https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number

Get tracking results of a single tracking by slug and tracking number in custom language

https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number

In case of china-post and china-ems it is possible to customize language of checkpoint messages.

Get tracking results of a single tracking by tracking ID

https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number

Update a tracking by slug and tracking number

https://www.aftership.com/docs/api/4/trackings/put-trackings-slug-tracking_number

Update a tracking by tracking ID

https://www.aftership.com/docs/api/4/trackings/put-trackings-slug-tracking_number

Reactivate Tracking by slug and tracking number

https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack

Reactivate Tracking by slug and tracking number and additional_fields

https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack

Reactivate Tracking by tracking ID

https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack

Last Check Point

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

Return the tracking information of the last checkpoint of a single tracking by tracking ID

https://www.aftership.com/docs/api/4/last_checkpoint/get-last_checkpoint-slug-tracking_number

Notifications

Create a new notification by slug and tracking number

https://www.aftership.com/docs/api/4/notifications/post-add-notifications

Create a new notification by slug and tracking number and additional_fields

https://www.aftership.com/docs/api/4/notifications/post-add-notifications

Create a new notification by tracking ID

https://www.aftership.com/docs/api/4/notifications/post-add-notifications

Delete a notification by slug and tracking number.

https://www.aftership.com/docs/api/4/notifications/post-remove-notifications

Delete a notification by slug and tracking number and additional_fields.

https://www.aftership.com/docs/api/4/notifications/post-remove-notifications

Delete a notification by tracking ID.

https://www.aftership.com/docs/api/4/notifications/post-remove-notifications

Get notification of a single tracking by slug and tracking number.

https://www.aftership.com/docs/api/4/notifications/get-notifications

Get notification of a single tracking by tracking ID

https://www.aftership.com/docs/api/4/notifications/get-notifications

Webhook

https://www.aftership.com/docs/api/4/webhook You could find the example code at here

Contributors

These amazing people have contributed code to this project:

All versions of aftership-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.1
phpseclib/phpseclib Version ~3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package aftership/aftership-php-sdk contains the following files

Loading the files please wait ....