@aftership/tracking-sdk v11.0.2

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

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.

Quick Start

Installation

npm install --save @aftership/tracking-sdk

Constructor

Create AfterShip instance with options

Example

// 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: '<tracking_number>',
    slug: '<slug>'
};

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

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:

Error List

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.

• estimated-delivery-date - Get estimated delivery date for your order.

/trackings

POST /trackings

const payload = {
    slug: '<slug>',
    tracking_number: '<tracking_number>',
    title: 'Title Name',
    smses: [
        '+18555072509',
        '+18555072501'
    ],
    emails: [
        '<your_email>',
        '<your_email>'
    ],
    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('<tracking_id>')
    .then((result) => console.log(result))
    .catch((e) => console.log(e));

GET /trackings

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

GET /trackings/:id

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

PUT /trackings/:id

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

POST /trackings/:id/retrack

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

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

aftership.tracking
    .markTrackingCompletedById('<tracking_id>', { 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: '<tracking_number>' })
    .then(result => console.log(result))
    .catch(e => console.log(e));

/estimated-delivery-date

POST /estimated-delivery-date/predict-batch

const payload = {
    estimated_delivery_dates: [{
        slug: '<slug>',
        origin_address: { country: '<country>' },
        destination_address: { country: '<country>' },
    }]
};
aftership.estimatedDeliveryDate
    .predictBatch(payload)
    .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) 2024 AfterShip

Licensed under the MIT license.