Obter saldo no Melhor Envio, por uma API
Retorna o saldo da carteira do Melhor Envio em BRL, com o valor reservado e as dívidas. Comprar etiquetas gasta esse saldo.
- Identificador
- melhor_envio_get_balance
A chamada
POST https://connect.reportei.com/api/tools/melhor_envio_get_balance/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
Esta tool não recebe argumentos.
Conexões possíveis
O seu cliente conecta a conta do Melhor Envio uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/melhor_envio, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/melhor_envio_get_balance. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Melhor Envio
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
