Passar para o conteúdo principal
Todas as coleçõesConfigurações
Configurando sua integração OmniChat<>VTEX
Configurando sua integração OmniChat<>VTEX

Aprenda como integrar seu sistema de e-commerce VTEX com a OmniChat

Douglas Garcia avatar
Escrito por Douglas Garcia
Atualizado há mais de uma semana

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.

Como ativar a integração

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

  1. Na plataforma OmniChat, no menu lateral, acesso Configurações > Integrações.

  1. Na tela que será exibida, no menu de integração, acesse E-Commerce/ERP.

  2. Clique no botão Nova Integração, será carregado o formulário de integração VTEX.

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.

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:

  • salesPersonName: que é o nome do vendedor que gerou o pedido.

  • salesPersonCode: que é o código do vendedor que gerou o pedido.

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

  • Utiliza preço por atacado

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.

  • Utilizar busca avançada

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.

  • Utilizar preço regionalizado

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.

Como criar a chave de aplicação na 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. Essas permissões são as seguintes:

  • 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

  • Dynamic Storage

    • Master Data administrator

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


Como funciona o VTEX IO

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.


FEEDBACK

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!!

Respondeu à sua pergunta?