All Projects → FinotiLucas → Correios Brasil

FinotiLucas / Correios Brasil

Licence: apache-2.0
Módulo completo consultar informações sobre o CEP, calcular o preço e os prazos das entregas das encomendas e também realizar o rastreio de multiplos produtos !

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Correios Brasil

Servicestack
Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all
Stars: ✭ 4,976 (+1973.33%)
Mutual labels:  soap, xml
Project Mulla
Talk to MPESA API via a REST API. Bringing the MPESA G2 API to the 21st century. --
Stars: ✭ 282 (+17.5%)
Mutual labels:  soap, xml
Xmlmapper
A simple way to map XML to Objects written in Swift
Stars: ✭ 90 (-62.5%)
Mutual labels:  soap, xml
Soapengine
This generic SOAP client allows you to access web services using a your iOS app, Mac OS X app and AppleTV app.
Stars: ✭ 468 (+95%)
Mutual labels:  soap, xml
Go Xml
utility and code-generation libraries for XML
Stars: ✭ 197 (-17.92%)
Mutual labels:  soap, xml
Bpmn Moddle
Read and write BPMN 2.0 XML from JavaScript.
Stars: ✭ 221 (-7.92%)
Mutual labels:  xml
Slow Cheetah
Tooling for XML and JSON file transforms on build from Visual Studio and MSBuild
Stars: ✭ 227 (-5.42%)
Mutual labels:  xml
Hypertextliteral
Generate HTML, XML, and other web content using Swift string literal interpolation
Stars: ✭ 219 (-8.75%)
Mutual labels:  xml
Biblia
Bíblia: XML + SQL + JSON
Stars: ✭ 211 (-12.08%)
Mutual labels:  xml
Posthtml
PostHTML is a tool to transform HTML/XML with JS plugins
Stars: ✭ 2,737 (+1040.42%)
Mutual labels:  xml
Horaires Ratp Api
Webservice pour les horaires et trafic RATP en temps réel
Stars: ✭ 232 (-3.33%)
Mutual labels:  xml
Apiproblem
A simple implementation of the api-problem specification. Includes PSR-15 support.
Stars: ✭ 225 (-6.25%)
Mutual labels:  xml
Fulltext
Search across and get full text for OA & closed journals
Stars: ✭ 221 (-7.92%)
Mutual labels:  xml
Libyang
YANG data modeling language library
Stars: ✭ 227 (-5.42%)
Mutual labels:  xml
Renderer
Simple, lightweight and faster response (JSON, JSONP, XML, YAML, HTML, File) rendering package for Go
Stars: ✭ 220 (-8.33%)
Mutual labels:  xml
Il Ilce Mahalle Sokak Cadde Sql
Türkiye İl, İlçe, Mahalle, Sokak, Cadde Bilgisi SQL Şeklinde
Stars: ✭ 235 (-2.08%)
Mutual labels:  xml
Codejam
Set of handy reusable .NET components that can simplify your daily work and save your time when you copy and paste your favorite helper methods and classes from one project to another
Stars: ✭ 217 (-9.58%)
Mutual labels:  xml
Parse
Go parsers for web formats
Stars: ✭ 224 (-6.67%)
Mutual labels:  xml
Xmlunit
XMLUnit for Java 2.x
Stars: ✭ 232 (-3.33%)
Mutual labels:  xml
Nusoap
😏 Fixed NuSOAP for PHP 5.6 - 8.0
Stars: ✭ 224 (-6.67%)
Mutual labels:  soap

Correios Brasil -- VERSÃO 2.1.1


Descomplicando os Correios! 📬

Made by Lucas Finoti License

NPM


O que é o Correios Brasil ?

O Correios Brasil é uma ferramenta completa para quem procura facilidade para sua aplicação, otimizando sua loja virtual e seu serviço como: consultar informações sobre o CEP, calcular o preço e os prazos das entregas das encomendas e também realizar seu rastreio tudo em um único lugar, agilizando assim os processos e demandas do dia a dia. Portanto, poupando seu tempo, por isso aproveite o pacote e não esqueça de deixar uma estrela no repositório, obrigado!

Medium storie explicando o pacote.

License

