Bem-vindo à documentação da API do Melhor Envio.

A API do Melhor Envio viabiliza a integração junto à Plataformas de E-commerce, Marketplaces, ERPs, Hubs, etc.

Para integrar com o Melhor Envio é gratuito, não cobramos taxas ou mensalidades pela utilização da nossa API. Agimos dessa forma justamente para facilitar a vida de nossos usuários ao integrarem com nossos serviços, junto aos fluxos de seus sistemas.

Caso você seja um cliente do Melhor Envio e queira apenas utilizar os nossos serviços dentro do seu e-commerce, verifique primeiro se sua plataforma já possui integração com nosso sistema. Se ainda não possuir, entre em contato conosco para que possamos analisar a viabilidade de uma parceria. Agora, se você possuir uma Loja de desenvolvimento próprio e também quiser integrar com o Melhor Envio, basta disponibilizar o link deste conteúdo para seu desenvolvedor.

Seja um Parceiro Verificado

Você pode começar a integrar com a nossa API, conforme a documentação, e caso você deseje se tornar um Parceiro Verificado, acesse nossa Landing Page de Parceiros, para mais informações. Nosso time de Parcerias irá lhe ajudar a encontrar a modalidade de integração mais adequada ao seu modelo de negócio.

Acesse também o infográfico da Jornada do Parceiro, para conhecer o nosso fluxo de integração.

Suporte

Se você não encontrar alguma informação aqui, ou mesmo que encontre e ainda tenha dúvidas sobre algum processo específico, fique à vontade para entrar em contato com o nosso suporte especializado, através do e-mail [email protected].

🚧
Atenção
A equipe do Melhor Envio não presta serviços de consultoria, por isso, não analisaremos códigos em nosso suporte.

Sandbox

O Melhor Envio disponibiliza um ambiente desenvolvido exclusivamente para a realização de testes, que também chamamos de Melhor Envio Sandbox.

Neste ambiente, é possível realizar requisições para nossa API sem receio de cometer qualquer erro. Observe que, como este ambiente serve apenas para teste, não é possível realizar qualquer envio na vida real com as transportadoras parceiras utilizando as etiquetas geradas através dele.

Para começar a realizar testes no ambiente sandbox, será necessário um cadastro no mesmo. Esse cadastro é simplificado, diferente de um cadastro real na plataforma do Melhor Envio, e nele você terá um saldo inicial de R$10.000,00 para gerar etiquetas no modo teste.

Após o cadastro, a integração se dará através de aplicativo. O fluxo do ambiente de homologação é válido também para o ambiente de produção.

❗️
Importante
Os ambientes de produção e sandbox são distintos e sem qualquer relação entre dados de cadastro ou envios, impossibilitando o uso do mesmo aplicativo e do mesmo usuário entre eles, sendo necessária a criação de contas separadas. Ou seja, você pode se cadastrar em ambos os ambientes com os mesmos dados, mas serão informações completamente desconectadas.

O Sandbox do Melhor Envio não possui todas as funcionalidades que a plataforma oferece no ambiente em produção, estando limitado somente para simulações de envios com as transportadoras Correios e JadLog, e para pagamentos via Yapay ou com saldo disponível na Melhor Carteira. Em sandbox, os pagamentos não serão faturados, e terão sua aprovação automática em até 5 minutos após a requisição.

Envios gerados terão o status modificado para postado após 15 minutos da geração das etiquetas, sendo atualizados para entregue após mais 15 minutos. Essa modificação de status ocorrerá juntamente com a conferência de postagem gerando créditos ou débitos de modo aleatório, simulando um comportamento real de repesagem pela transportadora.

Principais particularidades ou limitações do ambiente Sandbox

Cadastro simplificado, com aprovação automática e saldo inicial para testes;
Inserção de saldo e pagamentos sem comunicação real com meios de pagamento, aprovando automaticamente as transações após 5 minutos (fluxo pela API também é limitado);
Apenas 2 transportadoras e 2 meios de pagamento disponíveis;
Processamento automático dos envios, trocando de status com intervalos de 15 minutos;
Listagens de agências e unidades própria, apenas para testes.

Observações

Tokens fornecidos via autenticação OAuth2 possuem validade de 30 dias e devem ser atualizados via refresh_token que possui validade de 45 dias.

Todas as respostas seguem o formato JSON com os seus respectivos códigos de status do protocolo HTTP. Payloads para requisições, com exceção do método GET, devem ser realizadas obrigatoriamente no corpo da requisição e codificados como JSON. Todas as requisições devem utilizar o protocolo HTTPS.

📘
Considerações importantes

A URL base do endpoint de produção é: https://melhorenvio.com.br;

A URL base do endpoint de sandbox é: https://sandbox.melhorenvio.com.br;

Envie o cabeçalho HTTP Accept (Accept: application/json) e Content-Type (Content-Type: application/json), com exceção para rotas de autenticação OAuth2;

É obrigatório que seja adicionado o cabeçalho HTTP User-Agent com o nome da sua aplicação junto a um email de contato/suporte. Exemplo: “Melhor Envio ([email protected])”.