{"_id":"51tracking","_rev":"3-391f54ca16f1f713f462d83a92b8bbb3","name":"51tracking","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.0":{"name":"51tracking","version":"0.1.0","description":"node.js SDK for 51Tracking API","main":"src/index.js","scripts":{"test":"jest"},"keywords":["51tracking"],"author":{"name":"51Tracking","email":"service@51tracking.org"},"repository":{"type":"git","url":"git://github.com/51tracking/51tracking-sdk-nodejs.git"},"bugs":{"url":"https://github.com/51tracking/51tracking-sdk-nodejs/issues"},"license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/*.test.js"]},"devDependencies":{"jest":"^29.6.4"},"gitHead":"f902d64a30e6845790e803eac0aaf4b585f62166","homepage":"https://github.com/51tracking/51tracking-sdk-nodejs#readme","_id":"51tracking@0.1.0","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-+v46wZSEttYeFkAjjXgVcan8dorSmlsQMOZBMQDYCRjFG7UIlG0DwJ6xfqsoCdLXqblmwvQMcGszVbiEFFWXJQ==","shasum":"4d4de0df310c95d22b6593893b96dc772a21d407","tarball":"https://registry.npmjs.org/51tracking/-/51tracking-0.1.0.tgz","fileCount":11,"unpackedSize":29279,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEzF8qarzYn7BSGE6klrRbg2PtgSB86f+tdRrRokUjWbAiEAs0dV5Vp3KL479XR9SLzPeXnw3DvywVYvfBnit/NZqfk="}]},"_npmUser":{"name":"51tracking","email":"service@51tracking.org"},"directories":{},"maintainers":[{"name":"51tracking","email":"service@51tracking.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/51tracking_0.1.0_1697255323523_0.3126230614820038"},"_hasShrinkwrap":false},"0.1.1":{"name":"51tracking","version":"0.1.1","description":"node.js SDK for 51Tracking API","main":"src/index.js","scripts":{"test":"jest"},"keywords":["51tracking"],"author":{"name":"51Tracking","email":"service@51tracking.org"},"repository":{"type":"git","url":"git://github.com/51tracking/51tracking-sdk-nodejs.git"},"bugs":{"url":"https://github.com/51tracking/51tracking-sdk-nodejs/issues"},"license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/*.test.js"]},"devDependencies":{"jest":"^29.6.4"},"gitHead":"2cce11cf4017e39d56c4530328de3aa39eabdea2","homepage":"https://github.com/51tracking/51tracking-sdk-nodejs#readme","_id":"51tracking@0.1.1","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-74ZQ5kMxDg7egEMux+fFzQe88jL9/XYOQL+yOGq9OlG9XQiFICuTJLJWLbPClUDLZw8G58TGyOwN1UGl5B2UEQ==","shasum":"c1587af9376b0fec6da938d735cbb60e98e3e90b","tarball":"https://registry.npmjs.org/51tracking/-/51tracking-0.1.1.tgz","fileCount":11,"unpackedSize":29336,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDYcs4mGfx9CDFUy5sKtj2X4PIL/mwxNH3RDg/AwJ6QnQIhAL1ofzLjrBGDEHd7QDLEe2pEXvJnYfHGxUtoURPSHXG6"}]},"_npmUser":{"name":"51tracking","email":"service@51tracking.org"},"directories":{},"maintainers":[{"name":"51tracking","email":"service@51tracking.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/51tracking_0.1.1_1697265622805_0.12250845737329152"},"_hasShrinkwrap":false},"0.1.2":{"name":"51tracking","version":"0.1.2","description":"node.js SDK for 51Tracking API","main":"src/index.js","scripts":{"test":"jest"},"keywords":["51tracking"],"author":{"name":"51Tracking","email":"service@51tracking.org"},"repository":{"type":"git","url":"git://github.com/51tracking/51tracking-sdk-nodejs.git"},"bugs":{"url":"https://github.com/51tracking/51tracking-sdk-nodejs/issues"},"license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/*.test.js"]},"devDependencies":{"jest":"^29.6.4"},"gitHead":"77a43bf445fff65c7626d9528ae40abc2196c5c1","homepage":"https://github.com/51tracking/51tracking-sdk-nodejs#readme","_id":"51tracking@0.1.2","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-rapRYnE//XaI/HwWqJ0U0jn9TsZW/A3cVCVE6XZC3ff+yDEXjqelIi6I53dX+cPOxCSJH8lskalddWu8zIYsEw==","shasum":"cedd7a3b3da24ae5c44fd2c9e90f62dc0572e5bc","tarball":"https://registry.npmjs.org/51tracking/-/51tracking-0.1.2.tgz","fileCount":11,"unpackedSize":27829,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDiifiC3wwPmYV3AVGMaMeMbemt2k+aQamMa1HXLNQQQgIhAJvC6xjC7oFK+ZkFUsHgrirpDZ6vuSd+S+VYAfKxslaf"}]},"_npmUser":{"name":"51tracking","email":"service@51tracking.org"},"directories":{},"maintainers":[{"name":"51tracking","email":"service@51tracking.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/51tracking_0.1.2_1699240026620_0.6636222450910718"},"_hasShrinkwrap":false},"0.1.3":{"name":"51tracking","version":"0.1.3","description":"node.js SDK for 51Tracking API","main":"src/index.js","scripts":{"test":"jest"},"keywords":["51tracking"],"author":{"name":"51Tracking","email":"service@51tracking.org"},"repository":{"type":"git","url":"git://github.com/51tracking/51tracking-sdk-nodejs.git"},"bugs":{"url":"https://github.com/51tracking/51tracking-sdk-nodejs/issues"},"license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/*.test.js"]},"devDependencies":{"jest":"^29.6.4"},"gitHead":"4c7ec5feaab31750d0d2bfca117e79014e0e36a7","homepage":"https://github.com/51tracking/51tracking-sdk-nodejs#readme","_id":"51tracking@0.1.3","_nodeVersion":"16.14.0","_npmVersion":"8.3.1","dist":{"integrity":"sha512-NGWLTgrKN2S2Ealr/nfLkBU55UXMaBHCz0/SvR+SpgwAWjHiKgeBSdkip6jXhGzkgaq8gDW2K5+Gu/GA8BUmug==","shasum":"73480296c0429bf328ba07f9e1ca00c3b36a7ecc","tarball":"https://registry.npmjs.org/51tracking/-/51tracking-0.1.3.tgz","fileCount":11,"unpackedSize":26925,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAnYpu+3nifyvc2vd58/gjpjCOUfMqthEV1Yv37xZfI2AiEAzkUR1dEYO0AJJx86K2RfmXDhNxLKyI6pzbxjksgyG1w="}]},"_npmUser":{"name":"51tracking","email":"service@51tracking.org"},"directories":{},"maintainers":[{"name":"51tracking","email":"service@51tracking.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/51tracking_0.1.3_1700561503160_0.8871623229347874"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-14T03:48:43.522Z","0.1.0":"2023-10-14T03:48:43.764Z","modified":"2023-11-21T10:11:43.474Z","0.1.1":"2023-10-14T06:40:22.992Z","0.1.2":"2023-11-06T03:07:06.824Z","0.1.3":"2023-11-21T10:11:43.331Z"},"maintainers":[{"name":"51tracking","email":"service@51tracking.org"}],"description":"node.js SDK for 51Tracking API","homepage":"https://github.com/51tracking/51tracking-sdk-nodejs#readme","keywords":["51tracking"],"repository":{"type":"git","url":"git://github.com/51tracking/51tracking-sdk-nodejs.git"},"author":{"name":"51Tracking","email":"service@51tracking.org"},"bugs":{"url":"https://github.com/51tracking/51tracking-sdk-nodejs/issues"},"license":"MIT","readme":"51tracking-sdk-nodejs\r\n=================\r\n\r\nnode.js SDK for 51Tracking API\r\n\r\nContact: <service@51tracking.org>\r\n\r\n## Official document\r\n\r\n[Document](https://www.51tracking.com/v4/api-index/API-)\r\n\r\n## Index\r\n1. [Installation](https://github.com/51tracking/51tracking-sdk-nodejs#installation)\r\n2. [Testing](https://github.com/51tracking/51tracking-sdk-nodejs#testing)\r\n3. SDK\r\n    1. [Couriers](https://github.com/51tracking/51tracking-sdk-nodejs#couriers)\r\n    2. [Trackings](https://github.com/51tracking/51tracking-sdk-nodejs#trackings)\r\n    3. [Air Waybill](https://github.com/51tracking/51tracking-sdk-nodejs#air-waybill)\r\n\r\n    \r\n## Installation\r\n```\r\nnpm install 51tracking\r\n```\r\n\r\n## Quick Start\r\n\r\n```javascript\r\nconst Tracking51 = require('51tracking')\r\nconst key = 'you api key'\r\nconst tracking51 = new Tracking51(key)\r\ntracking51.couriers.getAllCouriers()\r\n    .then(result => console.log(result))\r\n    .catch(e => console.log(e))\r\n```\r\n\r\n## Testing\r\n```\r\nnpm run test or npm test\r\n```\r\n\r\n## Error handling\r\n\r\n对于异步操作，可以使用 Promise 的 catch 方法进行监听异常\r\n\r\n```javascript\r\ntracking51.couriers.getAllCouriers()\r\n    .then(result => console.log(result))\r\n    .catch(e => console.error('An error occurred:', e.message))\r\n\r\n```\r\n\r\n## Couriers\r\n##### 返回所有支持的快递公司列表\r\nhttps://api.51Tracking.com/v4/couriers/all\r\n```javascript\r\ntracking51.couriers.getAllCouriers()\r\n    .then(result => console.log(result))\r\n    .catch(e => console.log(e))\r\n```\r\n\r\n## Trackings\r\n##### 单个物流单号实时添加且查询\r\nhttps://api.51Tracking.com/v4/trackings/create\r\n```javascript\r\nconst params = {\r\n    'tracking_number': '9400111899562537624326',\r\n    'courier_code': 'usps',\r\n    'order_number': '',\r\n    'customer_name': '',\r\n    'title': '',\r\n    'language': 'en',\r\n    'note': 'test Order'\r\n}\r\ntracking51.trackings.createTracking(params)\r\n    .then(result => console.log(result))\r\n    .catch(e => console.log(e))\r\n```\r\n\r\n##### 获取多个物流单号的查询结果\r\nhttps://api.51Tracking.com/v4/trackings/get\r\n```javascript\r\nconst params = {\r\n    'tracking_numbers': '9400111899562539126562,9400111899562537624656',\r\n    'courier_code': 'usps',\r\n    'created_date_min': '2023-08-23T06:00:00+00:00',\r\n    'created_date_max': '2023-09-05T07:20:42+00:00',\r\n}\r\ntracking51.trackings.getTrackingResults(params)\r\n    .then(result => console.log(result))\r\n    .catch(e => console.log(e))\r\n```\r\n\r\n##### 添加多个物流单号（一次调用最多创建 40 个物流单号）\r\nhttps://api.51Tracking.com/v4/trackings/batch\r\n```javascript\r\nconst params = [{\r\n    'tracking_number': '9400111899562537680047',\r\n    'courier_code':'usps'\r\n},{\r\n    'tracking_number': '9400111899562537680048',\r\n    'courier_code':'usps'\r\n}]\r\ntracking51.trackings.batchCreateTrackings(params)\r\n.then(result => console.log(result))\r\n.catch(e => console.log(e))\r\n```\r\n\r\n##### 根据ID更新物流信息\r\nhttps://api.51Tracking.com/v4/trackings/update/{id}\r\n```javascript\r\nconst params = {\r\n    'customer_name': 'New name',\r\n    'note':'New test order note'\r\n}\r\nconst idString = \"9a135b15b5d983e1d8950d99022db0c7\"\r\ntracking51.trackings.updateTrackingByID(idString, params)\r\n.then(result => console.log(result))\r\n.catch(e => console.log(e))\r\n```\r\n\r\n##### 通过ID删除单号\r\nhttps://api.51Tracking.com/v4/trackings/delete/{id}\r\n```javascript\r\nconst idString = \"9a135b15b5d983e1d8950d99022db0c7\"\r\ntracking51.trackings.deleteTrackingByID(idString)\r\n.then(result => console.log(result))\r\n.catch(e => console.log(e))\r\n```\r\n\r\n##### 通过ID重新查询过期的单号\r\nhttps://api.51Tracking.com/v4/trackings/retrack/{id}\r\n```javascript\r\nconst idString = \"99f4ed7fc73aa83fe68fd69ab6458b28\"\r\ntracking51.trackings.retrackTrackingByID(idString)\r\n.then(result => console.log(result))\r\n.catch(e => console.log(e))\r\n```\r\n## Air Waybill\r\n##### 查询航空运单的结果\r\nhttps://api.51Tracking.com/v4/awb\r\n```javascript\r\nconst params = {\r\n    'awb_number': '235-69030430',\r\n}\r\ntracking51.airWaybills.createAnAirWayBill(params)\r\n.then(result => console.log(result))\r\n.catch(e => console.log(e))\r\n```\r\n\r\n## 响应状态码\r\n\r\n51Tracking 使用传统的HTTP状态码来表明 API 请求的状态。通常，2xx形式的状态码表示请求成功，4XX形式的状态码表请求发生错误（比如：必要参数缺失），5xx格式的状态码表示 51tracking 的服务器可能发生了问题。\r\n\r\n\r\nHttp CODE|META CODE|TYPE | MESSAGE\r\n----|-----|--------------|-------------------------------\r\n200    |200     | <code>成功</code>        |    请求响应成功。\r\n400    |400     | <code>错误请求</code>     |    请求类型错误。请查看 API 文档以了解此 API 的请求类型。\r\n400    |4101    | <code>错误请求</code>     |    物流单号已存在。\r\n400    |4102    | <code>错误请求</code>     |    物流单号不存在。请先使用「Create接口」将单号添加至系统。\r\n400    |4103    | <code>错误请求</code>     |    您已超出 API 调用的创建数量。每次创建的最大数量为 40 个快递单号。\r\n400    |4110    | <code>错误请求</code>     |    物流单号(tracking_number) 不符合规则。\r\n400    |4111    | <code>错误请求</code>     |    物流单号(tracking_number)为必填字段。\r\n400    |4112    | <code>错误请求</code>     |    查询ID无效。\r\n400    |4113    | <code>错误请求</code>     |    不允许重新查询。您只能重新查询过期的物流单号。\r\n400    |4120    | <code>错误请求</code>     |    物流商简码(courier_code)的值无效。\r\n400    |4121    | <code>错误请求</code>     |    无法识别物流商。\r\n400    |4122    | <code>错误请求</code>     |    特殊物流商字段缺失或填写不符合规范。\r\n400    |4130    | <code>错误请求</code>     |    请求参数的格式无效。\r\n400    |4160    | <code>错误请求</code>     |    空运单号(awb_number)是必需的或有效的格式。\r\n400    |4161    | <code>错误请求</code>     |    此空运航空不支持查询。\r\n400    |4165    | <code>错误请求</code>     |    查询失败：未创建空运单号。\r\n400    |4166    | <code>错误请求</code>     |    删除未创建的空运单号失败。\r\n400    |4167    | <code>错误请求</code>     |    空运单号已存在，无需再次创建。\r\n400    |4190    | <code>错误请求</code>     |    当前查询额度不足。\r\n401    |401     | <code>未经授权</code>   |    身份验证失败或没有权限。请检查并确保您的 API 密钥正确无误。\r\n403    |403     | <code>禁止</code>      |    禁止访问。请求被拒绝或不允许访问。\r\n404    |404     | <code>未找到</code>       |    页面不存在。请检查并确保您的链接正确无误。\r\n429    |429     | <code>太多请求</code>|    超出 API 请求限制，请稍后重试。请查看 API 文档以了解此 API 的限制。\r\n500    |511     | <code>服务器错误</code>    |    服务器错误。请联系我们： service@51Tracking.org。\r\n500    |512     | <code>服务器错误</code>    |    服务器错误。请联系我们：service@51Tracking.org。\r\n500    |513     | <code>服务器错误</code>    |    服务器错误。请联系我们： service@51Tracking.org。","readmeFilename":"README.md"}