correios-brasil

v3.0.6

Published

a year ago

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 seu rastreio

Downloads

4,449

Correios Brasil -- VERSÃO 3.0.6

Descomplicando os Correios! 📬

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.

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 {
  calcularPrecoPrazo,
  consultarCep,
  rastrearEncomendas,
} 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, 21asa!770@###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

[
  {
    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.',
  },
  {
    Codigo: '04510',
    Valor: '27,80',
    PrazoEntrega: '13',
    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 = ['OU341933668BR', 'LB290784401HK']; // array de códigos de rastreios

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

Resposta

[
  [
    {
      codObjeto: 'OU341933668BR',
      eventos: [Array],
      modalidade: 'F',
      tipoPostal: [Object],
      habilitaAutoDeclaracao: false,
      permiteEncargoImportacao: false,
      habilitaPercorridaCarteiro: false,
      bloqueioObjeto: false,
      possuiLocker: false,
      habilitaLocker: false,
      habilitaCrowdshipping: false,
    },
  ],
  [
    {
      codObjeto: 'LB290784401HK',
      eventos: [Array],
      modalidade: 'V',
      tipoPostal: [Object],
      habilitaAutoDeclaracao: false,
      permiteEncargoImportacao: false,
      habilitaPercorridaCarteiro: false,
      bloqueioObjeto: false,
      possuiLocker: false,
      habilitaLocker: false,
      habilitaCrowdshipping: false,
    },
  ],
];

Detalhes dos eventos de rastreio

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

let codRastreio = ['OU341933668BR', 'LB290784401HK']; // array de códigos de rastreios

rastrearEncomendas(codRastreio).then(response => {
  console.log(response[0].eventos.reverse());
  // O reverse é apenas para organizarmos os dados do rastreio do mais antigo para o mais recente !
});

Resposta

[
  {
    codigo: 'PO',
    descricao: 'Objeto postado',
    dtHrCriado: '2022-06-07T17:14:43',
    tipo: '01',
    unidade: { endereco: [Object], tipo: 'Agência dos Correios' },
    urlIcone: '/public-resources/img/agencia-cor.png',
  },
  {
    codigo: 'RO',
    descricao: 'Objeto em trânsito - por favor aguarde',
    dtHrCriado: '2022-06-07T18:17:02',
    tipo: '01',
    unidade: { endereco: [Object], tipo: 'Agência dos Correios' },
    unidadeDestino: { endereco: [Object], tipo: 'Unidade de Tratamento' },
    urlIcone: '/public-resources/img/caminhao-cor.png',
  },
  {
    codigo: 'OEC',
    descricao: 'Objeto saiu para entrega ao destinatário',
    dtHrCriado: '2022-06-08T09:02:32',
    tipo: '01',
    unidade: { endereco: [Object], tipo: 'Unidade de Distribuição' },
    urlIcone: '/public-resources/img/pre-atendimento-cor.png',
  },
  {
    codigo: 'BDE',
    descricao: 'Objeto entregue ao destinatário',
    dtHrCriado: '2022-06-08T12:36:43',
    tipo: '01',
    unidade: { endereco: [Object], tipo: 'Unidade de Distribuição' },
    urlIcone: '/public-resources/img/smile.png',
  },
];

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 🟢.

:recycle: 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

:memo: Licença

Apache License 2.0

See more about the license

💪 Contribuidores

| @jonabf1 | @francopan | @ivanseidel | @GGalupo | | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

🚀 Autor

| @finotilucas | | ------------------------------------------------------------------------------------------------------------------------------------ |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Correios Brasil -- VERSÃO 3.0.6

O que é o Correios Brasil ?

Medium storie explicando o pacote.

O que o Correios-Brasil é capaz de fazer ?

Como instalar

Typescript

Como consultar um CEP

Resposta

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

Resposta

Como rastrear uma ou mais encomendas

Resposta

Detalhes dos eventos de rastreio

Resposta

Argumentos para a consulta da API

O que está em desenvolvimento ?

:recycle: Como contribuir

:memo: Licença

💪 Contribuidores

🚀 Autor