# 51tracking > node.js SDK for 51Tracking API Latest version **0.1.3** (published 2023-11-21) · MIT license · 0 weekly downloads ## Install ```sh npm install 51tracking pnpm add 51tracking yarn add 51tracking bun add 51tracking ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.3 | | Published | 2023-11-21 | | First published | 2023-10-14 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 26.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | 51Tracking | | Maintainers | 51tracking | | Keywords | 51tracking | ## Links - npm: https://www.npmjs.com/package/51tracking - Repository: https://github.com/51tracking/51tracking-sdk-nodejs - Homepage: https://github.com/51tracking/51tracking-sdk-nodejs#readme - Issues: https://github.com/51tracking/51tracking-sdk-nodejs/issues - npm.io page: https://npm.io/package/51tracking ## Recent versions - 0.1.3 (latest) — 2023-11-21 - 0.1.2 — 2023-11-06 - 0.1.1 — 2023-10-14 - 0.1.0 — 2023-10-14 ## README 51tracking-sdk-nodejs ================= node.js SDK for 51Tracking API Contact: ## Official document [Document](https://www.51tracking.com/v4/api-index/API-) ## Index 1. [Installation](https://github.com/51tracking/51tracking-sdk-nodejs#installation) 2. [Testing](https://github.com/51tracking/51tracking-sdk-nodejs#testing) 3. SDK 1. [Couriers](https://github.com/51tracking/51tracking-sdk-nodejs#couriers) 2. [Trackings](https://github.com/51tracking/51tracking-sdk-nodejs#trackings) 3. [Air Waybill](https://github.com/51tracking/51tracking-sdk-nodejs#air-waybill) ## Installation ``` npm install 51tracking ``` ## Quick Start ```javascript 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 方法进行监听异常 ```javascript 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 ```javascript tracking51.couriers.getAllCouriers() .then(result => console.log(result)) .catch(e => console.log(e)) ``` ## Trackings ##### 单个物流单号实时添加且查询 https://api.51Tracking.com/v4/trackings/create ```javascript 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 ```javascript 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 ```javascript 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} ```javascript 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} ```javascript 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} ```javascript 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 ```javascript 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 的服务器可能发生了问题。 Http CODE|META CODE|TYPE | MESSAGE ----|-----|--------------|------------------------------- 200 |200 | 成功 | 请求响应成功。 400 |400 | 错误请求 | 请求类型错误。请查看 API 文档以了解此 API 的请求类型。 400 |4101 | 错误请求 | 物流单号已存在。 400 |4102 | 错误请求 | 物流单号不存在。请先使用「Create接口」将单号添加至系统。 400 |4103 | 错误请求 | 您已超出 API 调用的创建数量。每次创建的最大数量为 40 个快递单号。 400 |4110 | 错误请求 | 物流单号(tracking_number) 不符合规则。 400 |4111 | 错误请求 | 物流单号(tracking_number)为必填字段。 400 |4112 | 错误请求 | 查询ID无效。 400 |4113 | 错误请求 | 不允许重新查询。您只能重新查询过期的物流单号。 400 |4120 | 错误请求 | 物流商简码(courier_code)的值无效。 400 |4121 | 错误请求 | 无法识别物流商。 400 |4122 | 错误请求 | 特殊物流商字段缺失或填写不符合规范。 400 |4130 | 错误请求 | 请求参数的格式无效。 400 |4160 | 错误请求 | 空运单号(awb_number)是必需的或有效的格式。 400 |4161 | 错误请求 | 此空运航空不支持查询。 400 |4165 | 错误请求 | 查询失败：未创建空运单号。 400 |4166 | 错误请求 | 删除未创建的空运单号失败。 400 |4167 | 错误请求 | 空运单号已存在，无需再次创建。 400 |4190 | 错误请求 | 当前查询额度不足。 401 |401 | 未经授权 | 身份验证失败或没有权限。请检查并确保您的 API 密钥正确无误。 403 |403 | 禁止 | 禁止访问。请求被拒绝或不允许访问。 404 |404 | 未找到 | 页面不存在。请检查并确保您的链接正确无误。 429 |429 | 太多请求| 超出 API 请求限制，请稍后重试。请查看 API 文档以了解此 API 的限制。 500 |511 | 服务器错误 | 服务器错误。请联系我们： service@51Tracking.org。 500 |512 | 服务器错误 | 服务器错误。请联系我们：service@51Tracking.org。 500 |513 | 服务器错误 | 服务器错误。请联系我们： service@51Tracking.org。 --- _Source: https://npm.io/package/51tracking · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._