Aftership

FREE
By stefan.skliarov
Updated 5 months ago
Logistics
4.6/10
Popularity Score
292ms
Latency
100%
Success Rate

Aftership API Documentation

Track shipments of 400 couriers.

View API Details
POSTaddTrackingNumberNotificationById
POSTaddTrackingNumberNotificationByTrackingNumber
POSTcreateTracking
POSTdeleteTrackingByTrackingID
POSTdeleteTrackingByTrackingNumber
POSTdetectCouriers
POSTgetActivatedCouriers
POSTgetAllCouriers
POSTgetLastCheckpointTrackingInfoById
POSTgetLastCheckpointTrackingInfoByTrackingNumber
POSTgetSingleTrackingResultById
POSTgetSingleTrackingResultByTrackingNumber
POSTgetTrackingResults
POSTgetUserContactInfoToNotifyById
POSTgetUserContactInfoToNotifyByTrackingNumber
POSTremoveTrackingNumberNotificationById
POSTremoveTrackingNumberNotificationByTrackingNumber
POSTretrackExpiredTrackingById
POSTretrackExpiredTrackingByTrackingNumber
POSTupdateTrackingById
POSTupdateTrackingByTrackingNumber
POSTaddTrackingNumberNotificationById

Add a tracking notification by system id

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
trackingIdSTRING
REQUIREDSystem tracking id
apiKeyCREDENTIALS
REQUIREDApi key you received from Aftership
Optional Parameters
emailsLIST
OPTIONALEmail address(es) to receive email notifications.
smsesLIST
OPTIONALPhone number(s) to receive sms notifications. Enter + and area code before phone number.
Code Snippet
unirest.post("https://Aftershipstefan-skliarovV1.p.rapidapi.com/addTrackingNumberNotificationById")
.header("X-RapidAPI-Host", "Aftershipstefan-skliarovV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://Aftershipstefan-skliarovV1.p.rapidapi.com/addTrackingNumberNotificationById
Request Method: POST
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://Aftershipstefan-skliarovV1.p.rapidapi.com/addTrackingNumberNotificationById")
.header("X-RapidAPI-Host", "Aftershipstefan-skliarovV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication