TOTVS Omni

Árvore de páginas

Versões comparadas

Versão antiga 23

changes.mady.by.user Usuário desconhecido (igor.aguiar)

Gravado em

comparado com

Nova versão 24

changes.mady.by.user Usuário desconhecido (francielly.nunes)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

Índice
include^[0-9]2?

01. VISÃO GERAL

O conector VTEX permite trabalhar com múltiplos cenários de integração:

  • Único Seller: Quando a empresa tem apenas um seller de VTEX, que atende pedidos do marketplace.
  • Multi-Seller: Quando a empresa tem registrado vários sellers, que atendem pedidos do marketplace.
  • Docas: Quando há apenas um seller registrado, porém foi configurado docas, ou pontos de retirada dos produtos.


Para configurar estes cenários é necessário parametrizar as credenciais associadas ao conector e ao site do cliente.

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

02. FUNCIONAMENTO

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

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.

  • 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.

Parâmetro da CredencialDescriçãoFormato do Parâmetro, Exemplo e Observações
ACCOUNT_NAME

VTEX_EXTERNAL_SUBPRODUCTO_ID Nome da conta relacionada ao seller principal.

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

Formato: Texto


APP_KEY

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


APP_TOKENToken da access key gerada.

Formato: Texto


ENVIROMENTSufixo da URL de acesso à API do vtex.

Formato: Texto


GROUP_PRODUCT_BY_MODEL

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

MAIL TO

Formato: Texto



Formato: Texto


VTEX_META_TAG_DESCRIPTION

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


VTEX_SUBPRODUCTO_REFID_OPTION

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 = SubProduto EAN
3 = SubProduto SKU
4 = Produto(AlfaCode + Site) e SubProduto(AlfaCode + Site + Tamanho)

VTEX_SKU_SITE_LABELCampo do Omni que será utilizado na publicação do produto para preencher o valor do campo "name" do VTEX.

Formato: Número

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

VTEX_TITLE

Formato: Texto


NOMBRE_SEO

Formato: Texto


VTEX_COLOR_LABELTexto utilizado para o campo Cor.

Formato: Texto


VTEX_SIZE_LABELTexto utilizado para o campo Tamanho.

Formato: Texto


VTEX_ATTRIBUTE_IN_REF_ID

Atributo que será utilizado na gravação do campo "RefId" durante a criação do produto.

Usado em conjunto com o campo VTEX_SUBPRODUCTO_REFID_OPTION.

Veja documentação VTEX: https://developers.vtex.com/vtex-rest-api/reference/catalog-api-product#post-product

Formato: Texto


VTEX_CATEGORY_ACTIVE_STORE_FRONT_LINK

Configura o parametro "ActiveStoreFrontLink" durante a criação da categoria no VTEX.

Veja documentação VTEX: https://developers.vtex.com/vtex-rest-api/reference/catalog-api-category#catalog-api-post-category

Formato: Texto

Valores possíveis: True ou False

VTEX_CATEGORY_SHOW_BRAND_FILTER

Configura o parametro "ShowBrandFilter" durante a criação da categoria no VTEX.

Veja documentação VTEX: https://developers.vtex.com/vtex-rest-api/reference/catalog-api-category#catalog-api-post-category

Formato: Texto

Valores possíveis: True ou False

VTEX_CATEGORY_SHOW_IN_STORE_FRONT

Configura o parametro "ShowInStoreFront" durante a criação da categoria no VTEX.

Veja documentação VTEX: https://developers.vtex.com/vtex-rest-api/reference/catalog-api-category#catalog-api-post-category

Formato: Texto

Valores possíveis: True ou False

VTEX_COMERCIAL_CONDITIONNa criação do produto no VTEX, popula o campo "CommercialConditionId" do VTEX com o valor configurado.

Formato: Número


VTEX_EXTERNAL_SKU_ID

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

VTEX_EXTERNAL_SUBPRODUCTO_IDIndica se as variantes serão identificadas pelo Id do Sub Produto (valor “yes”) ou pelo atributo ID_ITEM_VTEX do sub produto.

Formato: Texto

Valores possíveis: "yes" ou "no"

Valor em branco significa "no".


VTEX_ID_FORMA_PAGO

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).


Formato: Objeto JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
{
	"1": "1",
	"2": "1",
	"3": "1",
	"4": "1",
	"6": "40",
	"8": "1",
	"9": "1",
	"16": "4",
	"44": "1",
	"45": "1"
}
VTEX_ID_OPERADOR_LOGISTICO

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.

Formato: Objeto JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
{
	"Transportadora Jadlog": "63",
	"PAC - Correios": "61",
	"Sedex - Correios": "61",
	"Padrão - Transportadora Total Express": "64"
}
VTEX_MAP_CREDITCARD_BRAND

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.

