Introdução
A API Open Delivery do Entregas Expressas permite que os softwares que disponibilizam integrações baseados nas específicações do open delivery se integrem à nossa plataforma sem a necessidade de efetuar novos desenvolvimentos.
Na construção dessa API, foi utilizado os modelos de dados e chamadas baseados no Open Delivery, portando, é necessário que o desenvolvimento seja baseado nesse padrão de comunicação.
Quer incluir a logo do seu software para todos os estabelecimentos que utilizam o entregas expressas?
Conclua a integração com sucesso com ao menos um cliente ativo, usando o padrão Open Delivery.
Após isso, preencha este formulário com os dados do seu software e o link da documentação.
🚀 Como iniciar a integração
🔁 Informações que você precisa enviar para o seu cliente (estabelecimento):
Merchant ID: Identificador do estabelecimento no seu sistema. (Deve ser fornecido pelo cliente)
Webhook URL: A URL para onde você quer receber atualizações dos pedidos. (Fornecida pelo seu cliente)
🔐 Informações que o cliente precisa fornecer para você:
Client ID: Gerado no painel Entregas Expressas para autenticação.
Client Secret: Usado junto com o Client ID para gerar tokens de acesso.
O cliente também deve preencher todas as informações no painel e ativar a integração para que tudo funcione corretamente.
O seu cliente pode obter e preencher essas informações no menu Integrações > Open Delivery do Painel do Cliente.
Informações que você precisa fornecer para seus clientes realizarem a integração:
Merchant ID: O ID do estabelecimento no seu sistema.
Webhook URL: A URL completa que os webhooks serão enviados.
Informações que eles precisarão fornecer para você:
Client ID: Identificador fornecido pelo nosso sistema para autenticação conforme descrito abaixo.
Client Secret: Secret fornecido pelo nosso sistema para autenticação conforme descrito abaixo.
Além disso, solicite que ele preencha as demais informações e marque ativar integração para que sua integração funcione corretamente.
🔗 URL base da integração
A URL base padrão da nossa API é:
https://entregasexpressas.com.br/api/opendelivery
Se o seu software for incluído oficialmente na nossa lista de parceiros, você receberá uma URL base única, mas os endpoints continuarão os mesmos.
Nosso APP-ID é:
d3e3eaf2-e585-4177-962a-7be998efab8e
🔑 AUTENTICAÇÃO
Gerar Token de Acesso
Para autenticar suas requisições, gere um token utilizando o client_id e client_secret fornecidos pelo cliente seguindo a documentação oficial do padrão Open Delivery.
📄 Documentação oficial:
📦 Simulação e Pedido de Entrega
Simular entrega (disponibilidade e preço)
Antes de criar uma entrega, você pode simular valores e disponibilidade com base nos dados fornecidos.
📄 Documentação oficial:
Criar nova entrega
Utilize esse endpoint para registrar uma nova entrega na plataforma.
📄 Documentação oficial:
⸻
Informar que o pedido está pronto para coleta
Mesmo que o sistema chame automaticamente o entregador após o tempo definido, você pode antecipar a coleta informando que o pedido está pronto.
📄 Documentação oficial:
⸻
Cancelar entrega (antes de ser aceita por um entregador)
Se a entrega ainda não foi aceita por um entregador, é possível cancelá-la usando o endpoint abaixo.
📄 Documentação oficial:
⚠️ Após aceitação pelo entregador, o pedido não pode mais ser cancelado via API.
📬 Webhooks de Atualização
A cada atualização de status de uma entrega (como aceito, coletado, entregue, etc.), enviaremos um webhook para a Webhook URL configurada seguindo a seguinte especificação:
📄 Documentação oficial: