TOTVS Omni

Árvore de páginas

Versões comparadas

Versão antiga 18

changes.mady.by.user Felippe Augusto de Oliveira Neto

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Felippe Augusto de Oliveira Neto

Gravado em

Chave

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

...

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.

  • 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

MétodoPeriodicidade
updateStockA cada 15min
importOrdersA cada 15min
updatePricesA cada 12hs
sendStatusOrdersA cada 1h
syncProductsRelationshipA cada 24hs
updateStatusOrderA cada 24hs

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.

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Texto

Formato: Número

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

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: Número

Formato: Número

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 no refID do sku no VTEX, a identificação única do produto e subproduto do Omni, respectivamente, correlacionando as duas entidades.

Para o refID do SKU do VTEX, as opções de geração do refID se apresentam ao lado no Valores Possíveis.

Para o refID do Produto no VTEX, a regra é:

1 = refID do produto será AlfaCode

Caso seja selecionado outro valor, o ID Articulo Modalia é usado a não ser que seja preenchido o campo VTEX_ATTRIBUTE_IN_REF_ID com o nome de um atributo do produto no Omni.


OBS: 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 = refID do SubProduto será AlfaCode + Tamanho
2 = refID do SubProduto será SubProduto EAN
3 = refID do SubProduto será SKU
4 = refID do SubProduto será ID Articulo Modalia  (AlfaCode + Nome do Site + Tamanho)

VTEX_SKU_SITE_LABEL

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

Utilizar um dos valores possíveis ao lado.
Caso não seja passado nenhum valor, então por default usa a regra 3.

Formato: Número

Valores possíveis: 
1 = Usa o campo NICK_NAME. Caso o NICK_NAME esteja vazio no produto usa Color+Size.
2 = Tamanho do subproduto que vem do ERP (TallajeOriginalCliente)
3 = Color+Size

VTEX_TITLELista de Atributos do Omni (separados por | ) que compõem o título do produto no VTEX.


Formato: Texto

Exemplo: NICK_NAME|DESCRIPCION

OBS: Caso não seja passado valor é utilizado o atributo NICK_NAME.

USE HIGH QUALITY IMAGE

Indica para o conector utilizar as imagens originais dos produtos na carga de imagem para os SKUs no VTEX.

O funcionamento padrão do conector utiliza uma imagem com resolução menor, gerada pelo Omni a partir da imagem carregada pelo cliente na integração de imagens. Veja Integracao de Fotos.

Porém é possível dizer ao conector para utilizar a imagem com a resolução original carregada pelo cliente para dentro do Omni, para ser esta imagem a ser carregada para o VTEX.


OBS: A performance do conector VTEX pode ser reduzida devido ao tamanho dos arquivos.

Formato: Texto

Valores possíveis: "True" indica para usar a imagem original.
Qualquer outro valor ou vazio mantém o funcionamento padrão do conector.

TITLE ATTRIBUTES LIST FORMATION Atributos Omni que formam o título do produto (SKU no VTEX).

Formato: Texto, com caráter | como separador de campos.

Exemplo: NICK_NAME|DESCRIPCION

VTEX_ATR_NAMEAtributos Omni que formam o Nome do produto no VTEX.

Formato:  Texto, com caráter | como separador de campos.
Exemplo: NOMBRESEO|NICK_NAME    

OBS: Caso não seja passado valor é utilizado o atributo NOMBRESEO.

VTEX_COLOR_LABEL

Texto utilizado para o campo Cor.

Se não for passado valor e o site do canal de venda estiver configurado para localização Brasil (COD ISO com valor BR e Zona Brasil) então não será criada a especificação de cor para as categorias durante a execução do método updateMasterData, sendo assim os SKUs não terão especificações de cor.

Formato: Texto


VTEX_SIZE_LABEL

Texto utilizado para o campo Tamanho.

Se não for passado valor e o site do canal de venda estiver configurado para localização Brasil (COD ISO com valor BR e Zona Brasil) então não será criada a especificação de tamanho para as categorias durante a execução do método updateMasterData, sendo assim os SKUs não terão especificações de tamanho.

Formato: Texto


VTEX_ATTRIBUTE_IN_REF_ID

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

Usado em conjunto com o campo VTEX_SUBPRODUCTO_REFID_OPTION, quando a opção deste parametro não for 1. 


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

Formato: Texto

Exemplo: NICK_NAME

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

Obs: VTEX não aceita valores alfanumérico, somente números.

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.

Obs: VTEX não aceita valores alfanumérico, somente números.

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

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

Nome da conta relacionada ao seller principal.

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

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.

APP_TOKENToken da access key gerada.ENVIROMENTSufixo da URL de acesso à API do vtex.
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

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.

