Skip to content

Latest commit

 

History

History
243 lines (201 loc) · 7.85 KB

README.md

File metadata and controls

243 lines (201 loc) · 7.85 KB
Raw

Delibee

NPM Version NPM Downloads Build Status Test Coverage

delibee
Delivery tracking library on Node.js.

Prerequisites

Node.js >= 7.6

Required Server Dependencies

NOTE: Sometimes Delibee use Headless Chrome. (e.g. CJ대한통운)

Debian (e.g. Ubuntu)

sudo apt-get install -yq gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget

CentOS

sudo yum install pango.x86_64 libXcomposite.x86_64 libXcursor.x86_64 libXdamage.x86_64 libXext.x86_64 libXi.x86_64 libXtst.x86_64 cups-libs.x86_64 libXScrnSaver.x86_64 libXrandr.x86_64 GConf2.x86_64 alsa-lib.x86_64 atk.x86_64 gtk3.x86_64 ipa-gothic-fonts xorg-x11-fonts-100dpi xorg-x11-fonts-75dpi xorg-x11-utils xorg-x11-fonts-cyrillic xorg-x11-fonts-Type1 xorg-x11-fonts-misc -y

Issues

Feel free to submit issues and enhancement requests.

Usage

npm install delibee

On Express Framework

const express = require('express')
const delibee = require('delibee')({
  timeout: 10000, // default timeout value is '10000'
  locale: 'en' // default locale is 'ko'
})
const app = express()

app.get('/tracking/companies', async (req, res) => {
  const companies = await delibee.company()
  res.send(companies)
})

app.get('/tracking', async (req, res) => {
  const company = req.query.company
  const invoiceNo = req.query.invoice_no
  const invoice = await delibee.tracking(company, invoiceNo)
  res.send(invoice)
})

app.listen(3000)

Http Request Example

http://127.0.0.1:3000/tracking?company={delivery_company_code}&invoice_no={invoice_number}

Delivery Company Code

Company Name Comapny Code
우체국택배 EPOST
CJ대한통운 CJ
한진택배 HANJIN
롯데택배 (구. 현대택배) LOTTE
로젠택배 LOGEN
드림택배 (구. KG로지스) DREAM
CVSnet 편의점택배 CVSNET
CU 편의점택배 CU

Response

Key Description
deliveryCompany 택배회사정보
invoiceNumber 송장번호
senderName 보낸이
senderAddr 출발지/주소
receiverName 받는이
receiverAddr 도착지/주소
statusCode 배송상태코드
statusText 배송상태
history 배송내역

DeliveryCompany

Key Description
code 택배회사코드
name 택배회사

History

Key Description
dateTime 시간 (timestamp)
dateString 시간 (YYYY.MM.DD HH:mm)
location 위치
tel 전화번호
remark 택배사 제공 배송상태
statusCode 배송상태코드
statusText 배송상태

Status

StatusCode StatusText
-1 알수없음
10 접수대기
11 잔류
20 접수
30 집하
40 배송중(출고)
50 배송중(입고)
55 오도착
60 배달준비중
65 배달중
70 배달완료
71 미배달
80 인수확인

Response Expample

{
  "success": true,
  "invoice": {
    "deliveryCompany": {
      "code": "CJ",
      "name": "CJ대한통운"
    },
    "invoiceNumber": "612566673760",
    "senderName": "테*",
    "senderAddr": "",
    "receiverName": "이*",
    "receiverAddr": "",
    "history": [
      {
        "dateTime": 1512043020000,
        "dateString": "2017.11.30 20:57",
        "location": "인천가좌심곡",
        "tel": "",
        "remark": "보내시는 고객님으로부터 상품을 인수받았습니다",
        "statusCode": 20,
        "statusText": "접수"
      },
      {
        "dateTime": 1512055800000,
        "dateString": "2017.12.01 00:30",
        "location": "부평",
        "tel": "",
        "remark": "물류터미널로 상품이 이동중입니다.",
        "statusCode": 40,
        "statusText": "배송중(출고)"
      },
      {
        "dateTime": 1512124740000,
        "dateString": "2017.12.01 19:39",
        "location": "대전HUB",
        "tel": "",
        "remark": "배송지역으로 상품이 이동중입니다.",
        "statusCode": 40,
        "statusText": "배송중(출고)"
      },
      {
        "dateTime": 1512168420000,
        "dateString": "2017.12.02 07:47",
        "location": "덕진",
        "tel": "",
        "remark": "고객님의 상품이 배송지에 도착하였습니다.(배송예정:--)",
        "statusCode": 50,
        "statusText": "배송중(입고)"
      },
      {
        "dateTime": 1512178800000,
        "dateString": "2017.12.02 10:40",
        "location": "전북전주송천",
        "tel": "",
        "remark": "고객님의 상품을 배송할 예정입니다.(11∼13시)(배송담당:--)",
        "statusCode": 65,
        "statusText": "배달중"
      },
      {
        "dateTime": 1512180420000,
        "dateString": "2017.12.02 11:07",
        "location": "전북전주송천",
        "tel": "",
        "remark": "고객님의 상품이 배송완료 되었습니다.(담당사원:--)",
        "statusCode": 70,
        "statusText": "배달완료"
      }
    ],
    "statusCode": 70,
    "statusText": "배달완료"
  }
}

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/moodselah/delibee

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Contributors

Company Name Contributor
우체국택배 @moodselah
CJ대한통운 @moodselah
한진택배 @moodselah
롯데택배 (구. 현대택배) @moodselah
로젠택배 @moodselah
드림택배 (구. KG로지스) @moodselah
CVSnet 편의점택배 @moodselah
CU 편의점택배 @moodselah

License

MIT LICENSE