Histórico da Página

...

Parâmetro da Credencial

Descrição

Formato 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

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

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

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 LABEL

Campo 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 FORMATION

Formato: Texto

NOMBRE_SEO

Formato: Texto

VTEX COLOR LABEL

Formato: Texto

VTEX SIZE LABEL

Formato: Texto

VTEX_ATTRIBUTE_IN_REF_ID

Formato: Texto

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

Formato: Número

VTEX_EXTERNAL_SKU_ID

Formato: Texto

Valores possíveis: yes ou no

VTEX_EXTERNAL_SUBPRODUCTO_ID

Formato: Número

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

{
	"E-Rede V2Meu Gateway V1": "REDEGTWYOMNI"
}

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.

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

Formato: Array JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

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

VTEX_STORE

Formato: Array JSON

Exemplo:

vTex_tradePolicyId

Formato: Number

vtex.atributos.precargados

...

Árvore de páginas

Versões comparadas

Versão antiga 12

Nova versão 13

Chave