Histórico da Página

...

As credenciais são acessíveis através do menu lateral do Omni: Gerenciador de canais > Credenciais > Alterar para o Site Principal na caixa de seleção superior, e selecionar VTEX

Image Modified

OBS: Para que o canal VTEX apareça na lista de credenciais para configuração é necessário solicitar no suporte TOTVS um procedimento de associação do Site Principal, do Site Canal de Venda e do Canal VTEX.

02. FUNCIONAMENTO PADRÃO

O conector VTEX funciona através de ações agendadas através das publicações.

Image RemovedImage Added

A seguir os métodos/operação que o conector opera na integração Omni/VTEX:

• updateMasterData: Este método prepara a estrutura do VTEX com as Marcas e Categorias relacionadas aos produtos disponíveis no site do Omni. 
  Este método pode ser executado em qualquer publicação, e afetará a instância do VTEX.
  
  
• insertProducts: Para publicar produtos que foram incluídos na publicação (seja nova publicação ou pré existente) deve-se executar esta operação.
  Importante salientar que devido a requerimento do VTEX, o produto é criado com status inativo, porém depois de um este status é alterado pelo próprio VTEX, quando 
  o preço, estoque e foto forem carregados.
  
  Esta operação também sobe as fotos presentes no Omni para o VTEX.
  
  Os produtos são sempre cadastrados no seller principal do VTEX.
  
  
• updateProducts: Quando há modificações nos produtos (modificações de atributos - fora estoque e preço) esta operação atualiza o produto que já está publicado no VTEX.
  
  Importante: se as credenciais de Cor e/ou Tamanho (VTEX_COLOR_LABEL / VTEX_ SIZE_LABEL) forem alteradas, o método updateProducts vai alterar as especificações apenas nas categorias e não nos produtos, sendo necessário excluir os produtos da publicação, executar o método updateMasterData e inserir os produtos novamente. 
  
  
