Sumário
Configurando sua integração OmniChat <> SpiritShop
A integração entre a OmniChat e a SpiritShop permite consultar os produtos, as variações, o estoque e os preços da sua loja durante os atendimentos, montar o carrinho na loja e enviar ao consumidor o link para finalizar a compra no checkout da SpiritShop, onde ele escolhe o frete e a forma de pagamento.
Também é possível acompanhar as atualizações dos pedidos (pagamento aprovado, pedido enviado, entregue ou cancelado) e recuperar os checkouts que o consumidor deixou sem finalizar.
A SpiritShop libera o acesso à sua loja por meio de uma chave da API (Secret Key). Por isso a configuração tem duas partes: primeiro você ativa a API e copia a chave no admin da SpiritShop, e confere os status de pedido da loja; depois cadastra a chave na OmniChat.
Antes de começar
Para realizar a configuração, você precisa:
Ter acesso ao admin da sua loja SpiritShop;
Ter acesso às configurações de integrações da OmniChat, com um usuário Administrador;
Saber o endereço da sua loja na internet, começando com
https://(por exemplo,https://minhaloja.com.br).
Preparando a loja na SpiritShop
Passo 1: No admin da sua loja SpiritShop, acesse Extensões > API > Rest API.
Se o item API não aparecer no menu Extensões, o seu usuário do admin não tem permissão para essa tela. Peça o acesso ao administrador da loja ou ao suporte da SpiritShop.
Passo 2: Em Dados gerais, confira se a opção Situação está ligada. Ela libera o acesso da API à loja.
Passo 3: Copie a chave do campo Secret Key. Se o campo estiver vazio, clique em Gerar Secret Key e depois em Salvar.
Menu Extensões > API > Rest API e a tela Rest API no admin da SpiritShop, com a Situação e o campo Secret Key.
Na mesma tela, deixe a opção Get Orders (Data de Modificação) desligada. Ligada, ela muda o filtro de datas da consulta de pedidos, e a OmniChat pode tratar como novo um checkout antigo que foi alterado depois. As opções Nome/Descrição Atualizar e Chave de Integração Produtos SKU valem apenas para o cadastro de produtos enviado pelo ERP e não afetam a OmniChat.
A SpiritShop também explica essa tela no guia Suporte a Integração de dados API SpiritShop.
⚠️Atenção: a loja tem uma única Secret Key. Se ela já é usada em outra integração, como o seu ERP, não clique em Gerar Secret Key: uma chave nova invalida a anterior, e a outra integração para de funcionar. Use a chave que já está no campo. Não compartilhe a chave em conversas ou documentos.
Passo 4: Confira os status de pedido da loja. Na SpiritShop, cada loja cria e nomeia os próprios status de pedido, e a OmniChat usa estes três pontos para entender cada um:
Situação dos pedidos: o status que todo pedido recebe ao ser criado (normalmente "Aguardando Pagamento"). A OmniChat trata esse status como o início do pedido e não envia notificação.
Situação do Pedido Completo: o status que encerra o pedido (normalmente "Concluído"). A OmniChat trata esse status como Entregue.
Nome dos demais status: a OmniChat lê o nome para reconhecer pagamento, envio e cancelamento, conforme a tabela abaixo.
Os dois primeiros ficam em Configurações, aba Loja > Finalização, no quadro Finalização do pedido: confira os campos Situação dos pedidos e Situação do Pedido Completo.
Configurações do admin da SpiritShop, aba Loja > Finalização, com os campos Situação dos pedidos e Situação do Pedido Completo.
Na SpiritShop | Na OmniChat |
Situação dos pedidos | Aguardando pagamento (não gera notificação) |
Situação do Pedido Completo | Entregue |
Status Cancelado da plataforma, ou nome com "cancelado", "devolução", "estornado" ou "reembolsado" | Cancelado |
Nome com "enviado", "envio", "despachado", "em trânsito", "transportadora", "correios", "postado", "motoboy", "a caminho" ou "saiu para entrega" | Enviado |
Nome com "pago" ou "paga", ou "pagamento" com "aprovado", "autorizado", "confirmado" ou "recebido" | Pago |
Um nome que diz o contrário não conta: "Não pago", "Pagamento não autorizado", "Aguardando envio" e "Pronto para envio" não alteram o pedido na OmniChat. Status de etapas internas, como "Análise de Crédito", "Logística" ou "NF-E", também não alteram o pedido.
Passo 5 (recomendado): deixe o telefone obrigatório no checkout. A recuperação de carrinho abandonado só consegue abordar o consumidor que informou o telefone. Acesse Extensões > Módulos > Workflow, edite o campo telephone (Telefone), ligue as opções Situação e Obrigatório e clique em Salvar.
Edição do campo Telefone no Workflow do admin da SpiritShop, com Situação e Obrigatório ligados.
Criando a integração na OmniChat
Passo 1: Na plataforma OmniChat, acesse Configurações > Integrações.
Passo 2: Na tela de integrações, selecione E-Commerce / ERP e clique em Adicionar integração.
Tela E-Commerce / ERP da OmniChat com o botão Adicionar integração.
Passo 3: Na lista Nova integração, escolha SpiritShop.
Lista de integrações com a opção SpiritShop.
Passo 4: Preencha o formulário.
Formulário da integração SpiritShop na OmniChat, campos Nome, Times.
Nome
O nome de exibição da integração. Este nome será utilizado internamente para identificar a integração na plataforma.
Times
Ao associar um ou mais times, a integração ficará disponível exclusivamente para os membros desse(s) time(s). Sem times associados, ela fica disponível para toda a loja.
Chave de API
Cole a Secret Key copiada no Passo 3 da preparação na SpiritShop.
URL da loja
Informe o endereço principal da sua loja SpiritShop, o mesmo que o consumidor acessa, começando com https://. Exemplo: https://minhaloja.com.br. Esse endereço é usado para acessar a API da loja e montar os links de carrinho enviados aos seus clientes.
Campos Chave de API e URL da loja preenchidos com valores de exemplo.
Chave da API Intelipost (opcional)
Preencha somente se a sua loja usa a Intelipost no frete. Com a chave, o status de entrega dos pedidos (separado, saiu para entrega, entregue) passa a vir da Intelipost. Se a loja não usa a Intelipost, deixe em branco.
Funcionalidades disponíveis
Carrinho abandonado: marque esta opção para que a OmniChat importe os checkouts não finalizados da loja e permita criar campanhas de recuperação no Marketing Studio. A importação acontece a cada hora e considera apenas os checkouts deixados a partir da ativação da integração (veja Dúvidas frequentes).
Campo Chave da API Intelipost e a opção Carrinho abandonado.
Busca de produtos do Whizz Agent
Escolha como o Whizz, a Inteligência Artificial da OmniChat, vai buscar produtos nos atendimentos: Padrão (busca da própria integração), SERP (resultados orgânicos do Google) ou Híbrida (as duas). Se não tiver certeza, mantenha Padrão.
Seção Busca de produtos do Whizz Agent, com as opções Padrão, SERP e Híbrida.
Salvar configurações
Após preencher todos os campos, clique em Adicionar integração. O botão mostra Validando enquanto a OmniChat testa a chave na sua loja.
Nesse momento a OmniChat confere o acesso à loja, ao catálogo, aos pedidos e à criação de carrinho, que são obrigatórios, e à busca de produtos e aos clientes, que são opcionais. Se todas as verificações obrigatórias passarem, a integração é salva e aparece a mensagem Integração adicionada com sucesso!.
Se alguma verificação obrigatória falhar, a integração não é salva e o formulário mostra o quadro Erro na validação, com uma linha por verificação:
Chave inválida ou URL errada: confira a URL da loja (com
https://) e a Chave de API. Se a chave foi gerada de novo na SpiritShop, copie a chave atual.Carrinho indisponível: a loja recusou a criação do carrinho. Peça ao suporte da SpiritShop para confirmar que os recursos de carrinho e de busca da API estão disponíveis para a sua loja.
As mesmas verificações acontecem ao editar a integração: nesse caso o botão se chama Salvar integração, e a integração só é atualizada se as verificações obrigatórias passarem.
Conclusão
Com estes passos concluídos, a integração fica ativa assim que a validação termina, e já pode ser usada nos atendimentos.
A partir daí você pode consultar os produtos da sua loja diretamente nas conversas, montar o carrinho e enviar o link de checkout. O consumidor escolhe o frete e a forma de pagamento no checkout da SpiritShop, e o pedido aparece na OmniChat com as atualizações de status conforme a loja o processa. Para avisar o consumidor dessas mudanças pelo WhatsApp, configure as notificações de status de pedido: para a SpiritShop estão disponíveis Pago, Enviado, Entregue e Cancelado.
Dúvidas frequentes
A Secret Key já é usada pelo meu ERP. Posso usar a mesma na OmniChat?
Sim, e é o recomendado. A loja tem uma única chave: se você gerar outra, a anterior deixa de valer para todas as integrações. Se a chave for trocada, edite a integração na OmniChat, cole a nova chave em Chave de API e clique em Salvar integração.
Preciso cadastrar webhooks na SpiritShop?
Não. A SpiritShop não envia notificações de pedido: a OmniChat consulta a loja a cada 10 minutos. Por isso uma mudança de status pode levar até 10 minutos para aparecer na conversa.
O status mudou na loja, mas o pedido não mudou na OmniChat.
Confira se o nome do status está entre os reconhecidos (veja o Passo 4 da preparação na SpiritShop). Status de etapas internas e nomes que a OmniChat não reconhece não alteram o pedido. Se a sua loja usa um nome diferente para pagamento, envio ou cancelamento, ajuste o nome no admin da SpiritShop ou fale com o suporte da OmniChat.
Os produtos com variação (cor, tamanho) aparecem?
Sim. Cada combinação das opções obrigatórias do produto aparece como uma variação, com o preço e o estoque da loja. Opções não obrigatórias não são oferecidas na conversa. Produtos desativados na loja não aparecem.
O frete escolhido na conversa é o que o consumidor paga?
Não necessariamente. A cotação na conversa serve para orientar o consumidor; quem define e cobra o frete é o checkout da SpiritShop, quando o consumidor escolhe a entrega. Se a sua conta tiver uma integração de frete ativa na OmniChat, como Intelipost ou Correios, a cotação na conversa vem dela, e não da SpiritShop.
Posso dar desconto no pedido?
Use um cupom cadastrado na loja: ele é aplicado ao carrinho e aparece no checkout. Se o código não existir na loja, o pedido não é gerado. Descontos digitados direto no pedido, sem cupom, não são aplicados, porque a SpiritShop só aceita desconto por cupom.
Quais carrinhos abandonados são importados?
Na SpiritShop, o carrinho abandonado é um checkout em que o consumidor se identificou e saiu sem pagar. A OmniChat importa, a cada hora, os checkouts com mais de 2 horas e com telefone, um por consumidor, e nunca os que já viraram pedido. Checkouts anteriores à ativação da opção não são importados. Para recuperar mais carrinhos, deixe o telefone obrigatório no checkout da loja (Passo 5 da preparação na SpiritShop).
Os pedidos feitos direto no site da loja aparecem na OmniChat?
Sim. Eles aparecem na lista de pedidos da integração, mas não ficam vinculados a nenhuma conversa.









