Central de Ajuda
  • 📗Boas-vindas!
  • 📣Últimas novidades!
  • 💡Ajuda AI
  • 🎨Assistente criativo
  • 🚀Potencialize suas vendas!
    • WhatsApp
    • Instagram
      • Como compartilhar um link em seus Stories do Instagram
    • Facebook
      • Como criar botão para Comprar/Fazer um pedido
      • Como compartilhar o link da sua loja e das suas promoções nos seus posts.
    • Dicas para vender mais!
    • Exemplos de postagens para redes sociais
    • Sugestões de promoções e campanhas
  • Atendente Virtual
    • 🤖Autoatendimento por WhatsApp
      • Recuperador de Vendas
    • 📣Campanhas por WhatsApp
    • 🗒️Perguntas Frequentes (FAQ)
    • ✅Boas Práticas
  • Delivery & Atendimento No Local
    • 🎥Tutoriais em vídeo
    • 🏠Início
    • 🛒Realizar vendas (PDV)
    • 🪙Operações de Caixa
      • Como abrir e fechar o caixa
      • Como inserir ou retirar valores do caixa
    • 📋Pedidos
      • Gestor de Pedidos (Aplicativo)
      • Gestor de Pedidos (Navegador)
      • Como visualizar, buscar pedidos e modificar seu status
      • Editar pedidos
      • Motivo de Cancelamento de Pedidos
      • Como alterar a forma de pagamento e valor final de um pedido
      • Como alterar o endereço do cliente ou a taxa de entrega de um pedido
      • Como finalizar pedidos automaticamente
      • Como é o layout da impressão de pedidos?
      • Notificação de pedidos
        • Como configurar o alerta sonoro e as notificações de recebimento de pedidos
          • Como configurar alerta de pedidos no painel
          • No seu navegador
            • Google Chrome
            • Microsoft Edge
            • FireFox
        • Aviso de novos pedidos no WhatsApp
        • Como o cliente ativa e recebe notificações de status do pedido
    • 🏷️Produtos
      • Cardápio otimizado
      • Como criar uma nova categoria de produto
      • Como personalizar as categorias com cores ou imagem
      • Como criar ou editar um produto
      • Como criar e editar complementos dos itens no catálogo
      • Código PDV de itens e seus complementos para integrações
      • Como buscar itens rapidamente e utilizar o filtro do catálogo
      • Edição rápida de produtos
      • Etiqueta de produtos
      • Como editar complementos iguais rapidamente
      • Como alterar status de produto ou complemento na loja
      • Como mudar imagem, preço, descrição ou excluir um item definitivamente da loja
      • Produto por kg ou litro
      • Como modificar a ordem dos itens que aparecem na loja
      • Como clonar um item no catálogo (criar uma cópia)
      • Como configurar a disponibilidade de um produto
      • Como configurar a disponibilidade de uma categoria de produtos
      • Como definir em qual cardápio um produto do catálogo aparecerá
      • Como visualizar a página de um produto
      • Como visualizar e compartilhar páginas de categoria de produtos
      • Como importar seu catálogo de produtos do iFood
      • Vendas sugestivas
      • Como configurar os produtos em destaque
      • Como os preços dos produtos aparecem no catálogo do site/aplicativo?
      • Como disponibilizar prêmios do Programa de Fidelidade para resgate no Delivery e Atendimento Local
    • 📍Áreas e taxas
      • Taxas por áreas
      • Taxas por raios
      • Taxa por bairro
      • Pedido mínimo por área, bairro ou raio
      • Como configurar entrega grátis por alcance, bairro ou área
      • Áreas personalizadas
      • Como criar zonas de exclusão no mapa (para taxa por raios e áreas)
      • Como o cliente busca a loja mais próxima
      • Como aumentar ou diminuir tempos de entrega ou retirada rapidamente
    • 🧾Notas fiscais
      • Informações Fiscais
      • Categorias de impostos
      • Emissão e gerenciamento de notas fiscais
      • Emissão automática de notas fiscais
      • Baixar notas ficais
      • Inutilizar notas
    • 📦Estoque
      • Como configurar estoque simples
      • Como configurar estoque por insumos e ficha técnica
      • Movimentações
      • Como configurar notificações e mensagens para estoque baixo
    • 📔Fiado
    • 💰Créditos
      • Conversão de Pontos em Créditos
    • 🗺️Mapa de calor de pedidos
    • 💵Financeiro
      • Transferência de valor
      • Extrato Financeiro
      • Movimentações
      • Caixas
      • Conciliações
      • Carteiras
    • 🎟️Cupons e promoções
      • Como divulgar os links da loja
      • Como gerar QR codes para divulgar sua loja
      • Como criar um cupom de desconto na sacola
      • Como criar cupom com desconto ou isenção na taxa de entrega
      • Como criar cupons com outros benefícios (Exemplo: brindes ou refrigerante grátis)
      • Clonar cupons para outras lojas
      • Como visualizar os resultados dos cupons promocionais
      • Como o cliente resgata o cupom através do site
      • Como dar desconto em um item específico
      • Categorias promocionais
      • Como aparece o banner de cupom na loja?
      • Página de promoções
    • 💸Cashback
    • 📣Comunicador
      • Campanha por E-mail Marketing
      • Campanha por WebPush
      • Campanha por SMS
      • Campanha por WhatsApp
    • 🛎️Atendimento no Local
      • Como criar e editar pontos de atendimento (QR Codes e links para mesa, comanda, balcão ou garçom)
      • Como acompanhar e gerenciar pedidos no local
      • Identificador de Mesas e Comandas
      • Configurações gerais
      • Cardápio modo visualização
      • Como trocar de Ponto de Atendimento (mesa, balcão ou comanda) (Modo tablet)
      • Compartilhar comanda
      • Como instalar o app em Tablet de autoatendimento para o Atendimento no Local
    • 📓Histórico
      • Como buscar e visualizar pedidos concluídos
    • 📈Relatórios
      • Relatórios de produtos
      • Relatórios de vendas
      • Como visualizar os resultados da loja
    • 👩‍🦰Clientes
      • Como visualizar lista de clientes, seu perfil, compras e permissões e dados
      • Cadastro de clientes
      • Como gerar uma nova senha para o cliente
      • Como eu falo com um cliente no Whatsapp usando o painel
      • Como a plataforma salva o endereço do cliente
    • 🚴‍♂️Entregadores
      • Cadastrar entregadores
      • Vincular entregadores aos pedidos
      • Link de entregadores
      • Como enviar pedido por WhatsApp para os entregadores
      • Como gerar relatórios das entregas realizadas
    • 👤Perfil
      • Como modificar os dados da empresa que aparecem no site
      • Como personalizar o visual da loja e seus links
      • 📞Botão Flutuante do WhatsApp
    • ⏰Horários e Agendamentos
      • Como abrir e fechar sua loja
      • Como configurar os horários de funcionamento para Delivery & Retirada
      • Como configurar os horários de funcionamento para Atendimento Presencial
      • Como criar pausas programadas na sua loja
      • Agendamento
        • Como ativar o agendamento
        • Como acompanhar pedidos agendados
        • Aviso sonoro e visual para iniciar produção de pedido agendado
        • Como o cliente agenda seu pedido
    • 💳Formas de Pagamento
      • Pagamento na entrega
      • Pagamento Online
        • Pagamento online automático (Liga Pay)
          • Como configurar o pagamento online automático pela Liga Pay
          • Como o cliente realiza o pagamento online
          • Pedidos pendentes
          • Link de pagamento online no PDV
          • Como identificar se um pedido foi pago de forma online
          • Como estornar um pagamento
          • Formas de pagamento e taxas (Liga Pay)
          • Financeiro - Carteira Liga Pay
          • Como acessar os relatórios do pagamento online
          • Pagamentos com status "Em Disputa" ou "Chargeback"
          • Proteções contra chargeback e 3DS
          • Tokeinização: Mais segurança no pagamento online
        • Pagamento online via link e pix com comprovação manual
      • Como usar múltiplas formas de pagamento diferentes no mesmo pedido
      • Atalhos de formas de pagamentos
    • 🔌Integrações
      • iFood
      • Aiqfome
      • Delivery Much
      • Liga Pay
      • TEF - Convencional
      • Smart TEF
      • Open Delivery
        • Aplicação de Pedidos - Open Delivery
        • Importar pedidos - Open Delivery
      • Saipos
      • Foody Delivery
      • Mapp Sistemas
      • Bee Delivery
      • Pick n Go!
      • Machine Global
      • API Delivery
      • Easy Assist
      • WhatsApp
        • Atendente Virtual
        • Recuperador de Vendas
        • Campanha em massa
        • Status de pedidos via WhatsApp
        • Aviso de novos pedidos via Whatsapp
      • Google Analytics
      • Meta (Facebook e Instagram)
        • Facebook Pixel
        • API de Conversões Facebook (Meta)
        • Facebook XML (Catálogo integrado)
          • Loja no Instagram
          • Loja no Facebook
        • Como verificar domínio no Facebook
      • Google Tag Manager (GTM)
      • API para integrações
      • Webhooks
      • Domínio próprio
    • 📝Serviços e Assinaturas
      • Como criar nova loja
      • Como acessar o boleto da mensalidade
      • Como modificar a forma de pagamento da mensalidade
    • 🖨️Impressão de Pedidos
      • Impressão via Navegador (impressão manual)
      • Impressão automática
        • Como instalar o app de impressão
        • Como configurar a impressão via Software
        • Como configurar setores de impressão
      • Usuários e impressoras
      • Histórico de impressões
      • Notificações de pedidos não impressos
      • Problemas de Impressão de Pedidos: Como Resolver
    • ⚙️Configurações
      • Aceitar pedidos para entrega (delivery)
      • Entrega grátis a partir de valor de compra mínimo
      • Zerar taxas de entrega temporariamente
      • Iniciar um pedido sem solicitar CEP
      • Aceitar pedidos para retirada
      • Aceitar pedidos somente por agendamento
      • Aceitar pedidos para consumo no local
      • Habilitar tela de lojas da marca
      • Habilitar tela de "Como você quer receber o pedido?"
      • Categorias expansíveis
      • Exigir pedido mínimo
      • Perguntar se o cliente quer CPF/CNPJ na nota
      • Desativar programa de fidelidade no Autoatendimento na Loja
      • Ativar ou desativar operações de caixa e configurar WhatsApp de fechamento
      • Mensagens automáticas
      • Contador Diário de Pedidos
      • Campos para mensagem em cartão
      • Desabilitar uso simultâneo de cupom e resgate de prêmio
      • Verificação de idade para conteúdo adulto (18+)
    • 👥Usuários
      • Como criar e vincular usuários administradores e operadores da plataforma
      • Como editar meus dados
    • 💡Reportar sugestões e problemas
  • Marketing & Fidelização
    • 🏠Início
    • 👩‍🦰Clientes
      • Como visualizar dados de compra e perfil dos clientes
      • Como acessar a lista de clientes e seus dados
      • Como visualizar a lista de atividades dos clientes no programa de fidelidade
      • Como visualizar, criar ou editar um público personalizado
      • Confirmação de cadastro pelo site
      • Importar contatos
    • 🏆Programa de Fidelidade
      • Como visualizar os dados de pontos e resgates do programa de fidelidade
      • Como criar e editar prêmios para resgate via Pontuador Web ou Tablet Pontuador
      • Nome do Programa de Fidelidade
      • Quais e-mails meus clientes recebem do programa de fidelidade?
      • Pontos pela primeira compra
    • 🎁Pontuador + Resgate de prêmios
      • Pontuador Web e Pin Pad
        • Como acessar o Pontuador Web
        • Como cadastrar um cliente através do Pontuador Web
        • Como registrar pontos, resgatar prêmios ou ofertas e atualizar os dados cadastrais de um cliente
        • Pin Pad
      • Pontuador Tablet
        • Como instalar o aplicativo no tablet
        • Como o cliente se cadastra usando o tablet pontuador
        • Como pontuar as compras usando o tablet
        • Como resgatar um prêmio usando o tablet
        • Como resgatar um cupom usando o tablet
        • Dicas para deixar seu tablet mais rápido
      • Atendimento no Local
        • Como pontuar e resgatar prêmios no Atendimento no Local
      • Delivery & Retirada
        • Como ajustar a pontuação do cliente diretamente no painel - Delivery & Retirada
        • Como o cliente pontua e resgata prêmios no Delivery & Retirada
      • Dicas para cadastro e atendimento
    • 📊Relatórios mensais
      • Como acessar os relatórios de desempenho
    • 🤖Piloto automático
      • Aniversariantes
      • Clientes em Risco e Inativos
      • Cadastrou, Ganhou
    • ⭐Avaliações
      • Como visualizar as avaliações e respondê-las
    • 📣Comunicador
      • Como criar uma campanha via e-mail
      • Como criar uma campanha via SMS
      • Como adquirir créditos para enviar suas campanhas via SMS
      • Como criar uma Campanha de notificações Push
      • Campanha por WhatsApp
    • 💰Promoções
      • Como criar uma promoção de dia da semana
    • 🤑Indique e ganhe
      • Como visualizar os resultados do programa de indicações (Indique e Ganhe)
      • Como compartilhar o link do programa de indicações (Indique e Ganhe)
      • Como pausar o programa de indicação (Indique e Ganhe) ou editar a pontuação que os clientes recebem
      • Como são os e-mails da ferramenta Indique & Ganhe?
    • 🏪Marca, Lojas e Acessos
      • Como editar as informações e personalizar sua(s) loja(s)
      • Parâmetros de loja: aviso de pontuação suspeita
      • Como modificar os parâmetros de segmentação de clientes
      • Como criar acessos para o Pontuador Web e Tablet Pontuador
      • Como criar Pin de colaboradores para metrificar suas ações
    • 👤Meus dados
    • 💡Reportar sugestões e problemas
  • OUTROS
    • ®️Marca e Lojas
      • Configurar Marca
      • Lojas
    • 🖥️Nova Experiência de Navegação
    • ⚠️Certificado de segurança - Acesso ao painel da loja
    • Área de desenvolvedores
    • 🔌APIs de integrações
      • API - Delivery & Retirada
      • API - Cadastro de Pedidos
      • API - Atendimento Local
      • API - Marketing & Fidelidade
      • API - Catálogo
      • Notificações e Eventos (Webhook)
    • 🌐Domínio personalizado
      • RegistroBR
      • GoDaddy
      • HostGator
      • Hostinger
    • 📱Aplicativos
      • Como instalar o aplicativo para o painel gerencial
      • Como instalar o aplicativo da loja
    • 🌎Chave API Google Maps
    • 🔒LGPD
    • ❓FAQ - Perguntas Frequentes sobre a Plataforma
    • Termos de Uso do Aplicativo de Gestão de Pedidos
Con tecnología de GitBook
En esta página

¿Te fue útil?

  1. OUTROS
  2. APIs de integrações

API - Marketing & Fidelidade

AnteriorAPI - Atendimento LocalSiguienteAPI - Catálogo

Última actualización hace 2 meses

¿Te fue útil?

Importante: Até dia 01/06/2025 todas as integrações com a plataforma precisarão informar o seu token de desenvolvedor no request para ter acesso ao sistema. Para mais informações .

A API de integração registra pontuações, resgata prêmios, cadastra usuários, lista usuários, entre outros.

Link para a documentação da API:

🔌
clique aqui
https://documenter.getpostman.com/view/569841/RznEKyFg