O que o Correios-Brasil é capaz de fazer ?

  • Obter informações de um CEP específico (Em dev: informações de multiplos CEPs);
  • Cálcular preços e prazos para uma entrega em todos os serviços dos correios (PAC, SEDEX e etc);
  • Rastreio uma ou mais encomendas.

Como instalar

npm install correios-brasil --save
 

Typescript

Por padrão essa bibilioteca inclui uma definição de tipo para o Typescript. Para utilizá-la, basta importar da seguinte maneira.

import { correiosBrasil } from "correios-brasil";

Como consultar um CEP

const { consultarCep } = require("correios-brasil");

// Cep pode ser String ou Number
const cep = "21770200"; // 21770200 , '21770-200', '21770 200'.... qualquer um formato serve

consultarCep(cep).then((response) => {
  console.log(response);
});

Resposta

{
  cep: '21770-200',
  logradouro: 'Rua Claudino Barata',
  complemento: '',
  bairro: 'Realengo',
  localidade: 'Rio de Janeiro',     
  uf: 'RJ',
  ibge: '3304557',
  gia: '',
  ddd: '21',
  siafi: '6001'
}

Como consultar o preço e o prazo de entrega de uma encomenda

const { calcularPrecoPrazo } = require("correios-brasil"); 

let  args = {
  // Não se preocupe com a formatação dos valores de entrada do cep, qualquer uma será válida (ex: 21770-200, 21770 200, [email protected]###200 e etc),
  sCepOrigem:  "81200100",
  sCepDestino:  "21770200",
  nVlPeso:  "1",
  nCdFormato:  "1",
  nVlComprimento:  "20",
  nVlAltura:  "20",
  nVlLargura:  "20",
  nCdServico:  ["04014",'04510'], //Array com os códigos de serviço
  nVlDiametro:  "0",
};

calcularPrecoPrazo(args).then((response) => {
  console.log(response);
});

Resposta

{
  '0': {
    Codigo: '04014',
    Valor: '53,10',
    PrazoEntrega: '8',
    ValorSemAdicionais: '53,10',
    ValorMaoPropria: '0,00',
    ValorAvisoRecebimento: '0,00',
    ValorDeclarado: '0,00',
    EntregaDomiciliar: 'S',
    EntregaSabado: 'S',
    obsFim: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
    Erro: '011',
    MsgErro: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.'
  },
  '1': {
    Codigo: '04510',
    Valor: '27,80',
    PrazoEntrega: '12',
    ValorSemAdicionais: '27,80',
    ValorMaoPropria: '0,00',
    ValorAvisoRecebimento: '0,00',
    ValorDeclarado: '0,00',
    EntregaDomiciliar: 'S',
    EntregaSabado: 'S',
    obsFim: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.',
    Erro: '011',
    MsgErro: 'O CEP de destino está sujeito a condições especiais de entrega  pela  ECT e será realizada com o acréscimo de até 7 (sete) dias úteis ao prazo regular.'
  }
}

Como rastrear uma ou mais encomendas

const { rastrearEncomendas } = require('correios-brasil')

let  codRastreio = ['PW639018542BR', 'PW935793588BR'] // array de códigos de rastreios

rastrearEncomendas(codRastreio).then((response) => {
  console.log(response);
});

Resposta

