O que é
A integração entre OmniChat e VTEX conecta sua loja de e-commerce à plataforma de atendimento, permitindo que os vendedores acessem catálogo de produtos, regras de preço, promoções, logística e informações de pedido diretamente nas conversas com os clientes.
Para que serve
Vender pelo WhatsApp com acesso ao catálogo completo do e-commerce.
Aplicar preços, promoções e políticas comerciais da VTEX nas conversas.
Recuperar carrinhos abandonados com campanhas automáticas.
Rastrear o desempenho de vendas por vendedor via parâmetros de URL.
Parte 1 — Como ativar a integração na OmniChat
Acesse: Menu Lateral → Configurações → Integrações.
No menu de integrações, clique em E-Commerce/ERP.
Clique em Nova Integração — o formulário VTEX será carregado.
Preencha os campos do formulário (descritos na tabela abaixo).
Clique em Salvar — a sincronização com a VTEX será iniciada automaticamente.
Campos do formulário de integração VTEX:
Campo | O que informar |
Versão da loja | Indique se sua loja usa VTEX IO ou não. Em caso de dúvida, consulte o suporte VTEX. |
Nome | Nome que identificará essa integração na lista da OmniChat. |
Time | (Opcional) Vincule um ou mais times — se preenchido, a integração ficará exclusiva para esses times. Se vazio, fica disponível para todos. |
API Key | Chave de aplicação gerada no admin da VTEX (veja a Parte 2). |
API Token | Token gerado junto com a API Key no admin da VTEX (veja a Parte 2). |
Nome da Conta | Nome da sua loja na VTEX — é o que aparece no início da URL do admin. Ex: se a URL é minha-loja.myvtex.com/admin, o nome é minha-loja. |
Política comercial | ID da política comercial da VTEX para usar nas vendas da OmniChat. |
URL do E-commerce | URL pública da sua loja. Ex: https://www.minha-loja.com.br |
URL do Checkout | URL do checkout. Pode ser a mesma do e-commerce ou uma específica. Ex: https://secure.minha-loja.com.br |
Parâmetros extras da URL | (Opcional) Parâmetros adicionados ao link de checkout — útil para rastrear vendas por campanha ou por vendedor. |
Funcionalidades opcionais:
Funcionalidade | Quando ativar |
Preço por atacado | Se sua loja vende por atacado e quer aplicar esses preços nas conversas. |
Carrinho abandonado | Para recuperar carrinhos via campanhas — requer instalação de um script no checkout da VTEX. |
Busca avançada | Para lojas com VTEX IO que desejam usar o sistema de busca avançada de produtos. |
Preço regionalizado | Para lojas que operam com preços diferentes por região. |
Parte 2 — Como criar a Chave de Aplicação na VTEX
A OmniChat se comunica com a VTEX por meio de APIs. Para isso, é necessário criar uma chave de aplicação com as permissões corretas no admin da VTEX.
Etapa 1 — Criar o perfil de acesso
No admin da VTEX, clique no seu perfil no canto superior direito.
Acesse: Configurações de conta → Perfis de acesso.
Clique em Novo perfil e dê um nome de identificação.
Adicione as permissões descritas na tabela abaixo.
Salve o perfil.
Permissões necessárias por módulo:
Módulo | Permissões necessárias |
OMS | Feed v3 and Hook Admin, Subscription view only, Notify payment, Notify invoice, View order, Notify refund, Cancel order, List Orders |
Checkout | Order Full Access |
Catalog | Product management |
Pricing | Read prices |
Dynamic Storage | Master Data administrator |
Rates and Benefits | Manage benefits and rates |
Logistics | Logistics viewer |
Etapa 2 — Gerar a Chave de API
No admin da VTEX, clique no seu perfil no canto superior direito.
Acesse: Configuração de conta → Chaves de API.
Clique em Gerar chave.
Dê um nome de identificação e selecione o perfil com as permissões criadas na etapa anterior.
Clique em Gerar.
Copie e guarde o API Key e o API Token exibidos — o token será mostrado apenas uma vez.
Use essas credenciais para preencher o formulário de integração na OmniChat.
⚠️ Atenção: O API Token é exibido uma única vez. Guarde-o em local seguro antes de fechar a tela da VTEX.
Parte 3 — Script de Carrinho Abandonado (se aplicável)
Se você ativou a funcionalidade de Carrinho Abandonado, é necessário inserir um script da OmniChat na página de checkout da sua loja VTEX. Veja como fazer pela forma padrão:
No admin da VTEX, acesse: Configurações da loja → Storefront → Checkout.
Clique no ícone de engrenagem azul do seu checkout.
No menu superior da tela, clique em Código.
No menu lateral direito, selecione o arquivo checkout6-custom.js.
Cole o script copiado da tela de configuração da integração VTEX na OmniChat (ao final do código existente, se houver).
Clique em Salvar.
⚠️ Atenção: Este procedimento é para lojas VTEX padrão. Lojas com checkout externo ou customizações específicas podem precisar de um processo diferente — o importante é que o script da OmniChat esteja presente na página do checkout.