• updateStock: Atualiza o estoque dos produtos de acordo com os cenários suportados (vide 01. updateStock: Atualiza o estoque dos produtos de acordo com os cenários suportados (vide 01. Visão Geral). O estoque pode ser atualizado diretamente no seller principal, 
  para cada seller (no caso de multi-seller) ou nas docas.
  
  Importante que os IDs das lojas cadastradas no TOTVS Omni seja configuradas no conector com o ID do seller/doca (Vide 03. Parâmetros de Credenciais e 04. Parâmetros de Propriedades).
  
  
• updatePrices: Atualiza o preço dos produtos no seller central.
  
  
• eliminarPublicaciones: Remove produtos do VTEX, desde que o produto não esteja mais em nenhuma publicação do canal.
  
  
• importOrders: Baixa para o Omni os pedidos de VTEX que estão no status "ready-for-handling" no VTEX.
  
  Este método pode ser executado a partir de qualquer publicação.
  
  
• sendStatusOrders: Atualiza os pedidos do Omni no VTEX, subindo informação sobre fatura (para pedidos que já foram faturados) e número de rastreamento (pedidos que já foram acionado a logística), além do status do pedido no Omni (Vide fluxos em Layout Email Notificacao Omni).
  Este método pode ser executado a partir de qualquer publicação.

Ao final de cada operação o Omni gera um relatório da execução, informando se todos os produtos da publicação foram integrados ou não.

03. PARAMETROS DE CREDENCIAIS

A seguir os parametros de credencial do conector VTEX e descrição de como configurar-los.

...

Nome da conta relacionada ao seller principal.

Valor encontrado na administração do VTEX, Configurações da conta > Gerenciamento da conta > Conta

Formato: Texto

...

Access key gerada na administração do VTEX, Configurações da conta > Gerenciamento da conta > Conta

Lembrando que após a geração da Access key, é necessário criar um usuário com o email deste usuário sendo a Access Key, e adcionar o perfil de owner, em Configurações da conta > Gerenciamento da conta > Usuários.

Formato: Texto

...

Formato: Texto

...

Formato: Texto

...

Se este parâmetro estiver ativado (True) os produtos que forem publicados no VTEX serão agrupados pelo nome do modelo do produto no Omni.

Caso esteja desativado (False) os produtos do Omni (modelo-cor) serão publicados de acordo com a estrutura de produtos e subprodutos do Omni.

...

Formato: Texto

Valores possíveis: True ou False

...

Formato: Texto

...

mail.to

Formato: Texto

...

Nome do campo do Omni que contém o valor será utilizado para no atributo MetaTagDescription durante a criação do produto no VTEX.

Caso não seja passado valor, é utilizado o valor do campo DESCRIPCION_SEO do produto no Omni.

Caso o DESCRIPCION_SEO não esteja popular, não é preenchido o atributo MetaTagDescription.

Formato: Texto

...

Ao publicar um produto no VTEX, o Omni cadastra no campo refID do produto e sku no VTEX, a identificação única do subproduto do Omni, correlacionando as duas entidades.

Algumas opções de geração do refID se apresentam através deste parâmetro.

Ao baixar o pedido, o conector utiliza o campo refID do produto dentro do pedido para identificar unicamente o subproduto no Omni e criar o pedido no Omni.

...

Formato: Número

Valores possíveis:
1 = Produto(AlfaCode) e SubProduto (AlfaCode + Tamanho)
2 = Produto(AlfaCode + Site) e SubProduto(AlfaCode + Site + Tamanho)
3 = SubProduto SKU
4 = SubProduto EAN

...

Formato: Número

Valores possíveis: 
1 = Name
2 = Size
3 = Size+Color

...

Formato: Texto

...

Formato: Texto

...

Formato: Texto

...

Formato: Texto

...

Formato: Texto

...

Formato: Texto

Valores possíveis: True ou False

...

Formato: Texto

Valores possíveis: True ou False

...

Formato: Texto

Valores possíveis: True ou False

...

Formato: Número

...

Possibilita o cliente criar identificação do SKU do Produto utilizando o id do subproduto gerado pelo ERP.Se o valor for yes, o conector publicará o produto no canal VTEX usando o SKU do produto no Omni como o ID do produto no VTEX.

Caso seja no, o conector utilizará um código interno gerado pelo Omni como ID do produto no VTEX.

Possibilidades:

yes: Cria id do SKU na VTEX utilizando o id do subproduto gerado pelo ERP;

no: Cria id do SKU na VTEX automáticamente(id sequêncial gerado pela VTEX)

...

Formato: Texto

Valores possíveis: yes ou no

...

Formato: Número

...

JSON de mapeamento entre os ID das bandeiras de cartão cadastradas no VTEX e os códigos de forma de pagamento no Omni.

Esta informação é utilizada pelo conector do VTEX para popular o campo de forma de pagamento na criação do pedido no Omni.

Para recuperar os valores de IDs cadastrados no VTEX, acesse na administração do VTEX: Menu Transações > Pagamentos > Configurações > Condições de Pagamento.

Verifique o ID de cada condição de pagamento e associe aos IDs de formas de pagamento do Omni (Vide Lista de IDs do TOTVS Omni).

...

{
	"1": "1",
	"2": "1",
	"3": "1",
	"4": "1",
	"6": "40",
	"8": "1",
	"9": "1",
	"16": "4",
	"44": "1",
	"45": "1"
}

• Além disso, caso o pedido seja cancelado, este método atualiza o pedido no VTEX executando um cancelamento ou alteração, baseado se o pedido original em questão foi splitado ou não.
  Caso o pedido original tenha sido splitado (O pedido filho tem irmão(s)), o pedido VTEX será modificado e retirado os itens contidos no pedido filho que foi cancelado.
  Caso o pedido splitado seja único ou o ultimo filho a ser cancelado, o pedido no VTEX é cancelado totalmente.
  
  Este método pode ser executado a partir de qualquer publicação. Ele toma como base consulta por pedidos com status id 403,3,13,4,16,38 e 8 nos ultimos 15 dias.
  
  
• updateStatusOrder: Atualiza os pedidos do VTEX no Omni, verificando se há algum pedido que foi cancelado no VTEX e atualiza o pedido correspondente no Omni com status 424 (ESTADO_PEDIDO_ANULADO_EN_MARKETPLACE).
  
  
• syncProductsRelationship: Atualizad o relacionamento entre 2 SKUs dentro do VTEX de acordo com o relacionamento dos produtos correspondentes no Omni.

Ao final de cada operação o Omni gera um relatório da execução, informando se todos os produtos da publicação foram integrados ou não.

Agendamento automatizado:
Os seguintes métodos são automaticamente executados para todos os sites canal VTEX com a periodicidade abaixo

Caso seja necessário periodicidade diferenciada é necessário soliciar ao suporte ajustes específicos para o cliente.

Para visualizar as execuções em curso acesse:
https://plataforma.omni.totvs.com.br/chm/ejecuciones

03. CENÁRIOS DE FUNCIONAMENTO

O conector VTEX funciona para 3 cenários distintos. Para tanto documentamos o que precisa ser configurado e como deve ser configurado separadamente abaixo:

1. Conta Única no VTEX
2. Contas Franquias
3. Docas

Independente do cenário escolhido um Site Canal VTEX deve ser obrigatoriamente configurado como Kiosque e relacionado ao site principal conforme imagem abaixo:

Image Added

04. PARAMETROS DE CREDENCIAIS

A seguir os parametros de credencial do conector VTEX e descrição de como configurar-los.

{
	"1": "1",
	"2": "1",
	"3": "1",
	"4": "1",
	"6": "40",
	"8": "1",
	"9": "1",
	"16": "4",
	"44": "1",
	"45": "1"
}

{
	"Transportadora Jadlog": "63",
	"PAC - Correios": "61",
	"Sedex - Correios": "61",
	"Padrão - Transportadora Total Express": "64"
}

{
	"2": "VISA",
	"4": "MASTERCARD",
	"1": "AMEX",
	"3": "DINERS"
}

{
	"Meu Gateway V1": "GTWYOMNI"
}

{
	"Transportadora Jadlog": "3",
	"PAC - Correios": "0001",
	"Sedex - Correios": "0002",
	"Padrão - Transportadora Total Express": "P"
}

[
	{
		"idStore": "19",
		"value": 1
	},
	{
		"idStore": "13",
		"value": 1
	}
]

[
	{
		"addressId": "loja19",
		"storeId": "19"
	},
 	{
		"addressId": "20",
		"storeId": "20"
	} 
]

{
	"accountNameA":{
		"docaA1":"idlojaA1",
		"docaA2":"idlojaA2",
		"docaA3":"idlojaA3"
	},
	"accountNameB":{
		"docaB1":"idlojaB1",
		"docaB2":"idlojaB2",
		"docaB3":"idlojaB3"
	},
	"accountNameC":{
		"docaC1":"idlojaC1",
		"docaC2":"idlojaC2",
		"docaC3":"idlojaC3"
	}
}

05. PARAMETROS DE PROPRIEDADES

5.1. Cenário de multi-sellers

No caso do VTEX utilizar cenário de multi-sellers as credenciais (key e token) do seller principal ficam configuradas nos parâmetros de credencial correspondente, porém as credenciais de cada seller precisam ser cadastradas em arquivo de properties dentro do código do conector, necessitando assim passar para produção (deploy).

As informações abaixo devem ser configuradas no arquivo marketplaceVtex.properties do conector para cada seller registrado no VTEX do cliente.

5.2. ATIVAR CATEGORIAS OMNI & VTEX

Acessar o menu menu Gerenciador de Produtos > Selecione a opção Gerenciar Categorias > Busque na categoria que deseja ativar ou inativar > Marque a opção ''Visível''.

...

Mapeamento entre os Métodos de Envio que constam nas estratégias de envio registradas no VTEX e o código de operador logístico do Omni.

Esta informação é utilizada pelo conector do VTEX para designar o pedido do Omni ao operador logístico correspondente.

Para recuperar os valores cadastrados no VTEX, acesse na administração do VTEX: Menu Pedidos > Estoque & Entrega > Estratégia de envio.

Verique o ID de cada Operador Logístico na página Lista de IDs do TOTVS Omni.

...

{
	"Transportadora Jadlog": "63",
	"PAC - Correios": "61",
	"Sedex - Correios": "61",
	"Padrão - Transportadora Total Express": "64"
}

...

JSON de mapeamento entre os nomes das bandeiras de cartão cadastradas no VTEX e os valores de bandeiras de cartão de crédito cadastradas no ERP.

Esta informação é utilizada pelo conector do VTEX para popular o campo bandeira do cartão de crédito da forma de pagamento na criação do pedido no Omni.

Para recuperar os valores cadastrados no VTEX, acesse na administração do VTEX: Menu Transaçoes > Pagamentos > Configurações > Condições de Pagamento.

Anote o ID de cada tipo de cartão e configure o JSON de mapeamento com os valores normalizados para o TOTVS Omni. Importante salientar que estes valores de nome de bandeira de cartão de crédito devem ser normalizados no Omni para envio ao ERP.

Caso identifique uma bandeira de cartão nova, importante avisar à equipe de desenvolvimento do Omni.

...

{
	"2": "VISA",
	"4": "MASTERCARD",
	"1": "AMEX",
	"3": "DINERS"
}

...

JSON de mapeamento entre os gateways de pagamento cadastrados no VTEX e o nome dos Gateways que o ERP integrado no Omni espera receber.

Esta informação é utilizada pelo conector do VTEX para popular o campo operador da forma de pagamento do pedido no Omni.

Para recuperar os valores cadastrados no VTEX, acesse na administração do VTEX: Menu > Transaçoes > Pagamentos > Configurações > Afiliações de Gateways.

...

{
	"Meu Gateway V1": "GTWYOMNI"
}

...

Formato: Texto

Exemplo: vtextotvsloja1, vtextotvsloja2, vtextotvsloja3

...

Formato: Número

...

Mapeamento entre os métodos de envio das estratégias de envio registradas no VTEX e o código do tipo de entrega suportado pelo operador logístico integrado ao Omni.

Esta informação é utilizada pelo conector do VTEX para popular o campo código do nível de serviço logístico na criação do pedido no Omni.

Ao iniciar a logística, o conector do operador logístico receberá o valor presente neste mapeamento para especificar a forma de entrega (Ex: Expressa, normal, em 2hs, etc). Este valor depende e varia para cada operador logístico.

Para recuperar os valores cadastrados no VTEX, acesse na administração do VTEX: Menu Pedidos > Estoque & Entrega > Estratégia de envio.

...

{
	"Transportadora Jadlog": "3",
	"PAC - Correios": "0001",
	"Sedex - Correios": "0002",
	"Padrão - Transportadora Total Express": "P"
}

...

Utilizado para popular o atributo IsVisible durante a criação do produto no VTEX.

Se o parâmetro estiver com valor "yes" IsVisible = true, Se valor "no", IsVisible = false.

...

Formato: Texto

Valores possíveis: yes ou no

...

Utilizado para popular o atributo ShowWithoutStock durante a criação do produto no VTEX.

Vide https://developers.vtex.com/vtex-developer-docs/reference/catalog-api-product

...

Formato: Texto

Valores possíveis: True ou False

...

Formato: Número

...

Formato: Texto

Valores possíveis: True ou False

...

[
	{
		"idStore": "19",
		"value": 1
	},
	{
		"idStore": "13",
		"value": 1
	}
]

...

Formato: Array JSON

Exemplo: 

...

04. PARAMETROS DE PROPRIEDADES

No caso do VTEX utilizar cenário de multi-sellers as credenciais (key e token) do seller principal ficam configuradas nos parâmetros de credencial correspondente, porém as credenciais de cada seller precisam ser cadastradas em arquivo de properties dentro do código do conector, necessitando assim passar para produção (deploy).

As informações abaixo devem ser configuradas no arquivo marketplaceVtex.properties do conector para cada seller registrado no VTEX do cliente.

...