51tracking v0.1.3

51tracking-sdk-nodejs

node.js SDK for 51Tracking API

Contact: service@51tracking.org

Official document

Document

Index

1. Installation
2. Testing

3. SDK

   1. Couriers
   2. Trackings
   3. Air Waybill

Installation

npm install 51tracking

Quick Start

const Tracking51 = require('51tracking')
const key = 'you api key'
const tracking51 = new Tracking51(key)
tracking51.couriers.getAllCouriers()
    .then(result => console.log(result))
    .catch(e => console.log(e))

Testing

npm run test or npm test

Error handling

对于异步操作，可以使用 Promise 的 catch 方法进行监听异常

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

Couriers

返回所有支持的快递公司列表

https://api.51Tracking.com/v4/couriers/all

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

Trackings

单个物流单号实时添加且查询

https://api.51Tracking.com/v4/trackings/create

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

获取多个物流单号的查询结果

https://api.51Tracking.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',
}
tracking51.trackings.getTrackingResults(params)
    .then(result => console.log(result))
    .catch(e => console.log(e))

添加多个物流单号（一次调用最多创建 40 个物流单号）

https://api.51Tracking.com/v4/trackings/batch

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

根据ID更新物流信息

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

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

通过ID删除单号

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

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

通过ID重新查询过期的单号

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

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

Air Waybill

查询航空运单的结果

https://api.51Tracking.com/v4/awb

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

响应状态码

51Tracking 使用传统的HTTP状态码来表明 API 请求的状态。通常，2xx形式的状态码表示请求成功，4XX形式的状态码表请求发生错误（比如：必要参数缺失），5xx格式的状态码表示 51tracking 的服务器可能发生了问题。