A VTEX é uma plataforma de e-commerce reconhecida por suas soluções integradas, que facilitam a criação e gestão de lojas virtuais. Ao integrar sua loja VTEX com o Eccosys, você centraliza a gestão de cadastros, estoque, preços, pedidos, rastreio e faturamento em um único sistema, otimizando sua operação e garantindo a sincronização das informações entre as plataformas.
Este manual tem como objetivo guiá-lo pelas configurações necessárias para realizar essa integração de forma eficiente.
Neste manual, você aprenderá:
Fluxo da integração;
Particularidades da VTEX;
Pré-requisitos para configuração;
Como configurar a integração Eccosys - VTEX;
Como importar os depósitos cadastrados na VTEX;
Como funciona a importação e envio de catálogo para a VTEX;
Como funciona a atualização de preços dos produtos;
Como funciona a atualização de estoque entre Eccosys e VTEX;
Como importar pedidos da VTEX.
Fluxo da integração
(*) Enviados apenas em conjunto, quando informados no cadastro do produto.
"Atributos" e "Marcas" serão enviados nos produtos desde que estas informações tenham sido previamente cadastradas e importadas da plataforma para o Eccosys.
Entenda quais campos são comunicados entre o Eccosys e a Vtex.
Particularidades da integração com a VTEX
É possível mapear campos, caso seja necessário para a operação;
Atualiza status entregue através de tarefa própria, caso a transportadora envia o status;
Atualiza somente preços através de tarefa própria;
Não importa pedidos de venda, caso o transportador não esteja corretamente mapeado;
Tela para importação manual de pedidos (auditoria);
O envio de imagens em novos produtos é obrigatório;
Enviamos e importamos apenas um departamento com suas respectivas sub/categorias, por produto.
Pré-requisitos para configuração
URL da Loja;
AppKey e Token gerados na VTEX.
Como configurar a integração Eccosys - VTEX
Caso deseje migrar sua operação para uma outra plataforma ou serviço já integrado ao Eccosys, solicitamos que notifique o time de suporte com antecedência mínima de 30 dias. Desta forma, poderemos fornecer as orientações necessárias e avaliar quaisquer ajustes relacionados à migração.
Em Configurações > Plataforma > Multiplataforma, clique em "Incluir uma Plataforma", informe:
Nome da loja: Insira o nome da sua loja.
Domínio: Informe o domínio da sua loja.
Selecione VTEX ou VTEX REST no campo "Plataforma".
Escolha o depósito correspondente para a integração. O campo Depósito define qual é o depósito cadastrado no ERP que enviará os saldos de estoque para a plataforma;
Na aba Conexão, caso sua integração com a VTEX seja na versão VTEX IO ou VTEX REST, preencha os seguintes campos:
API Key
API Token
Caso utilize uma versão mais antiga da integração, os campos disponíveis são:
REST - Key (appkey)
REST - Token (token)
REST - URL Base (http://SEUDOMINIO.vtexcommercestable.com.br/api)
SOAP - Usuário (appkey)
SOAP - Senha (token)
SOAP - WSDL URL (http://webservice-SEUDOMINIO.vtexcommerce.com.br/AdminWebService/Service.svc?singleWsdl)
Aba parâmetros da plataforma
Importação de Produtos - Apenas Ativos: Define se será possível importar apenas os produtos ativos ou não;
Origem Padrão de produtos importados da loja: Ao importar um pedido de venda onde o produto não está cadastrado no ERP, define qual é a origem desse produto;
Enviar Imagens: Ao enviar os produtos as imagens devem ou não ser enviadas, caso hajam imagens cadastradas nos produtos;
Qual integração de preços deve ser utilizada: Define qual das políticas de preço da VTEX devemos atualizar ao enviar preços de venda;
URL de imagem padrão para os SKUS: Caso esse campo esteja preenchido e no cadastro do produto não tenha imagem cadastrada, enviaremos a imagem desta URL para a VTEX;
Utilizar nome da imagem inserida no cadastro de produtos: Você pode usar SEO no nome das imagens dos produtos, e usando esse campo como sim, enviaremos esse nome para a plataforma;
Lista de preço da Plataforma: A Lista de Preços permite criar regras de precificação vinculadas aos produtos, possibilitando a aplicação de preços diferentes entre as plataformas.
Enviar imagens do produto pai nas variações: Envia a imagem do produto principal para as suas variações.
Enviar estoque para a plataforma: Quando o estoque de um produto for atualizado no Eccosys, essa alteração será automaticamente refletida na VTEX
ID do estoque na VTex: Código do depósito padrão da VTEX;
Tipo de estoque a enviar o saldo: Recomendamos sempre enviar o saldo disponível;
Regra de mapeamento de depósitos: Caso utilize mais de um depósito no Eccosys, você pode consolidar todos os saldos e enviar tudo para o depósito padrão da VTEX; ou Mapear de 1 para 1, caso você tenha os mesmos depósitos na VTEX e no Eccosys;
Data de corte para baixa de pedidos somente para Feed de pedidos: Permite definir um intervalo de datas para a importação de pedidos;
Importar pedidos de vendas por situação: Define se o Eccosys irá importar apenas pedidos pagos ou todos os demais pedidos (todas as situações);
Regra de envio de status para a Plataforma: Define quando o Eccosys deve enviar as informações de faturamento para a plataforma;
Enviar XML para Pedidos Faturados: Permite o envio do XML para a plataforma assim que a nota fiscal é emitida.
Canal de Venda Padrão: Identificação padrão para o canal de venda, caso não exista mapeamento de marketplaces no ERP.
Incluir prefixo no número da fatura: Define se o Eccosys deve enviar alguma máscara ou somente números;
Utilizar rastreio da venda se NF não possuir: Envia código de rastreio do pedido de venda caso a Nota fiscal não tenha o campo código de rastreio preenchido;
Importar anexos de itens dos pedidos no campo Observação Interna: utilizado para importar anexos da VTEX para personalização de produtos;
Código da Política Comercial InStore: Deve-se informar os códigos dos marketplace cadastrados na VTEX para agrupar configurações de catálogo, preços, promoções, inventário, logística, segmentação de clientes e pagamentos para diferentes canais de venda. Canais de venda podem incluir marketplaces, e-commerce próprio, lojas físicas, ou lojas B2B;
Seller names: É possível definir que apenas pedidos de alguns sellers (Vendedores) vão ser importados no Eccosys;
Pedidos InStore: Deve-se identificar se deseja importar todos os pedidos ou apenas os finalizados (Faturado);
Dia de pagamento Walmart: Deve-se preencher com o dia sem zeros a esquerda, exemplo 5;
Regra Walmart: Deve-se selecionar o dia vai ser útil ou corrido;
Dia de pagamento Extra: Deve-se preencher com o dia sem zeros a esquerda, exemplo 5;
Regra Extra: Deve-se selecionar o dia vai ser útil ou corrido;
Atualmente as informações Código da Política Comercial InStore, Pedidos InStore, Dia de pagamento Walmart, Regra Walmart, Dia de pagamento Extra e Regra Extra não são enviadas/sincronizadas com a plataforma.
Como funcionam as importações dos depósitos
Os depósitos (centro de distribuição) devem ser criados com a mesma nomenclatura entre eccosys e Vtex. Após criados, deve-se programar a tarefa “Instalador apenas depósito” para que ela identifique os depósitos entre os ambientes e permita sua devida identificação nos pedidos de venda.
Essa tarefa deve estar habilitada em Configurações > Outros > Tarefas agendadas. Solicite auxílio do time de suporte.
Importação e envio de catálogo: como fazer?
A sincronização do catálogo entre a plataforma e o Eccosys pode ser feita de duas formas: em massa (via tarefas) ou individualmente (via painel).
Importação e Exportação em Massa
Para realizar a importação em massa do catálogo da plataforma para o Eccosys, utilize a tarefa agendada:
“Instalador Multiplataforma – Apenas Catálogo”
Para o envio de produtos do Eccosys para a plataforma, utilize a tarefa:
“Instalador Multiplataforma”
Essas tarefas garantem que as informações de produtos sejam atualizadas e sincronizadas corretamente entre os sistemas.
⚠️ Atenção:
Caso sua conta possua mais de uma integração ativa, é necessário desabilitar temporariamente as demais antes de rodar essas tarefas.
Isso porque, atualmente, não é possível executá-las de forma segmentada por integração — ou seja, a tarefa será aplicada a todas as plataformas habilitadas no momento.
✅ Recomendamos entrar em contato com o nosso time de suporte antes de executar essas tarefas, para que possamos validar as configurações e garantir que tudo ocorra conforme o esperado.
Já o envio de produtos individualmente do Eccosys para a plataforma pode ser feito acessando Configurações > Plataforma > Produtos. Para enviar ou importar os produtos, basta utilizar os botões de ação na linha correspondente:
Seta para cima: Enviar o produto para a plataforma.
Seta para baixo: Importar o produto da plataforma para o Eccosys.
Categorias e marcas
As categorias e as marcas possuem telas próprias para envio em Configurações > Plataforma.
Os atributos precisam ser criados na plataforma e importados para o Eccosys por meio de uma tarefa agendada, localizada em Configurações > Outros > Tarefas Agendadas.
Para sua segurança, recomendamos que o processo de envio seja feito com o acompanhamento de nossa equipe de suporte.
Como mapear atributos da ficha técnica
Os atributos dos produtos são importados automaticamente da plataforma para o Eccosys. Para garantir que esses atributos sejam corretamente reconhecidos e mapeados no sistema, é fundamental que você crie os atributos diretamente na plataforma, utilizando nomes específicos que permitam uma integração clara e eficiente no Eccosys.
Por exemplo, para evitar confusão e garantir a correta identificação das integrações, você pode nomear os atributos de forma distinta, como: "Tamanhos" (utilizado para a integração com Yampi) e "Tamanho" (caso haja outra integração diferente).
Após criar os atributos na plataforma, é necessário realizar o mapeamento entre eles e os atributos correspondentes no Eccosys.
Para configurar esse mapeamento, acesse: Configurações > Plataformas > Mapeamentos. Nesta tela, será possível definir as relações de mapeamento entre as variações, realizando o processo de De/Para conforme necessário.
Como funciona a atualização de estoque e produtos
A atualização do estoque e demais campos dos cadastros dos produtos será feita por meio de tarefas agendadas.
O Eccosys trabalha com duas formas de identificação de estoque: o estoque físico e o estoque disponível. Por padrão, as atualizações de estoque na plataforma são baseadas no estoque disponível, que é calculado pela diferença entre o estoque físico e as reservas feitas por pedidos.
A reserva de estoque no Eccosys ocorre sempre que um pedido é criado, independentemente de como ele é gerado. Ou seja, toda vez que um pedido é registrado, uma tarefa agendada chamada "Atualização de Estoque" é acionada, ajustando a quantidade do produto disponível para venda de acordo com as reservas.
Para gerenciar as tarefas disponíveis em seu ambiente, acesse Configurações > Outros > Tarefas agendadas.
Para que a importação de pedidos aconteça, é necessário configurar as transportadoras na plataforma e posteriormente no Eccosys em Cadastros > Transportadoras.
Seu vínculo também precisa ser feito em Configurações > Cadastros > Vínculos de transportadoras. Para mais detalhes sobre a criação e vínculo de transportadoras, clique aqui.
A VTEX permite que a reserva aconteça na própria plataforma, caso esta configuração seja implementada o nosso time de suporte deve ser acionado para que a reserva não seja duplicada e os seus produtos não fiquem indisponíveis para venda!
Como importar pedidos da VTEX
A importação de pedidos no Eccosys varia conforme o tipo de integração com a plataforma VTEX:
Integração com VTEX REST: Para clientes que utilizam a integração com a VTEX REST, ao contratar o complemento de Webhook, a importação de pedidos ocorre em tempo real. Isso significa que, sempre que um pedido é gerado na plataforma VTEX, ele é automaticamente importado para o Eccosys, sem a necessidade de executar tarefas agendadas. Dessa forma, os pedidos são recebidos no Eccosys assim que são criados na VTEX, tornando o processo mais ágil e sem intervenções manuais.
Integração com VTEX Padrão (versão anterior à REST): Para quem utiliza a integração com a versão padrão da VTEX, a importação é realizada por meio de uma tarefa agendada. Nesse caso, todos os pedidos disponíveis na plataforma são importados de forma massiva e automática.
Também é possível realizar a importação de pedidos individualmente, acessando Configurações > Outros > Tarefas Agendadas, onde você encontrará a tarefa "Importar Pedidos de Venda". Além disso, essa integração oferece uma tela própria para a seleção e importação manual dos pedidos, que pode ser acessada em Configurações > Plataforma > Pedidos de Venda.
Esta integração também possui uma tela própria para seleção e importação manual de pedidos. Você pode acessá-la em Configurações > Plataforma > Pedidos de venda. Selecione o pedido e em “Ações > Baixar pedidos de venda selecionados”.
Para que a importação de pedidos aconteça, é necessário configurar as transportadoras na plataforma e posteriormente no Eccosys em Cadastros > Transportadoras.
Seu vínculo também precisa ser feito em Configurações > Cadastros > Vínculos de transportadoras. Para mais detalhes sobre a criação e vínculo de transportadoras, clique aqui.
Como enviar código de rastreio para Vtex
No Eccosys é possível montar a URL de rastreio e enviar essa informação para a plataforma Vtex.
Para isso, além de garantir a integração logística ativa e preencher o campo referente ao Vínculo da transportadora, será necessário configurar a tarefa '’Sincronizar Status dos Pedidos de Venda’' por meio da funcionalidade de 'agendamento de tarefa'.
Conclusão
Após realizar e revisar todas as configurações da plataforma, recomendamos a execução de testes para envio e baixa de produtos, bem como para a gestão de pedidos, a fim de garantir o funcionamento adequado de todos os processos.
Em caso de dúvidas, nosso time de suporte está à disposição para auxiliar.