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 [email protected].

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.

API and SDK Version

• SDK Version: 17.0.0
• API Version: 2026-07

Quick Start

Installation

npm install --save @aftership/tracking-sdk

Constructor

Create AfterShip instance with options

Example

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

The API returns its current rate limit status in the headers of every response, and the SDK exposes these headers on both successful responses and rate-limited errors, so you can monitor your consumption proactively instead of waiting for 429 errors.

Every successful response exposes a response_headers object alongside data (header names are lower-cased). Taking the Quick Start example above:

const remaining = Number(result.response_headers["x-ratelimit-remaining"]);
const resetAt = Number(result.response_headers["x-ratelimit-reset"]);

if (remaining <= 1) {
  // Throttle or defer lower-priority requests until `resetAt`
}

When the rate limit is exceeded, the request fails with a 429 error that carries the same headers — see Error Handling.

Error Handling

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

Error List

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

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

/trackings

GET /trackings

const query = {};

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

POST /trackings

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

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

GET /trackings/{id}

const query = {};

aftership.tracking
  .getTrackingById(
    "valid_value",

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

PUT /trackings/{id}

const updateTrackingByIdRequestBody = {};

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

DELETE /trackings/{id}

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

POST /trackings/{id}/retrack

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

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

const markTrackingCompletedByIdRequestBody = {};

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

/couriers

GET /couriers

const query = {};

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

POST /couriers/detect

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

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

/courier-connections

GET /courier-connections

const query = {};

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

POST /courier-connections

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}

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

PATCH /courier-connections/{id}

const putCourierConnectionsByIdRequestBody = {
  credentials: {},
};

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

DELETE /courier-connections/{id}

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

/estimated-delivery-date

POST /estimated-delivery-date/predict

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

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 [email protected]

License

Copyright (c) 2025 AfterShip

Licensed under the MIT license.