A integração entre OmniChat e VTEX permite que você se beneficie de todo o catálogo de produtos existentes no seu e-commerce, além das regras de logística, pagamento, promoções e outros.

Para ativar a integração entre OmniChat e VTEX siga as etapas abaixo:

3. Agora vamos preencher o formulário:

Informe a versão da sua loja

Escolha qual a versão da sua loja (se ela possui o VTEX IO ou não)
Caso possua duvidas sobre a versão da sua loja, entre em contato com o suporte da VTEX

Nome
Nome dado a sua integração, que será exibido na lista de integrações disponíveis.

Time

Aqui, você pode associar um ou mais times (opcionalmente) a esta integração. Caso algum time seja associado, está integração ficará disponível exclusivamente para os membros desse(s) time(s). Se nenhum time for colocado, a integração ficara disponível para todos.

API Key

Nesse campo deve ser informado a chave de aplicação (API KEY) que deve ser gerada no admin da sua loja VTEX. Para saber como conseguir essa informação leia a sessão que fala sobre Como criar uma chave de aplicação na VTEX.

API Token

Nesse campo deve ser informado o token da chave de aplicação (API Token) que é gerado junto com a chave de aplicação no admin da sua loja VTEX. Para saber como conseguir essa informação leia a sessão que fala sobre Como criar uma chave de aplicação na VTEX.

Nome da Conta

Nesse campo deve ser informado o nome de identificação da sua loja na VTEX. É o nome que aparece no inicio da URL do seu admin na VTEX.

Ex.: Se a URL do seu admin é https://minha-loja.myvtex.com/admin o seu account name é minha-loja.

Política comercial

Nesse campo deve ser informado o ID da política comercial que você deseja utilizar para realizar as vendas na OmniChat. Para saber mais veja Política Comercial na VTEX.

URL do E-commerce

Nesse campo deve ser informado a URL da sua loja, a mesma que seus clientes utilizam para acessa-la.

Ex.: https://www.minha-loja.com.br.

Nesse campo deve ser informado a URL do seu checkout. Caso ela seja a mesma da loja, pode preencher com a mesma informação do campo acima. Caso contrário informe a URL correspondente.

Ex.: https://secure.minha-loja.com.br.

Parâmetros extras da URL

Esse campo não é obrigatório. Ele pode ser usado para enviar informações complementares na URL de checkout que é enviada para o comprador no final do fluxo de venda na OmniChat.

Por padrão a URL do checkout que é gerada tem esse formato:

https://www.minha-loja.com.br/checkout/?orderFormId=8163e571a3d444a594fc0cede6a18850

Se o campo URL complementar for preenchido com &utm_campaing=vendaChat, por exemplo, a URL do checkout passara a ter esse formato:

https://www.minha-loja.com.br/checkout/?orderFormId=8163e571a3d444a594fc0cede6a18850&utm_campaing=vendaChat

Neste campo é possível utilizar dois parâmetros opcionais para compor o link, sendo eles:

Para incluir esses parâmetros na URL, é necessário colocá-los dentro de duas "chaves" {{}} conforme o exemplo abaixo:

Ex.: &utmi_campaign={{salesPersonCode}}-{{salesPersonName}}/#cart

Assim, os valores dentro das chaves serão substituídos pelos respectivos valores do usuário. Esses valores, podem ser editados e ou configurados na criação do usuário.

Funcionalidades

Marque essa checkbox caso deseje utilizar preços de atacado em suas vendas.
Se quiser saber mais saber mais sobre essa opção, acesse esse link.

Marque essa checkbox caso deseje recuperar as informações de carrinho abandonados do seu ecommerce para fazer disparos de Campanhas de carrinho abandonado através do Marketing Studio da OmniChat. Quando essa opção estiver marcada, é necessário inserir o script de recuperação de carrinho abandonado na página do checkout do seu ecommerce. Veja como inserir o script na seção Script de Carrinho Abandonado desse documento.

Marque essa checkbox caso você possua o VTEX IO e deseje utilizar o sistema de busca avançada em sua loja
Se quiser saber mais saber mais sobre essa opção, acesse esse link.

Marque essa checkbox caso deseje utilizar a funcionalidade de preço regionalizado em suas vendas.
Se quiser saber mais saber mais sobre essa opção, acesse esse link.

Depois de preencher os campos necessários clique no botão Salvar.

Após essas etapas será iniciada a sincronização dos dados com sua Loja VTEX.

A integração entre OmniChat e VTEX ocorre por meio de comunicação de um conjunto de APIs. Para que a OmniChat consiga se comunicar com sua loja é necessário criar uma chave de aplicação com algumas permissões especificas, que servirão para a OmniChat se autenticar na sua loja e poder usar essas APIs.

Lembre-se que a Chave de Aplicação que você irá gerar para a OmniChat precisa estar vinculada a um perfil de acesso que tenha algumas permissões especificas para que a integração funcione corretamente.

Na VTEX, para criar um perfil de acesso, no canto superior direito, clique sob seu perfil, então escolha as opçãos Configurações de conta -> Perfis de acesso.

Essas são as permissões necessárias para a integração da OmniChat:

Para criar a Chave de API, clique em seu perfil no canto superior direito no Admin da VTEX e escolha as opções Configuração de conta -> Chaves de API.

Na tela que vai abrir, coloque um nome de identificação para a Chave, e selecione o perfil com as permissões necessárias para a integração (passo anterior), em seguida clique no botão Gerar.

Você receberá os seus API-Key e API Token:

Utilize essas informações na configuração da integração na OmniChat. Guarde-as em lugar seguro se necessário, pois o token será exibido apenas uma vez.

Caso precise de ajuda com essas etapas na VTEX, você pode consultar as documentações abaixo:

VTEX IO é uma plataforma que possibilita um gerenciamento com foco na experiência do usuário para seu e-commerce. Tendo um número maior de recursos e funcionalidades, traz uma série de benefícios e otimizações para a sua loja e sua integração com a OmniChat.

Para mais informações sobre o VTEX IO, acesse essa documentação.

Com isso finalizamos o nosso tutorial sobre como fazer a sua integração VTEX.

Diga-nos o que achou desse guia e qualquer sugestão de melhoria!

Obrigado!!