• A API oferece os seguintes tipos de entregas disponíveis: 

• Standard

Este tipo de entrega é o equivalente ao tipo de entrega “Agendada” presente no formulário de entregas. Onde é necessário informar alguns parâmetros obrigatórios como:

• Lista de pontos (“points” e “address”)
• Conteúdo da encomenda (‘matter”)
• Contato da pessoa no ponto (“contact_person”)

Nota: No parâmetro lista de pontos, o primeiro endereço inserido será sempre o ponto de coleta, e os seguintes os pontos de entregas. 

Nota²: Na lista de parâmetro de “points”, o intervalo de entrega para cada ponto “required_start_datetime” e “required_finish_datetime” é obrigatório se você desejar uma entrega “Agendada”. Caso deseje o modo de entrega “O mais rápido possível” basta não informar nada nesses campos de tempo e o pedido será enviado para alocação de entregadores em poucos segundos após o envio da requisição via API.

• Sameday (AINDA NÃO DISPONÍVEL)

Sim, a nossa API disponibiliza o método Order price calculation para que você consiga calcular o preço sem que haja envio de pedido para Borzo, você pode optar por fazer isso em nosso ambiente de testes ou produção. 

Test: https://robotapitest-br.borzodelivery.com/api/business/1.1/calculate-order

Produção: https://robot-br.borzodelivery.com/api/business/1.1/calculate-order

Nota: Com esse valor da cotação localizado no “payment_amount”, você tem a liberdade do seu lado de escolher como vai mostrar essa informação ao seu usuário no seu site, se você vai querer mostrar o valor integral ou adicionar ou reduzir o valor como preferir.

Nota²: Não é necessário informar o endereço completo de coleta e entrega na requisição, é possível informar apenas o CEP dos pontos para ter acesso a cotação.

Você pode acessar o nosso ambiente de teste através deste site basta criar uma conta “Para empresas” com o mesmo e-mail e celular informado na sua conta de produção (borzodelivery.com) e seguir as instruções na imagem abaixo: 

Na aba “Integração via API” você terá acesso ao token de teste que você pode usar para fazer requisições e enviar pedidos para a sua conta criada nesse ambiente. 

Nota: Lembre-se de usar a URL para  requisições testes: https://robotapitest-br.borzodelivery.com/api/business/1.1, ela é diferente da usada para acessar os métodos de produção. Evite a confusão de usar token de teste em URL de produção e vice e versa.

