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
    • Usage
  • Constructor
    • Example
  • Rate Limiter
  • Error Handling
    • Error List
  • Endpoints
    • /trackings
    • /couriers
    • /last_checkpoint
    • /notifications
  • 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

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 | | --- | --- | --- | | 9.x.x | 2024-04 | https://github.com/AfterShip/tracking-sdk-nodejs/tree/2024-04 | | 8.x.x | 2023-10 | https://github.com/AfterShip/aftership-sdk-nodejs | | <=7.x.x | Legacy API | https://github.com/AfterShip/aftership-sdk-nodejs |

Quick Start

Installation

npm install --save @aftership/tracking-sdk

Usage

// Step 1: Require 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 request object
const createTrackingRequestBody = {
    tracking_number: 'I-1-234567654654',
    slug: 'testing-courier'
};

// Step 4: Make the request
aftership.tracking.createTracking(createTrackingRequestBody)
    .then(tracking => console.log(tracking))
    .catch(error => console.log(error));

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

import {AfterShip, AuthType} from '@aftership/tracking-sdk';
// or
// const {AfterShip, AuthType} = require('@aftership/tracking-sdk');

const aftership = new AfterShip(
    {
        api_key: 'YOUR_API_KEY',
        api_secret: 'YOUR_API_SECRET',
        auth_type: AuthType.AES
    }
);

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

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/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_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:

• courier - Get a list of our supported couriers.
• tracking - Create trackings, update trackings, and get tracking results.
• last_checkpoint - Get tracking information of the last checkpoint of a tracking.
• notification - Get, add or remove contacts (sms or email) to be notified when the status of a tracking has changed.

/trackings

POST /trackings

const payload = {
    slug: 'usps',
    tracking_number: '9261290284678900371871',
    title: 'Title Name',
    smses: [
        '+18555072509',
        '+18555072501'
    ],
    emails: [
        '[email protected]',
        '[email protected]'
    ],
    order_id: 'ID 1234',
    order_id_path: 'http://www.aftership.com/order_id=1234',
    custom_fields: {
        'product_name': 'iPhone Case',
        'product_price': 'USD19.99'
    }
};

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

DELETE /trackings/:id

aftership.tracking
    .deleteTrackingById('g0qe97idgrrbrlwiyvzco018')
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

GET /trackings

aftership.tracking
    .getTrackings({ page: 1, limit: 10, fields: 'slug,tracking_number' })
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

GET /trackings/:id

aftership.tracking
    .getTrackingById('rft4xu2rs1um1lwhm8j1p02r')
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

PUT /trackings/:id

aftership.tracking
    .updateTrackingById('hqhyzb21sm0colweuats7001',{title: 'New Title123'})
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

POST /trackings/:id/retrack

aftership.tracking
    .retrackTrackingById('hqhyzb21sm0colweuats7001')
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

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

aftership.tracking
    .markTrackingCompletedById('hqhyzb21sm0colweuats7001', { reason: 'DELIVERED' })
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

/couriers

GET /couriers

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

GET /couriers/all

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

POST /couriers/detect

aftership.courier
    .detectCourier({ tracking_number: '4209803811639200190316175613986809' })
    .then(result => console.log(result))
    .catch(e => console.log(e));

/last_checkpoint

GET /last_checkpoint/:id

aftership.lastCheckpoint
    .getCheckpointByTrackingId('g0qe97idgrrbrlwiyvzco018')
    .then(result => console.log(result))
    .catch(e => console.log(e));

/notifications

GET /notifications/:id

aftership.notification
    .getNotificationByTrackingId('mg7ocgcbeicjqlrytw85600u')
    .then(result => console.log(result))
    .catch(err => console.log(err));

POST /notifications/:id/add

aftership.notification
    .addNotificationByTrackingId('g0qe97idgrrbrlwiyvzco018',{
        'emails': ['[email protected]', '[email protected]'],
        'smses': ['+85291239123', '+85261236123']
    })
    .then(result => console.log(result))
    .catch(e => console.log(e));

POST /notifications/:id/remove

aftership.notification
    .deleteNotificationByTrackingId('g0qe97idgrrbrlwiyvzco018',{
        'emails': ['[email protected]'],
        'smses': ['+85291239123']
    })
    .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) 2024 AfterShip

Licensed under the MIT license.