Giter VIP home page Giter VIP logo

sro-correios's Introduction

📦 SroCorreios

SroCorreios is a JavaScript library for tracking orders through Correios (BR).

npm version unpacked size contributions welcome License types included

Installation

Use the node package manager to install sro-correios.

npm install sro-correios

Usage

import { SroCorreios } from 'sro-correios'

const tracker = new SroCorreios()

async function trackSingleCode() {
  const [result] = await tracker.track('LB711320125HK')
  console.log(result)
}

trackSingleCode()

async function trackMultipleCodes() {
  const [result] = await tracker.track(['LE463132624SE', 'LB711320125HK', 'OS803953581BR'])
  console.log(result)
}

trackMultipleCodes()

Result

Success ✔

[
  {
    code: 'LB711320125HK',
    category: {
      name: 'Prime Importação',
      description: 'Objeto Internacional Prime'
    },
    isDelivered: false,
    postedAt: 2022-03-18T17:55:00.000Z,
    updatedAt: 2022-03-22T22:26:08.000Z,
    events: [
      {
        locality: 'Curitiba / PR',
        status: 'Objeto em trânsito - por favor aguarde',     
        origin: 'Unidade de Tratamento - Curitiba / PR',      
        destination: 'Unidade de Tratamento - São Paulo / SP',
        trackedAt: 2022-03-22T22:26:08.000Z
      },
      {
        locality: 'Curitiba / PR',
        status: 'Fiscalização aduaneira finalizada',
        origin: 'Unidade Operacional - Curitiba / PR',        
        destination: null,
        trackedAt: 2022-03-22T22:24:08.000Z
      },
      {
        locality: 'Curitiba / PR',
        status: 'Objeto recebido pelos Correios do Brasil',   
        origin: 'Unidade Operacional - Curitiba / PR',        
        destination: null,
        trackedAt: 2022-03-22T14:53:37.000Z
      },
      {
        locality: null,
        status: 'Objeto em trânsito - por favor aguarde',
        origin: 'Hong Kong',
        destination: 'Unidade De Tratamento Internacional',
        trackedAt: 2022-03-19T17:03:00.000Z
      },
      {
        locality: null,
        status: 'Objeto postado',
        origin: 'Hong Kong',
        destination: null,
        trackedAt: 2022-03-18T17:55:00.000Z
      }
    ]
  }
]

Errors ❌

// Package was not found.
[
  {
    code: 'LB711320125HK',
    isInvalid: true,
    error: 'not_found'
  }
]
// Package code is invalid.
[
  {
    code: '123ADE',
    isInvalid: true,
    error: 'invalid_code'
  }
]
// Correios service is unavailable.
[
  {
    code: 'LB711320125HK',
    isInvalid: true,
    error: 'service_unavailable'
  }
]

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

SroCorreios is fully open and is under MIT license.

sro-correios's People

Contributors

victoralvesf avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.