Formato: Objeto JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
{
	"2": "VISA",
	"4": "MASTERCARD",
	"1": "AMEX",
	"3": "DINERS"
}
VTEX_MAP_GATEWAYPGTO_OPERADOR

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.


Formato: Objeto JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
{
	"Meu Gateway V1": "GTWYOMNI"
}
VTEX_MULTIPLE_FRANCHISESLista do nome das franquias registradas no VTEX.
Corresponde aos nomes presentes na coluna Nome, no Gerenciamento de Sellers na administração do VTEX.

Formato: Texto

Exemplo: vtextotvsloja1, vtextotvsloja2, vtextotvsloja3

VTEX_ORIGINAL_CODE_IN_REF_ID

Formato: Número


VTEX_SERVICE_LEVEL_COD_LOGISTIC

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.

Formato: Objeto JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
{
	"Transportadora Jadlog": "3",
	"PAC - Correios": "0001",
	"Sedex - Correios": "0002",
	"Padrão - Transportadora Total Express": "P"
}
VTEX_SHOW_IN_SITE

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

VTEX_SHOW_WITHOUT_STOCK

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

ShowWithoutStock - boolean - Defines if the Product will remain being shown in the store even if it’s out of stock

Formato: Texto

Valores possíveis: True ou False

VTEX_SPECIFICATIONS

Formato: Número


VTEX_STOCK_BY_STORE

Formato: Texto

Valores possíveis: True ou False

VTEX_STOCK_SEG_LOJA

Configura um stock de segurança para os produtos a serem publicados no VTEX para cada loja Omni.

Este valor, por loja, será descontado do valor a ser publicado no estoque do SKU na VTEX.

Formato: Array JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
[
	{
		"idStore": "19",
		"value": 1
	},
	{
		"idStore": "13",
		"value": 1
	}
]
VTEX_STORE

Formato: Array JSON

Exemplo: 

vTex_tradePolicyIdNa atualização do estoque e preço no VTEX, popula o campo "tradePolicyId" do VTEX com o valor configurado.Formato: Number
vtex.atributos.precargados

VTEX_FORCE_GET_ORDER_LIST

O VTEX passou, em 2021, a utilizar a URL de feed para listar os pedidos que devem ser processados. Com isso o conector passou a utilizar este modelo.

Caso seja necessário desabilitar este modelo de feed e forçar o uso do endpoint get order list é necessário passar o valor "True" para este parametro.

Formato: Texto

Valores possíveis: True ou não passar nada.

VTEX_DOCAS_MAPA_LOJAS

Caso o cliente utilize docas e se queira habilitar o uso de docas no conector, configura-se aqui o mapa de de-para entre os IDs das docas e os IDs das lojas correspondentes para cada account name do VTEX.

Ao configurar o mapeamento neste parametro o pedido será criado no Omni com a identificação de qual doca foi definida para cada item do pedido. Com isso caso um pedido contenha 2 itens e estes itens tenham docas diferentes, o Omni irá splitar o pedido direcionando os itens para as lojas correspondente ao mapeamento.

Formato: Array JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
{
	"accountNameA":{
		"docaA1":"idlojaA1",
		"docaA2":"idlojaA2",
		"docaA3":"idlojaA3"
	},
	"accountNameB":{
		"docaB1":"idlojaB1",
		"docaB2":"idlojaB2",
		"docaB3":"idlojaB3"
	},
	"accountNameC":{
		"docaC1":"idlojaC1",
		"docaC2":"idlojaC2",
		"docaC3":"idlojaC3"
	}
}

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.


Parâmetro da PropertiesDescriçãoFormato do Parâmetro, Exemplo e Observações
vtex.appkey.<idSiteCanal>.<nomeSellerVTEX>Id Externo da loja do Omni correspondente ao seller do VTEX.Exemplo: vtex.appkey.728.vtextotvsloja1=1
vtex.warehouse.<idSiteCanal>.<idExternoLojaOmni>Exemplo: vtex.warehouse.728.1=1_1
vtex.accountname.<idSiteCanal>.<idExternoLojaOmni>Nome do Seller correspondente à loja cadastrada no Omni.Exemplo: vtex.accountname.728.1=vtextotvsloja1
vtex.appkey.<idSiteCanal>.<idExternoLojaOmni>Access key gerada na administração do seller no VTEX.Exemplo: vtex.appkey.728.1=vtexappkey-vtextotvsloja1-ABCDE
vtex.apptoken.<idSiteCanal>.<idExternoLojaOmni>Token da access key geradaExemplo: vtex.apptoken.728.1=NJGOHLKZQ...




Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!


05. TABELAS UTILIZADAS