AfterShip Tracking API library for Node.js

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

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

If you need support using AfterShip products, please contact support@aftership.com.

Table of Contents

- AfterShip Tracking API library for Node.js
- Table of Contents
- Before you begin
- API and SDK Version
- Quick Start
- Installation
- Constructor
- Example
- Rate Limiter
- Error Handling
- Error List
- Endpoints
- /trackings
- /couriers
- /courier-connections
- /estimated-delivery-date
- Help
- License

Before you begin

Before you begin to integrate:

- Create an AfterShip account.
- Create an API key.
- Install Node.js version 16 or later.

$3

- SDK Version:
- API Version: 2025-07

Quick Start

$3

``bash
npm install --save @aftership/tracking-sdk
`

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. |

$3

`javascript
// Step 1: Import the AfterShip client
import { AfterShip } from "@aftership/tracking-sdk";
// or
// const { AfterShip } = require('@aftership/tracking-sdk');

// Step 2: Initialize the client object
const aftership = new AfterShip({ api_key: "YOUR_API_KEY" });

// Step 3: Create the query object
const query = {};

// Step 4: Make the request
aftership.tracking
.getTrackingById(
"valid_value",

query,
)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

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_headers | object | API response header. |

$3

| 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/couriers2. 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_REQUIRED | 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 | 500 | Something went wrong on AfterShip's end. |
| INTERNAL_ERROR | 502 | 502 | Something went wrong on AfterShip's end. |
| INTERNAL_ERROR | 503 | 503 | Something went wrong on AfterShip's end. |
| INTERNAL_ERROR | 504 | 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:

- tracking
- Get trackings
- Create a tracking
- Get a tracking by ID
- Update a tracking by ID
- Delete a tracking by ID
- Retrack an expired tracking by ID
- Mark tracking as completed by ID
- courier
- Get couriers
- Detect courier
- courierConnection
- Get courier connections
- Create courier connections
- Get courier connection by id
- Update courier connection by id
- Delete courier connection by id
- estimatedDeliveryDate
- Prediction for the Estimated Delivery Date
- Batch prediction for the Estimated Delivery Date

$3

GET /trackings

`javascript
const query = {};

aftership.tracking
.getTrackings(query)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

POST /trackings

`javascript
const createTrackingRequestBody = {
tracking_number: "valid_value",
};

aftership.tracking
.createTracking(createTrackingRequestBody)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

GET /trackings/{id}

`javascript
const query = {};

aftership.tracking
.getTrackingById(
"valid_value",

query,
)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

PUT /trackings/{id}

`javascript
const updateTrackingByIdRequestBody = {};

aftership.tracking
.updateTrackingById("valid_value", updateTrackingByIdRequestBody)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

DELETE /trackings/{id}

`javascript
aftership.tracking
.deleteTrackingById("valid_value")
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

POST /trackings/{id}/retrack

`javascript
aftership.tracking
.retrackTrackingById("valid_value")
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

POST /trackings/{id}/mark-as-completed

`javascript
const markTrackingCompletedByIdRequestBody = {};

aftership.tracking
.markTrackingCompletedById(
"valid_value",
markTrackingCompletedByIdRequestBody,
)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

$3

GET /couriers

`javascript
const query = {};

aftership.courier
.getCouriers(query)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

POST /couriers/detect

`javascript
const detectCourierRequestBody = {
tracking_number: "valid_value",
};

aftership.courier
.detectCourier(detectCourierRequestBody)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

$3

GET /courier-connections

`javascript
const query = {};

aftership.courierConnection
.getCourierConnections(query)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

POST /courier-connections

`javascript
const postCourierConnectionsRequestBody = {
courier_slug: "valid_value",
credentials: {},
};

aftership.courierConnection
.postCourierConnections(postCourierConnectionsRequestBody)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

GET /courier-connections/{id}

`javascript
aftership.courierConnection
.getCourierConnectionsById("valid_value")
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

PATCH /courier-connections/{id}

`javascript
const putCourierConnectionsByIdRequestBody = {
credentials: {},
};

aftership.courierConnection
.putCourierConnectionsById(
"valid_value",
putCourierConnectionsByIdRequestBody,
)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

DELETE /courier-connections/{id}

`javascript
aftership.courierConnection
.deleteCourierConnectionsById("valid_value")
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

$3

POST /estimated-delivery-date/predict

`javascript
const predictRequestBody = {
slug: "valid_value",
origin_address: {}, // EstimatedDeliveryDateRequestOriginAddress
destination_address: {}, // EstimatedDeliveryDateRequestDestinationAddress
};

aftership.estimatedDeliveryDate
.predict(predictRequestBody)
.then((result) => console.log(result))
.catch((e) => console.log(e));
`

POST /estimated-delivery-date/predict-batch

`javascript
const predictBatchRequestBody = {};

aftership.estimatedDeliveryDate
.predictBatch(predictBatchRequestBody)
.then((result) => console.log(result))
.catch((e) => console.log(e));
``

Help

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

- Issue Tracker for questions, feature requests, bug reports and general discussion related to this package. Try searching before you create a new issue.
- Contact AfterShip official support via support@aftership.com

License

Copyright (c) 2025 AfterShip

Licensed under the MIT license.