trackingmore-sdk-nodejs v1.0.8

TrackingMore-sdk-nodejs

node.js SDK for TrackingMore API

Contact: manage@trackingmore.org

Official document

Document

Index

1. Installation
2. Testing

3. SDK

   1. Couriers
   2. Trackings
   3. Air Waybill

Installation

npm install trackingmore-sdk-nodejs

Quick Start

const TrackingMore = require('trackingmore-sdk-nodejs')
const key = 'you api key'
const trackingmore = new TrackingMore(key)

trackingmore.couriers.getAllCouriers()
    .then(result => console.log(result))
    .catch(e =>  console.error('An error occurred:', e.message))

Testing

npm run test or npm test

Error handling

Simply add a try-catch block

// Get all couriers (couriers/all)
trackingmore.couriers.getAllCouriers()
    .then(result => console.log(result))
    .catch(e =>  console.error('An error occurred:', e.message))

Couriers

Return a list of all supported couriers.

https://api.trackingmore.com/v4/couriers/all

trackingmore.couriers.getAllCouriers()
    .then(result => console.log(result))
    .catch(e => console.log(e))

Return a list of matched couriers based on submitted tracking number.

https://api.trackingmore.com/v4/couriers/detect

const params = {'tracking_number': '9400111899562537624326'}
trackingmore.couriers.detect(params)
    .then(result => console.log(result))
    .catch(e => console.log(e))

Trackings

Create a tracking.

https://api.trackingmore.com/v4/trackings/create

const params = {
    'tracking_number': '9400111899562537624326',
    'courier_code': 'usps',
    'order_number': '',
    'customer_name': '',
    'title': '',
    'language': 'en',
    'note': 'test Order'
}
trackingmore.trackings.createTracking(params)
    .then(result => console.log(result))
    .catch(e => console.log(e))

Get tracking results of multiple trackings.

https://api.trackingmore.com/v4/trackings/get

const params = {
    'tracking_numbers': '9400111899562539126562,9400111899562537624656',
    'courier_code': 'usps',
    'created_date_min': '2023-08-23T06:00:00+00:00',
    'created_date_max': '2023-09-05T07:20:42+00:00',
}
trackingmore.trackings.getTrackingResults(params)
    .then(result => console.log(result))
    .catch(e => console.log(e))

Create multiple trackings (Max. 40 tracking numbers create in one call).

https://api.trackingmore.com/v4/trackings/batch

const params = [{
    'tracking_number': '9400111899562537680047',
    'courier_code':'usps'
},{
    'tracking_number': '9400111899562537680048',
    'courier_code':'usps'
}]
trackingmore.trackings.batchCreateTrackings(params)
.then(result => console.log(result))
.catch(e => console.log(e))

Update a tracking by ID.

https://api.trackingmore.com/v4/trackings/update/{id}

const params = {
    'customer_name': 'New name',
    'note':'New test order note'
}
const idString = "9a135b15b5d983e1d8950d99022db0c7"
trackingmore.trackings.updateTrackingByID(idString, params)
.then(result => console.log(result))
.catch(e => console.log(e))

Delete a tracking by ID.

https://api.trackingmore.com/v4/trackings/delete/{id}

const idString = "9a135b15b5d983e1d8950d99022db0c7"
trackingmore.trackings.deleteTrackingByID(idString)
.then(result => console.log(result))
.catch(e => console.log(e))

Retrack expired tracking by ID.

https://api.trackingmore.com/v4/trackings/retrack/{id}

const idString = "99f4ed7fc73aa83fe68fd69ab6458b28"
trackingmore.trackings.retrackTrackingByID(idString)
.then(result => console.log(result))
.catch(e => console.log(e))

Air Waybill

Create an air waybill.

https://api.trackingmore.com/v4/awb

const params = {
    'awb_number': '235-69030430',
}
trackingmore.airWaybills.createAnAirWayBill(params)
.then(result => console.log(result))
.catch(e => console.log(e))

Response Code

Trackingmore uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an TrackingMore's server error.