Tools do Melhor Envio
As 12 operações do Melhor Envio que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Calcular fretePOSTCota o frete de produtos entre dois CEPs e retorna uma entrada por serviço, com id, transportadora, preço, prazo de entrega, os pacotes e um error quando o serviço não atende a rota. custom_price e custom_delivery_time incluem as taxas e descontos da conta. Só os serviços habilitados para a integração no painel do Melhor Envio são cotados.
- Criar item no carrinhoPOSTAdiciona uma etiqueta ao carrinho da conta e a retorna. O id dela é o id da etiqueta nas outras ferramentas. Nada é pago até Comprar etiquetas. Correios, J&T e Loggi aceitam um volume por chamada: para mais pacotes, adicione um item por pacote.
- Listar itens do carrinhoGETLista as etiquetas do carrinho que ainda não foram pagas, com id, serviço, preço, remetente, destinatário e volumes. As etiquetas ficam 20 dias no carrinho. 10 por página: passe page para as próximas, até last_page.
- Excluir item do carrinhoDELETERemove do carrinho uma etiqueta que ainda não foi paga.
- Comprar etiquetasPOSTPaga etiquetas do carrinho com o saldo da carteira do Melhor Envio e retorna a compra, com o total e as etiquetas, já liberadas. A carteira precisa ter saldo suficiente: confira com Obter saldo. Etiquetas pagas ainda precisam de Gerar etiquetas.
- Gerar etiquetasPOSTGera etiquetas pagas, o que é necessário antes de Imprimir etiquetas, e retorna o resultado de cada id. Uma etiqueta gerada deve ser postada em até 20 dias, ou 7 dias com os Correios.
- Imprimir etiquetasPOSTRetorna um link para imprimir etiquetas geradas. Um link privado abre só para quem está logado na conta do Melhor Envio; um link público abre para qualquer pessoa que o tenha.
- Listar etiquetasGETLista as etiquetas da conta com id, protocolo, status, serviço, preço, código de rastreio e as datas de pagamento, geração, postagem e entrega. 10 por página: passe page para as próximas, até last_page.
- Obter etiquetaGETRetorna uma etiqueta com status, serviço, preço, remetente, destinatário, volumes, código de rastreio e as datas de pagamento, geração, postagem e entrega.
- Buscar etiquetasGETEncontra etiquetas por um valor exato: o id, o protocolo, o código de rastreio, o código de autorização, ou o CPF ou CNPJ do remetente ou do destinatário.
- Cancelar etiquetaPOSTCancela uma etiqueta. Uma etiqueta gerada só pode ser cancelada antes de ser postada e antes de a transportadora ser avisada de uma coleta; o reembolso de uma etiqueta gerada chega 12 horas após a aprovação.
- Obter saldoGETRetorna o saldo da carteira do Melhor Envio em BRL, com o valor reservado e as dívidas. Comprar etiquetas gasta esse saldo.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
