Que bom que está interessado na integração através da nossa API, o modelo de integração entre plataformas torna o dia a dia do estabelecimento mais prático e fácil. Preparamos uma API para que os dados sejam coletados e movimentados de forma rápida e eficiente, evitando erro humano durante o processo de lançamento de pedidos.
\nEndereço da API: https://www.deeliv.app/apiv1
\nGET: Para carregar.
\nPOST: Para incluir.
\nPUT: Para editar.
\nDELETE: Para excluir.
\n200 OK - O request foi bem sucedido.
201 Created - O request foi bem sucedido e um novo recurso foi criado.
204 No Content - O request foi bem sucedido porém não existe response..
400 Bad Request - O request falhou, os dados obrigatórios podem conter erros.
401 Unauthorized - A autenticação falhou.
403 Forbidden - Não autorizado.
404 Not Found - Não encontrado.
405 Method Not Allowed - O request não fornece suporte para este recurso.
Para facilitar o seu processo de desenvolvimento criamos um estabelecimento de teste dentro da plataforma, o token para autenticação é
\nDQYW6Y07G80STVYFNS2T31UKV7IAUTFDIOVJ3DRFU8ZTS6JRS1
Para realizar pedidos dentro do estabelecimento de teste da API você deve acessar os links abaixo:
\nCardápio digital: https://apitester.deeliv.app
\nRobô no WhatsApp: https://www.deeliv.app/h/FXKJKC
\nRecomendamos que acesse os links pelo Smartphone para uma experiência mais amigável.
\nO Postman é uma ferramenta que tem como objetivo testar serviços RESTful (Web APIs) por meio do envio de requisições HTTP e da análise do seu retorno. Com ele é possível consumir facilmente serviços locais e na internet, enviando dados e efetuando testes sobre as respostas das requisições. O uso de Web APIs vem crescendo e o Postman auxilia nos testes desse tipo de projeto, bem como permite a desenvolvedores analisarem o funcionamento de serviços externos, a fim de saber como consumi-los.
\nCollections: https://www.deeliv.app/public/postman/collections.json
\nEnvironment: https://www.deeliv.app/public/postman/environment.json
\nPara plataformas em núvem a utilização de webhooks é de suma importância para evitar eventos de pooling, com isso a carga de requests é realizada somente quando necessário.
\nO cadastramento da URL para recebimento de webhooks é feita dentro do gestor de pedidos da plataforma, na aba de ESTABELECIMENTS > CONFIGURAÇÕES > \"Api webhook url\".
\nRegras de funcionamento do webhook
\nTempo de execução (timeout) de 5 segundos.
\nO header do retorno esperado é 200.
\nCaso não seja retornado 200 as retentativas serão feitas em 15s / 30s / 60s /120s / 300s.
\nA partir da quinta tentativa os novos envios serão realizados a casa 600s.
\nO tempo de vida do webhook é de 48 horas.
\nA estrutura do JSON enviada pelo webhook contém 3 chaves \"grupo\", \"acao\", \"dados\", segue as especificações:
\npedidos = você está recebendo dados de um pedido.
pedidos_status = você está recebendo status de um pedido.
pedidos_pagamentos_online_status = você está recebendo o status de um pagamento online de um pedido.
inserir = você está recebendo os dados referente a inclusão de um registro.
editar = você está recebendo os dados referente a edição do registro.
São os dados estruturados em JSON de acordo com a request, você pode consultar as possibilidades dentro da especificação dos endpoints da API.
\nPara ter acesso aos endpoints da API é necessário que o Auth-Token seja passado no header. Este token deve ser gerado dentro do perfil do estabelecimento.
\nPara gerar o token siga os passo a passo abaixo:
\nFaça o login em https://www.deeliv.app/estabelecimento
\nClique sobre o nome do seu estabelecimento no topo do lado direito.
\nClique sobre a sessão MEU PERFIL.
\nProcure por API TOKEN e clique em GERAR TOKEN.
\nImportante: Verifique se o estabelecimento possui um plano contratado que permita acesso a API, caso contrário o token não será gerado, ou em caso de downgrade ele deixa de funcionar.
\nConsulte a tabela abaixo para conhecer todos os enums disponíveis que podem retornar nas requests da API.
\ngrupoacaoent_statusped_tipoped_origem\n\nA especificação lista os códigos, mas não detalha a legenda de cada um.
\n
ped_formapagamento e div_formapagamentoped_formapagamento_label e div_formapagamento_labelped_status em consultas e listagensped_status em PUT /pedidos_status/{ped_id}ped_mercadopago_statusped_picpay_statusped_pagseguro_statusped_cielo_statusped_getnet_credito_statusped_getnet_debito_statusped_stone_statusped_infopago_statusped_stripe_statusite_modo_precoite_modo_cadastroite_tipo_itemper_formatofec_statusorder_by\n\nObservação: no exemplo do endpoint aparece
\nfec-datacadastral, mas a enumeração documentada usafec_datacadastral.
order_directionstatus em /cardapio_sku_status/{sku} e /cardapio_sku_status_lotecon_statuscon_provedormen_formatoest_statusEm caso de dúvidas entre em contato por e-mail através do e-mail integracao@deeliv.app
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Autenticação","slug":"autenticacao"},{"content":"Mapeamento das ENUMs da API","slug":"mapeamento-das-enums-da-api"},{"content":"Suporte técnico","slug":"suporte-tecnico"}],"owner":"13864163","collectionId":"c8c2c606-fc47-4f7b-bc0a-0b88ebb35779","publishedId":"2sA3JJ7h9i","public":true,"customColor":{"top-bar":"E9EDF0","right-sidebar":"2E3C47","highlight":"20EB68"},"publishDate":"2026-03-13T20:46:06.000Z"},"item":[{"name":"Estabelecimento","item":[{"name":"Ver formas de pagamento do estabelecimento","id":"422c7446-a33a-4b98-bb5e-99d61c3e4800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Auth-Token","value":"{{api_token}}","type":"text"}],"url":"{{url}}/estabelecimento/pagamentos","description":"