README

Biblioteca para a facilitação do cálculo de preços e prazos de entregas, usando a API disponibilizada pelos Correios. E realização de consultas de endereços por CEP, através do VIACEP.

Funcionalidades

CEP
Frete
Rastreio de encomenda

Instalação

Via Composer

$ composer require sprained/calculo-frete

Uso

Consulta pelo CEP

Encontra endereço pelo CEP, consultando diretamente no VIACEP;

require 'vendor/autoload.php';

use Sprained\Correios\Cep;

$cep = new Cep();

/*
    Retorna endereço pelo CEP
    Parâmetro: CEP com hífen ou sem o mesmo
*/
$retorno = $cep->cep('51021-020');

/*
stdClass Object
(
    [cep] => 51021-020
    [logradouro] => Avenida Conselheiro Aguiar
    [complemento] => de 3812/3813 ao fim
    [bairro] => Boa Viagem
    [localidade] => Recife
    [uf] => PE
    [ibge] => 2611606
    [gia] => 
    [ddd] => 81
    [siafi] => 2531
)
*/

Calculo frete

Calcula o prazo e preço da entrega por meio da API disponibilizada pelos Correio.

require 'vendor/autoload.php';

use Sprained\Correios\Frete;
use Sprained\Correios\Service;

$frete = new Frete();

/*
    Array de itens para cálculo do frete
    Parâmetros em ordem:
    largura, altura, comprimento, peso, quantidade (caso conter mais de um item)
*/
$items = [
    [16, 16, 16, 16],
    [16, 16, 16, 16]
];

/*
    Cálculo frete e prazo para entrega

    Campos Obrigatórios
    origem: cep de origem da encomenda
    destino: cep de destino para entrega da encomenda
    items: array de itens a enviar
    servico: tipo do serviço utilizado para entrega dos itens
    calculo: faz o cálculo e retorna o valor

    Campos Não Obrigatórios
    pacote: informa tipo de pacote (caixa, prisma, envelope), por padrão se encontra em caixa
    entregaEmMaos: informa que a encomenda será entregue com serviço mão propria
    valorDeclarado: informa que encomenda será entregue com serviço valor declarado
    credenciais: código administrativo junto à ECT, disponivel no corpo do contrato do Correios 

    Serviços de Entregas
    Service::PAC
    Service::SEDEX
    Service::SEDEX_10
    Service::SEDEX_12
    Service::SEDEX_HOJE
    Para serviços de entregas adicionais, passar numeração do serviço informado no contrato com correios
*/
$retorno = $frete->origem('51021020')
                ->destino('50060230')
                ->servico(Service::SEDEX, Service::PAC)
                ->items($items)
                ->calculo();

/*
Array
(
    [0] => Array
        (
            [codigo] => 4
            [valor] => 169,30
            [prazo] => 1 Dias
        )

    [1] => Array
        (
            [codigo] => 4
            [valor] => 151,70
            [prazo] => 5 Dias
        )
)
*/

Rastreio de encomenda

Rastreia a encomenda retornando as informações de rastreio.

require 'vendor/autoload.php';

use Sprained\Correios\Tracking;
use Sprained\Correios\Exceptions\TrackingException;

try {
    $track = new Tracking();

    print_r($track->tracking('LB208326091SG'));
} catch(TrackingException $e) {
    http_response_code($e->getCode());
    echo $e->getMessage();
}

/*
{
    "code": "LB208326091SG",
    "last_status": "Objeto em trânsito - por favor aguarde",
    "last_date": "03/02/2021 14:49",
    "last_locale": "CTCE FORTALEZA - Fortaleza / CE",
    "tracking": [
        {
        "status": "Objeto em trânsito - por favor aguarde",
        "date": "03/02/2021 14:49",
        "local": "CTCE FORTALEZA - Fortaleza / CE",
        "destino": "CTE RECIFE - Recife / PE"
        },
        {
        "status": "Objeto em trânsito - por favor aguarde",
        "date": "29/01/2021 14:26",
        "local": "UNIDADE INTERNACIONAL CURITIBA - Curitiba / PR",
        "destino": "CTE CAJAMAR - Cajamar / SP"
        },
        {
        "status": "Fiscalização aduaneira finalizada",
        "date": "29/01/2021 14:24",
        "local": "UNIDADE INTERNACIONAL CURITIBA - Curitiba / PR"
        },
        {
        "status": "Objeto recebido pelos Correios do Brasil",
        "date": "29/01/2021 10:44",
        "local": "UNIDADE INTERNACIONAL CURITIBA - Curitiba / PR"
        },
        {
        "status": "Objeto em trânsito - por favor aguarde",
        "date": "09/01/2021 11:47",
        "local": "CINGAPURA -  /",
        "destino": "Unidade de Tratamento Internacional -  / BR"
        }
    ]
}
*/

sprained / calculo-frete

Maintainers

Details