sweettracker

๐Ÿ“ฆ - Unofficial sweettracker SDK for Node.js

Usage no npm install needed!

<script type="module">
  import sweettracker from 'https://cdn.skypack.dev/sweettracker';
</script>

README

SweetTracker(์Šค์œ—ํŠธ๋ž˜์ปค) SDK

๐Ÿ“ฆ - Unofficial sweettracker SDK for Node.js

SweetTracker SDK for Asynchronous Node.js. You can easily search for delivery information.

Table of Contents

How does it work?


Use Sweet Tracker API to track shipment status. if you do not have an API KEY, click here to register as a member.

Install


Use NPM

$ npm install sweettracker

Or Yarn

$ yarn add sweettracker

Usage


Create SweetTracker Client

import SweetTracker from 'sweettracker';

const tracker = new SweetTracker('{ WRITE YOUR SWEET TRACKER API KEY }');

Get Companies

import SweetTracker from 'sweettracker';

const tracker = new SweetTracker('{ WRITE YOUR SWEET TRACKER API KEY }');
const companies = await tracker.getCompanies().then(console.log);

If no error occurs, the following response will come.

[
  { "id": "04", "name": "CJ๋Œ€ํ•œํ†ต์šด" },
  { "id": "05", "name": "ํ•œ์ง„ํƒ๋ฐฐ" },
  { "id": "08", "name": "๋กฏ๋ฐํƒ๋ฐฐ" },
  ...
]

Get Recommended Companies

import SweetTracker from 'sweettracker';

const tracker = new SweetTracker('{ WRITE YOUR SWEET TRACKER API KEY }');
const companies = await tracker
  .getRecommendedCompanies('{ WRITE YOUR TRACKING NUMBER }')
  .then(console.log);

If no error occurs, the following response will come.

[
  { "id": "04", "name": "CJ๋Œ€ํ•œํ†ต์šด" },
  { "id": "05", "name": "ํ•œ์ง„ํƒ๋ฐฐ" },
  { "id": "08", "name": "๋กฏ๋ฐํƒ๋ฐฐ" },
  ...
]

Get Tracking Information

import SweetTracker from 'sweettracker';

const tracker = new SweetTracker('{ WRITE YOUR SWEET TRACKER API KEY }');
const companies = await tracker
  .getTracking('{ WRITE COMPANY ID }', '{ WRITE YOUR TRACKING NUMBER }')
  .then(console.log);

If no error occurs, the following response will come.

{
  "status": "arrived",
  "receiver": {},
  "item": {},
  "details": [
    {
      "timestamp": "2020-11-13T03:25:00.000Z",
      "kind": "Shipping Label Created, USPS Awaiting Item",
      "where": "FORT LAUDERDALE, FL 33351",
      "status": "collected",
      "phoneNumber": [],
      "courier": {}
    }
    ...
  ]
}

License

MIT

Copyright (c) 2020 Daniel Uhm.