Opções de RefID

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

SKU 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

TITLE ATTRIBUTES LIST FORMATIONNOMBRE_SEOVTEX COLOR LABELTexto utilizado para o campo Cor.VTEX SIZE LABELTexto utilizado para o campo Tamanho.VTEX_ATTRIBUTE_IN_REF_IDVTEX_CATEGORY_ACTIVE_STORE_FRONT_LINK

Formato: Texto

Valores possíveis: True ou False

VTEX_CATEGORY_SHOW_BRAND_FILTER

Formato: Texto

Valores possíveis: True ou False

VTEX_CATEGORY_SHOW_IN_STORE_FRONT

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

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

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_IDVTEX_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 Jadlog1": "31",
	"PAC - Correios2": "00011",
	"Sedex - Correios3": "00021",
	"Padrão - Transportadora Total Express4": "P1"
}
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_SPECIFICATIONSVTEX_STOCK_BY_STORE

Formato: Texto

Valores possíveis: True ou False

VTEX_STOCK_SEG_LOJA

Formato: Array JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
[
	{
		"idStore": "19",
		"value": 1
	},
	{
		"idStore": "13",
		"value": 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

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
{
	"accountNameAMeu Gateway V1":{
		"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.

 "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_STOREIdentifica se o estoque do produto será publicado por loja (doca ou franquia) (valor true), ou se será publicado o estoque consolidado na instância principal do VTEX (valor false). 

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

Este mapeamento de código de loja entre VTEX e Omni é utilizado para pedidos de pickup.

Ao definir em qual loja (franquia ou doca) no vtex o pedido será retirado, o conector baseia-se neste mapeamento para designar a loja de entrega do pedido no Omni.


Formato: Array JSON

Exemplo: 

Bloco de código
languagejs
titleJSON
collapsetrue
[
	{
		"addressId": "loja19",
		"storeId": "19"
	},
 	{
		"addressId": "20",
		"storeId": "20"
	} 
]
vTex_tradePolicyIdPopula o campo da política comercial à qual o produto deverá estar associado através de ID. Também alimenta a tabela de preços associada à esta política comercial.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 algum valor neste parametro.

Neste caso os possíveis formatos de valores são:

  • Uma data (formato DD/MM/YYYY): Indica para o conector consultar pedidos do dia passado.
  • Um número: Indica para o conector consultar pedidos retrocedendo o número de dias passado como parametro (Limitado à 365 dias).


Formato: Texto

Valores possíveis: Deixar vazio ou passar valores de filtro.

VTEX_DOCAS_MAPA_LOJAS

Caso o cliente utilize docas no VTEX e queira habilitar o uso de docas no conector para baixar pedido, 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.

A configuração de docas associa cada item do pedido com uma doca, isto é, uma loja de expedição, independente se o pedido é de pickup ou shipping.

Com isso caso um pedido contenha 2 itens e estes itens tenham docas diferentes, o Omni irá splitar o pedido em 2, direcionando cada pedido filho (contendo o respecitvo item) para a loja correspondente ao mapeamento de docas.

Utilizado somente pelo método importOrders.

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"
	}
}

Nesse parâmetro deve ser configurado para que seja enviada as informações ao canal de vendas.

1-Caso seja marcado como TRUE o parâmetro atualiza  os campos, deixando-os marcados

2-Caso seja marcado como FALSE o parâmetro atualiza  os campos, deixando-os desmarcados.

3-Caso não seja informado nas credenciais será enviado como FALSE.

Campos a serem sensibilizados no canal Vtex:

Image Added


Formato: Texto

Valores possíveis: True ou False

VTEX_CATEGORY_SHOW_BRAND_FILTER (True or False)

Nesse parâmetro deve ser configurado para que seja enviada as informações ao canal de vendas.

1-Caso seja marcado como TRUE o parâmetro atualiza os campos, deixando-os marcados

2-Caso seja marcado como FALSE o parâmetro atualiza os campos, deixando-os desmarcados.

3-Caso não seja informado nas credenciais será enviado como FALSE.

Campos a serem  sensibilizados no canal Vtex:

Image Added


Formato: Texto

Valores possíveis: True ou False

Nesse parâmetro deve ser configurado para que seja enviada as informações ao canal de vendas.

1-Caso seja marcado como TRUE o parâmetro atualiza  os campos, deixando-os marcados

2-Caso seja marcado como FALSE o parâmetro atualiza  os campos, deixando-os desmarcados.

3-Caso não seja informado nas credenciais será enviado como FALSE.

Campos a serem sensibilizados no canal Vtex

Image Added


Formato: Texto

Valores possíveis: True ou False

IMAGE_NAME_COMPOSITE

Lista de atributos de produto utilizados na composição do prefixo do nome da imagem dos produtos no VTEX.

Os atributos que são separados por espaço, devem ser preenchidos com "_".

Exemplo: NOMBRE MARCA deve ficar NOMBRE_MARCA 

Os atributos não encontrados ou com valores vazios serão descartados da composição da nomenclatura da imagem.

Os parâmetros não podem conter espaços entre as vírgulas.

Exemplo que não pode acontecer: NICK_NAME,  NOMBRE_MARCA

Formato: Texto
VTEX_UPDATE_PEDIDOS_QTDE_DIASNo envio de status de pedido do Omni para o canal de venda, este parametro define quantos dias para trás será consultado pedidos no Omni.

Formato: Número

Caso seja deixado em branco, é adotado o valor padrão 10 dias.

VTEX_ID_SITE_AGRUPADOR_ROTULOS

Se a estrutura de sites para o cliente utilizar um site especial, agrupador de rótulos (estrutura conhecida como Site Avo-Pai), e o site do canal de venda VTEX estiver vinculado ao site Avo, é necessário preencher nesta credencial o ID do Site agrupador de rótulos (Site Avo).

Quando é executado o método updateMasterData, as marcas provenientes dos vários sites rótulos (pais) são associadas ao id do Site avo, e com esta credencial preenchida na hora de fazer a publicação do produto o TOTVS Omni identifica o Id do Site agrupador de rótulos para buscar a marca internamente.

Formato: Texto, porém precisa ser um número correspondente ao ID do Site Agrupador de Rótulos.
VTEX_PROCESSO_PEDIDO_MARKETPLACEIndica se o VTEX está configurado para baixar pedidos de marketplace que devem ser importados pelo Omni.

Formato: Texto

Valores possíveis: True ou False

Caso seja deixado em branco, é adotado o valor false

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.


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.763.vtextotvsloja1=1
vtex.warehouse.<idSiteCanal>.<idExternoLojaOmni>id do warehouse que deve ser associado à loja do Omni.Exemplo: vtex.warehouse.763.1=1_1
vtex.accountname.<idSiteCanal>.<idExternoLojaOmni>Nome do Seller correspondente à loja cadastrada no Omni.Exemplo: vtex.accountname.763.1=vtextotvsloja1
vtex.appkey.<idSiteCanal>.<idExternoLojaOmni>Access key gerada na administração do seller no VTEX.Exemplo: vtex.appkey.763.1=vtexappkey-vtextotvsloja1-ABCDEF
vtex.apptoken.<idSiteCanal>.<idExternoLojaOmni>Token da access key gerada.Exemplo: vtex.apptoken.763.1=ABCDEFGHIJKLMNOPQRSTUVXYZ...

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

Habilitar ou desabilitar categorias.

1 - Quando a opção ''Visível'' estiver habilitada, essa categoria estará ativa e será sempre atualizada pela rotina ''Updatemasterdata''. 

2- Quando a opção ''Visível'' estiver desabilitada, essa categoria não será atualizada pela rotina  ''Updatemasterdata'' deixando a categoria inativa.

Image Added

Campos a serem sensibilizados na Vtex

Image Added


Categoria Global Vtex

1 -Para configurar a Categoria Global Vtex é necessário realizar a parametrização conforme a planilha de categorias (Clique Aqui)

2- No campo H1 selecionar o campo para informar o código da categoria.

Image Added

3- No Idioma ES clicar no botão ''Alterar''

Image Added

4- Será habilitado um campo para a digitação do código da categoria (esse código deve ser informado conforme a planilha no link acima), após a parametrização  Clicar no botão ''Aceitar''.

Image Added

5- Essa informação será enviada ao campo Categoria Global VTEX no canal de vendas.

Image Added

Formato: Número

Tradução: ES

Parâmetro da PropertiesDescriçãoFormato do Parâmetro, Exemplo e Observaçõesvtex.appkey.<idSiteCanal>.<nomeSellerVTEX>Id Externo da loja do Omni correspondente ao seller do VTEX.Exemplo: vtex.appkey.728.vtextotvsloja1=1vtex.warehouse.<idSiteCanal>.<idExternoLojaOmni>Exemplo: vtex.warehouse.728.1=1_1vtex.accountname.<idSiteCanal>.<idExternoLojaOmni>Nome do Seller correspondente à loja cadastrada no Omni.Exemplo: vtex.accountname.728.1=vtextotvsloja1vtex.appkey.<idSiteCanal>.<idExternoLojaOmni>Access key gerada na administração do seller no VTEX.Exemplo: vtex.appkey.728.1=vtexappkey-vtextotvsloja1-ABCDEvtex.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!

...