Download the PHP package aftership/tracking-sdk without Composer

On this page you can find all versions of the php package aftership/tracking-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/tracking-sdk

Informations about the package tracking-sdk

AfterShip Tracking API library for PHP

This library allows you to quickly and easily use the AfterShip Tracking API via PHP.

For updates to this library, see our GitHub release page.

If you need support using AfterShip products, please contact [email protected].

Table of Contents

Before you begin

Before you begin to integrate:

API and SDK Version

Each SDK version is designed to work with a specific API version. Please refer to the table below to identify the supported API versions for each SDK version, ensuring you select the appropriate SDK version for the API version you intend to use.

SDK Version Supported API Version Branch
11.x.x 2025-04 https://github.com/AfterShip/tracking-sdk-php/tree/2025-04
10.x.x 2025-01 https://github.com/AfterShip/tracking-sdk-php/tree/2025-01
9.x.x 2024-10 https://github.com/AfterShip/tracking-sdk-php/tree/2024-10
8.x.x 2024-07 https://github.com/AfterShip/tracking-sdk-php/tree/2024-07
7.x.x 2024-04 https://github.com/AfterShip/tracking-sdk-php/tree/2024-04
6.x.x 2023-10 https://github.com/AfterShip/aftership-sdk-php
<=5.x.x Legacy API https://github.com/AfterShip/aftership-sdk-php

Quick Start

Installation

Constructor

Create AfterShip instance with options

Name Type Required Description
api_key string ✔ Your AfterShip API key
auth_type enum Default value: AuthType.API_KEY
AES authentication: AuthType.AES
RSA authentication: AuthType.RSA
api_secret string Required if the authentication type is AuthType.AES or AuthType.RSA
domain string AfterShip API domain. Default value: https://api.aftership.com
user_agent string User-defined user-agent string, please follow RFC9110 format standard.
proxy string HTTP proxy URL to use for requests.
Default value: null
Example: http://192.168.0.100:8888
max_retry number Number of retries for each request. Default value: 2. Min is 0, Max is 10.
timeout number Timeout for each request in milliseconds.

Example

Rate Limiter

See the Rate Limit to understand the AfterShip rate limit policy.

Error Handling

The SDK will return an error object when there is any error during the request, with the following specification:

Name Type Description
message string Detail message of the error
code enum Error code enum for API Error.
meta_code number API response meta code.
status_code number HTTP status code.
response_body string API response body.
response_header object API response header.

Error List

code meta_code status_code message
INVALID_REQUEST 400 400 The request was invalid or cannot be otherwise served.
INVALID_JSON 4001 400 Invalid JSON data.
TRACKING_ALREADY_EXIST 4003 400 Tracking already exists.
TRACKING_DOES_NOT_EXIST 4004 404 Tracking does not exist.
TRACKING_NUMBER_INVALID 4005 400 The value of tracking_number is invalid.
TRACKING_REQUIRED 4006 400 tracking object is required.
TRACKING_NUMBER_REQUIRED 4007 400 tracking_number is required.
VALUE_INVALID 4008 400 The value of [field_name] is invalid.
VALUE_REQUIRED 4009 400 [field_name] is required.
SLUG_INVALID 4010 400 The value of slug is invalid.
MISSING_OR_INVALID_REQUIRED_FIELD 4011 400 Missing or invalid value of the required fields for this courier. Besides tracking_number, also required: [field_name]
BAD_COURIER 4012 400 The error message will be one of the following:
1. Unable to import shipment as the carrier is not on your approved list for carrier auto-detection. Add the carrier here: https://admin.aftership.com/settings/couriers
2. Unable to import shipment as we don’t recognize the carrier from this tracking number.
3. Unable to import shipment as the tracking number has an invalid format.
4. Unable to import shipment as this carrier is no longer supported.
5. Unable to import shipment as the tracking number does not belong to a carrier in that group.
INACTIVE_RETRACK_NOT_ALLOWED 4013 400 Retrack is not allowed. You can only retrack an inactive tracking.
NOTIFICATION_REUQIRED 4014 400 notification object is required.
ID_INVALID 4015 400 The value of id is invalid.
RETRACK_ONCE_ALLOWED 4016 400 Retrack is not allowed. You can only retrack each shipment once.
TRACKING_NUMBER_FORMAT_INVALID 4017 400 The format of tracking_number is invalid.
API_KEY_INVALID 401 401 The API key is invalid.
REQUEST_NOT_ALLOWED 403 403 The request is understood, but it has been refused or access is not allowed.
NOT_FOUND 404 404 The URI requested is invalid or the resource requested does not exist.
TOO_MANY_REQUEST 429 429 You have exceeded the API call rate limit. The default limit is 10 requests per second.
INTERNAL_ERROR 500 502 503 504 500 502 503 504 Something went wrong on AfterShip's end.

Endpoints

The AfterShip instance has the following properties which are exactly the same as the API endpoints:

/trackings

POST /trackings

DELETE /trackings/:id

GET /trackings

GET /trackings/:id

PUT /trackings/:id

POST /trackings/:id/retrack

POST /trackings/:id/mark-as-completed

/couriers

GET /couriers

POST /couriers/detect

/courier-connections

GET /courier-connections

POST /courier-connections

/estimated-delivery-date

POST /estimated-delivery-date/predict-batch

Help

If you get stuck, we're here to help:

License

Copyright (c) 2025 AfterShip

Licensed under the MIT license.

All versions of tracking-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0.0
guzzlehttp/guzzle Version 7.*
phpseclib/phpseclib Version ^3.0.17
symfony/serializer Version ^5.4 || ^6.4 || ^7.0
symfony/property-access Version ^5.4 || ^6.4 || ^7.0
symfony/property-info Version ^5.4 || ^6.4 || ^7.0
phpdocumentor/reflection-docblock Version >=5.4
ext-json Version *
ext-mbstring Version *
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/tracking-sdk contains the following files

Loading the files please wait ....