API & Webhooks

Seu sistema vende.
A entrega continua conectada.

Leve os pedidos do seu ERP, e-commerce ou sistema próprio para o Entregui. Receba o andamento das entregas de volta e reduza o trabalho de atualizar tudo à mão.

Explore um pedido integrado
REST / JSONAPI v2Webhooks
Uma operação conectadaDO PEDIDO À ENTREGA
ERP E-commerce Seu sistema
Pedidos via API
Entregui

Da organização dos pedidos
à confirmação da entrega.

Rotas Entregador Tracking
A informação volta para vocêStatus, ocorrências e evidências
WEBHOOKS
order.deliveredPedido entregue

Menos tarefas entre os sistemas

A venda não precisa terminar
em uma planilha de entregas.

Conecte a informação que nasce no seu negócio à operação que leva o pedido até o cliente.

Reduza a redigitação

Envie os dados do pedido pela integração e evite repetir cadastros e endereços na operação de entregas.

Dê contexto ao atendimento

Use o status, o rastreamento e as ocorrências para que sua equipe responda ao cliente com informações da entrega.

Feche o ciclo no seu sistema

Receba a confirmação e consulte as evidências para alimentar seus processos de atendimento e pós-venda.

Explore o fluxo

Um pedido. Informação
nos dois sentidos.

Escolha uma etapa e veja o que acontece na operação e o que sua integração pode receber.

Pedido PED-100045Exemplo interativo · dados fictícios
01 / PEDIDO CRIADO

O pedido entra sem redigitação.

Seu sistema envia os dados pela API. O Entregui cria o pedido como pendente, pronto para entrar no planejamento.

PED-100045Sua referência, também no Entregui
Pendente
Seu sistema → Entregui

Guarde o ID retornado ou use a referência externa para consultar esse pedido nas próximas etapas.

Visão da integraçãoJSON

POST /api/v2/orders

Resposta 201 · campos selecionados
{
  "order": {
    "id": 123,
    "custom_id": "PED-100045",
    "status": "PENDING"
  }
}
Ver o exemplo completo na documentação

Uma integração que acompanha a operação

Do cadastro do pedido
ao comprovante de entrega.

Escolha os recursos que fazem sentido para o seu fluxo e amplie a integração conforme a operação evoluir.

Pedidos e referências

Crie e consulte pedidos usando também o identificador do seu sistema, mantendo a relação entre as duas plataformas.

Pedidos na API

Ajustes operacionais

Consulte status e execute ações como reagendar, colocar em pendência ou cancelar, conforme as regras de cada etapa.

Ações disponíveis

Rotas e paradas

Consulte o planejamento, os pedidos vinculados à rota e a sequência das paradas para dar visibilidade ao seu sistema.

Consultas de rotas

Rastreamento e ocorrências

Acompanhe os dados de tracking e consulte os eventos e as ocorrências do pedido para orientar o atendimento.

Dados de acompanhamento

Eventos por webhooks

Cadastre um endereço receptor e selecione os eventos que seu sistema deve receber, como saída para entrega e conclusão.

Configurar webhooks

Evidências e comprovantes

Consulte fotos, assinatura, arquivos e o comprovante em PDF dos pedidos entregues, conforme a evidência coletada.

Consultar evidências

Para o time de tecnologia

Um caminho claro
para começar.

Documentação com endpoints, campos, exemplos de requisição e respostas para orientar a implementação.

Abrir documentação
  1. 01

    Conecte com a chave da empresa

    A integração usa uma chave de API vinculada à empresa. As chamadas autenticadas partem do seu backend.

  2. 02

    Mapeie e valide um pedido

    Relacione o identificador externo, a base, o destinatário e o endereço. Confira os campos e as respostas da API.

  3. 03

    Conecte o retorno da operação

    Cadastre seu receptor de webhooks e trate os eventos. Use as consultas de status e evidências para completar o fluxo.

Antes de integrar

Dúvidas frequentes

Alinhe o fluxo com o seu time de tecnologia e com quem cuida das entregas.

Posso conectar meu ERP ou e-commerce?

Sim, por meio de uma integração desenvolvida com a API. Seu sistema precisa conseguir fazer chamadas HTTP e, para receber webhooks, disponibilizar um endereço receptor. Converse com o seu time ou fornecedor para definir a implementação.

Qual é a diferença entre API e webhook?

Na API, seu sistema inicia uma chamada para enviar ou consultar informações. No webhook, o Entregui envia um evento ao endereço que você cadastrou. Os dois recursos podem trabalhar juntos no mesmo fluxo.

Posso usar o número do pedido do meu sistema?

Sim. O campo custom_id permite registrar sua referência externa e consultar o pedido por ela, mantendo a correspondência com o identificador do Entregui.

Consigo recuperar as fotos e o comprovante?

Sim. A API oferece consultas de evidências, arquivos e comprovante em PDF para pedidos entregues. O conteúdo disponível depende do que foi coletado na confirmação da entrega.

Como a integração é autenticada?

As chamadas usam uma chave de API vinculada à empresa. Os webhooks também possuem assinatura para verificação no receptor. Consulte a documentação e mantenha as credenciais no backend da integração.

Conecte a próxima etapa do seu negócio

Seu pedido já está no sistema.
Leve a entrega para o mesmo fluxo.

Mostre como sua operação funciona hoje. Nossa equipe ajuda a identificar os pontos de integração com o Entregui.