Histórico da Página

...

Parâmetro da Credencial

Descrição

Formato 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_TOKEN

Token da access key gerada.

Formato: Texto

ENVIROMENT

Sufixo 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

mail.to

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_TITLE

Lista 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_NAME

Atributos 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_CONDITION

Na 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_ID

Indica 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 JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

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

language	js
title	JSON
collapse	true

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

language	js
title	JSON
collapse	true

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

language	js
title	JSON
collapse	true

{
	"Meu Gateway V1": "GTWYOMNI"
}

VTEX_MULTIPLE_FRANCHISES

Lista 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

language	js
title	JSON
collapse	true

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

Identifica 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

language	js
title	JSON
collapse	true

[
	{
		"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

language	js
title	JSON
collapse	true

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

vTex_tradePolicyId

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

language	js
title	JSON
collapse	true

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

VTEX_CATEGORY_ACTIVE_STORE_FRONT_LINK (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:

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:

Formato: Texto

Valores possíveis: True ou False

VTEX_CATEGORY_SHOW_IN_STORE_FRONT (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

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_DIAS

No 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_MARKETPLACE

Indica 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

...

Árvore de páginas

Versões comparadas

Versão antiga 75

Nova versão 76

Chave

05. PARAMETROS DE PROPRIEDADES