{
  '0': [
    {
      status: 'Objeto postado',
      data: '14/04/2020',
      hora: '14:28',
      local: 'AGF VILA PREL - Sao Paulo / SP'     
    },
    {
      status: 'Objeto encaminhado',
      data: '15/04/2020',
      hora: '09:03',
      origem: 'AGF VILA PREL - Sao Paulo / SP',   
      destino: 'CTE CAJAMAR - Cajamar / SP'       
    },
    {
      status: 'Objeto encaminhado',
      data: '15/04/2020',
      hora: '22:18',
      origem: 'CTE CAJAMAR - Cajamar / SP',       
      destino: 'CTE BENFICA - Rio De Janeiro / RJ'
    },
    {
      status: 'Objeto encaminhado',
      data: '16/04/2020',
      hora: '10:04',
      origem: 'CTE BENFICA - Rio De Janeiro / RJ',
      destino: 'CDD ITAGUAI - Itaguai / RJ'
    },
    {
      status: 'Objeto saiu para entrega ao destinatário',
      data: '17/04/2020',
      hora: '08:06',
      local: 'CDD ITAGUAI - Itaguai / RJ'
    },
    {
      status: 'Objeto entregue ao destinatário',
      data: '17/04/2020',
      hora: '11:12',
      local: 'CDD ITAGUAI - Itaguai / RJ'
    }
  ],
  '1': [
    {
      status: 'Objeto postado após o horário limite da unidade',
      data: '05/05/2020',
      hora: '18:17',
      local: 'AGF CIDADE DAS ROSAS - Sapiranga / RS'
    },
    {
      status: 'Objeto encaminhado',
      data: '05/05/2020',
      hora: '18:29',
      origem: 'AGF CIDADE DAS ROSAS - Sapiranga / RS',
      destino: 'CTCE PORTO ALEGRE - Porto Alegre / RS'
    },
    {
      status: 'Objeto encaminhado',
      data: '09/05/2020',
      hora: '03:05',
      origem: 'CTE CAJAMAR - Cajamar / SP',
      destino: 'CTE BENFICA - Rio De Janeiro / RJ'
    },
    {
      status: 'Objeto encaminhado',
      data: '12/05/2020',
      hora: '13:54',
      origem: 'CTE BENFICA - Rio De Janeiro / RJ',
      destino: 'CDD ITAGUAI - Itaguai / RJ'
    },
    {
      status: 'Objeto saiu para entrega ao destinatário',
      data: '13/05/2020',
      hora: '10:18',
      local: 'CDD ITAGUAI - Itaguai / RJ'
    },
    {
      status: 'Objeto entregue ao destinatário',
      data: '13/05/2020',
      hora: '13:22',
      local: 'CDD ITAGUAI - Itaguai / RJ'
    }
  ]
}

Argumentos para a consulta da API

  • codRastreio - Array[String]

String com o código de rastreio

  • nCdServico - Array[String]

Código do serviço:

  • 04014 = SEDEX à vista

  • 04065 = SEDEX à vista pagamento na entrega

  • 04510 = PAC à vista

  • 04707 = PAC à vista pagamento na entrega

  • 40169 = SEDEX12 ( à vista e a faturar)

  • 40215 = SEDEX 10 (à vista e a faturar)

  • 40290 = SEDEX Hoje Varejo

  • sCepOrigem - String/Number

CEP de Origem. Exemplo: 05311900

  • sCepDestino - String/Number

CEP de Destino

  • nVlPeso - String

Peso da encomenda, incluindo sua embalagem. O peso deve ser informado em quilogramas. Se o formato for Envelope, o valor máximo permitido será 1 kg

  • nCdFormato - Inteiro

Formato da encomenda (incluindo embalagem)

  • 1 = Formato caixa/pacote

  • 2 = Formato rolo/prisma

  • 3 = Envelope

  • nVlComprimento - Decimal

Comprimento da encomenda (incluindo embalagem), em centímetros

  • nVlAltura - Decimal

Altura da encomenda (incluindo embalagem), em centímetros. Se o formato for envelope, informar zero (0)

  • nVlLargura - Decimal

Largura da encomenda (incluindo embalagem), em centímetros

  • nVlDiametro - Decimal

Diâmetro da encomenda (incluindo embalagem), em centímetros

  • sCdMaoPropria - String

Indica se a encomenda será entregue com o serviço adicional mão própria

  • S = sim

  • N = não PADRÃO

  • nVlValorDeclarado - Decimal

Indica se a encomenda será entregue com o serviço adicional valor declarado. Neste campo deve ser apresentado o valor declarado desejado, em Reais

  • sCdAvisoRecebimento - String

Indica se a encomenda será entregue com o serviço adicional mão própria

  • S = sim

  • N = não PADRÃO

O que está em desenvolvimento ?

  • Receber respostas de multiplas API's e retornar a primeira resposta 🟡.

  • Atualizar o package.json e o README.md 🟢.

♻️ Como contribuir

  • Fork esse repositório;
  • Crie uma branch com a sua feature: git checkout -b my-feature
  • Commit suas mudanças: git commit -m 'feat: My new feature'
  • Push a sua branch: git push origin my-feature

📝 Licença

Apache License 2.0

Copyright (c) 2020 Lucas Finoti

See more about the license

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].