Basta seguir a mesma etapa da imagem acima, mas usando a sua conta criada no nosso site de produção (https://borzodelivery.com/br). Entretanto, o token de produção não está disponível prontamente, será necessário solicitar o token via e-mail [email protected]. O tempo de resposta é de até 24 horas. 

Tudo depende do tipo de entrega escolhida (standard ou sameday) e de qual intervalo de entrega será informado por você na requisição. 

No caso do standard, se o intervalo de entrega não for informado nos pontos, o pedido será enviado para alocação de entregadores e começará logo após a aceitação do entregador. 

Se o intervalo de entrega for informado, exemplo: coleta das 13:00 até 14:00 e entrega das 14:00 até 15:00, o pedido só será liberado para alocação 45 minutos antes do início do intervalo, logo às 12:15 o pedido estaria disponível para entregadores. 

Nota: Como Sameday ainda não está ativo no Brasil, não o mencionaremos aqui. 

Nota²: Se você desejar enviar pedidos com intervalos de entrega personalizados, é possível criar uma lógica do seu lado para definir o intervalo de entrega a partir de 1 minuto do horário da criação do pedido, por exemplo “now()+1min”.

Basta informar o valor declarado da encomenda no parâmetro “insurance_amount”, após isso será adicionado no preço do pedido a taxa de garantia de entrega que será 1.5% do valor declarado, salvo posterior alteração de taxa ou negociação de cliente. 

Nota: Para checar rapidamente a % da taxa de seguro, basta abrir o formulário de pedido e verificar a taxa e limite máximo de seguro atual.

Sim, mas apenas o peso do item informado influencia. Não trabalhamos com parâmetros de volume da encomenda. Se você quiser informar o peso basta informá-lo no “total_weight_kg”. 

Dependendo desse valor o nosso sistema pode alterar automaticamente o tipo de veículo para evitar peso incompatível com veículo informado na API. Por exemplo: Se for enviado uma requisição para API para motobike (cód. 8) com peso 25kg, o sistema irá alterar o carro (cód. 7), já que o limite de peso do motobike é de até 20kg. 

Nota: Para carro após 30 kg, será cobrado um valor por KG excedente que poderá ser visto em “weight_fee_amount”.

Você pode checar o limite dos veículos e valores nas nossas páginas de tarifa.

Sim, esse link é disponibilizado na resposta a consulta dos nossos métodos API, é possível encontrar o link no campo “tracking_url”, lá será fornecido o link para que você possa compartilhar com o seu cliente.

Nota: Na resposta da requisição API, é disponibilizado para cada ponto do pedido, coleta e entrega o link de rastreio (tracking_url) que informará o progresso do pedido até a conclusão daquele ponto.

Portanto, se você quiser ter acesso ao tracking URL para compartilhar com seu cliente final, você precisa pegar a tracking URL do ponto de entrega do destinatário para que ele consiga visualizar quando o entregador estiver em roda para entrega.

Sim, oferecemos 2 tipos de status: order status e delivery status. Sendo o order status mais abrangente e o delivery status mais detalhado sobre cada etapa de uma determinada entrega.

Nota: Vale ressaltar que um pedido pode ter mais de 1 ponto de entrega, logo é recomendado consumir o delivery status como método de tracking de pedido.

Após o envio do pedido via API, dependendo do intervalo de entrega o pedido é enviado para alocação no aplicativo dos entregadores e quando algum deles aceita realizar o pedido o fluxo normal de pedido uma pedido A-B (coleta e entrega) acontece dessa maneira:

Nota: O order status será “Active” se não for o ponto final do pedido. Caso seja o último ponto, o status do pedido será “Completed”.

Em caso de cancelamento de pedido por cliente ou suporte, o order status e delivery status ficam assim:

Nota: Existem duas situações onde o status do pedido pode ser “canceled”: através do cliente e suporte da Borzo.  Por exemplo: quando o próprio cliente cancela pela plataforma, via método API de cancelamento ou quando o suporte da Borzo verifica algum problema no pedido e cancela no sistema.

Nota²: Caso o entregador seja removido ou desalocado do pedido pelo suporte, o pedido não será cancelado, ele apenas voltará para o sistema para ser atribuído para outro entregador.

Em caso de falha na entrega, um novo ponto de retorno é adicionado para o entregador retornar o pacote, esse caso gera os seguintes status:

Nota: Em caso de falha de entrega, é recomendável que você registre todos os pontos de coleta que serão utilizados para que o sistema possa criar automaticamente o ponto de retorno para o endereço correto do pedido. Você pode salvar os endereços de coleta na conta em que o token de produção está ativado. Acesse na aba “Lista de endereços”, conforme imagem: 

O cliente pode solicitar via API qual o status atual do order ou delivery status, existem 2 métodos:

• Consulta regular ao nosso método API para buscar qual o status atual do pedido.

https://robotapitest-br.borzodelivery.com/api/business/1.1/deliveries?delivery_ids[0]=

Nota: Para saber o status de um ponto, basta enviar um GET informando o “delivery_id” desejado (entrega ou coleta) na URL, exemplo: “https://robotapitest-br.borzodelivery.com/api/business/1.1/deliveries?delivery_ids[0]=7923” e busca pela tag “status” para achar o status atual daquele ponto.

• Utilização do nosso webhook para recebimento automático de atualizações de status dos pedidos.

A feature está localizada no ambiente de produção, basta salvar a sua URL criada para receber eventos em tempo real. Confira na imagem abaixo:

Sim, temos uma funcionalidade de simulação de status de pedido, onde você pode navegar manualmente pelas diferentes etapas do pedido para simular o processo de entrega. Os status correspondentes do pedido e da entrega serão mostrados para cada etapa.

Você pode encontrá-la dentro da sua conta teste na aba “Integração via API”, a feature se ativa automaticamente quando você realiza um pedido teste.

Para ativá-la, você pode criar um pedido manualmente no formulário de pedidos do ambiente de testes ou através do envio de uma requisição de pedido via API utilizando o token de teste da sua conta do api.test. Após isso o seu pedido ficará disponível para simulação. 

Após isso, você tem visibilidade do pedido criado e pode visualizar como o order e delivery status se comportam para cada etapa do pedido. Basta avançar no botão “Next status” para progredir com a próxima etapa e consumir nossos métodos para confirmar o novo status simulado. 

Se você desejar mais ações, clique no botão à direita para cancelar o pedido e ver como o status muda, ou avançar com o “Next status” até que o botão de falha da entrega esteja disponível para testar o fluxo de devolução também. 

Nota: Quando você avança o pedido até que ele esteja completo não é possível simular mais, você pode testar novamente clicando em “Duplicate order” isso irá criar um novo pedido no sistema para que você possa recomeçar a simulação.

Sim, todas as opções estão disponíveis com seus respectivos métodos na documentação. 

Depende da sua forma de atuação. Se você preferir utilizar apenas uma conta em produção, você pode utilizar o token dela para fazer todos os pedidos de suas lojas, informando apenas os endereços das lojas na requisição do pedido. Entretanto, a cobrança e emissão de nota fiscal será feita apenas para o CNPJ registrado nesta conta. 

Caso você deseje criar uma conta em produção para cada loja que irá utilizar os serviços Borzo, será necessário desbloquear os tokens de produção para cada conta de loja e você terá que do seu lado vincular o token daquela loja ao id de loja dentro do seu sistema. 

Exemplo: Se a conta A vinculada a loja A precisa enviar uma requisição de pedido, o token informado na requisição deve ser da loja A.

Sim, temos um parâmetro opcional “client_order_id” onde é possível registrar o seu id do pedido na sua plataforma.

Nota: Na tela de pedidos, dentro da sua conta no site da Borzo, é possível utilizar o seu número de pedido da sua empresa vinculado ao pedido criado via API para pesquisá-lo na campo de busca. Confira abaixo:

Sim, é possível obter por ponto (coleta e entrega) o nome, função e URL com foto ou assinatura do recebedor através dos parâmetros: “place_photo_url”, “sign_photo_url”, “recipient_full_name” and “recipient_position”. 

Nota:  No site da Borzo, também é possível encontrar essas informações dentro da tela do pedido selecionado.

Por padrão é possível enviar até 100 requisições por minuto para a nossa API, entretanto se o seu volume de entregas necessitar de um limite maior de requisições, podemos aumentar este limite sob consulta. 

Caso o seu centro de distribuição (CD) ou loja precise gerar etiquetas de entregas imprimíveis, basta utilizar o nosso método https://robotapitest-br.borzodelivery.com/api/business/1.1/labels para gerar as etiquetas para os pontos de entregas no formato PDF e ZPL.