Histórico da Página

...

Nome do Parâmetro

Descrição

Formato do Parâmetro e Exemplo

totvsmoda.authn.endpoint

URL do serviço de autenticação do TOTVS Moda.

Campo obrigatório.

Formato: URL

Exemplo: https://treino.bhan.com.br:9443/api/totvsmoda/authorization/v2/token

totvsmoda.authn.clientid

Client ID criado no TOTVS Moda para acesso do TOTVS Omni para consultar produto e informações de preço e estoque.

Campo obrigatório.

Formato: Texto

totvsmoda.authn.clientsecret

Client Secret criado no TOTVS Moda para acesso do TOTVS Omni para consultar produto e informações de preço e estoque.

Campo obrigatório.

Formato: Texto

totvsmoda.authn.username

Usuário criado no TOTVS Moda para acesso do TOTVS Omni para consultar produto e informações de preço e estoque.

Criar este usuário através do componente ADMFM026 do Moda (usuário com o tipo de privilégio “Padrão” e liberar as empresas as quais ele poderá ter acesso.)

Campo obrigatório.

Formato: Texto

totvsmoda.authn.password

Senha do usuário criado no TOTVS Moda para acesso do TOTVS Omni para consultar produto e informações de preço e estoque.

Campo obrigatório

Formato: Texto

totvsmoda.authn.granttype

Tipo de autenticação utilizado pelo serviço de autenticação do TOTVS Moda.

Campo não obrigatório.

Formato: Texto

Caso não seja especificado o valor padrão é password

totvsomni.ftp.base.folder

Diretório base do FTP onde serão armazenados os arquivos de produto, preço e estoque que serão processados pela integração.

Este diretório é a base dos sub diretórios onde serão gerados os arquivos vindos do Moda e convertidos pelo Omni.

Campo não obrigatório.totvsmoda.pedidos.dados.por.channelID

Formato: Texto

Caso não seja especificado o valor padrão é /

totvsomni.ftp.host

Host do servidor de FTP utilizado para armazenar os arquivos de produto, preço e estoque que serão processados pela integração.

Formato: Texto

totvsomni.ftp.user

Usuário do servidor de FTP.

Campo obrigatório.

Formato: Texto

totvsomni.ftp.pass

Senha do usuário do servidor de FTP.

Campo obrigatório.

Formato: Texto

totvsmoda.produtos.endpoint

URL do serviço de consulta de produtos do TOTVS Moda.

Campo obrigatório.

Formato: URL

Exemplo: https://treino.bhan.com.br:9443/api/totvsmoda/product/v2/references/search

totvsmoda.produtos.body.message.json

JSON de consulta de produtos no TOTVS Moda que será utilizado como body message da requisição à API do Moda.

Este JSON deve ser confeccionado conforme a documentação da API do TOTVS Moda.

Veja https://www30.bhan.com.br:9443/api/totvsmoda/product/v2/swagger/index.html
Endpoing /api/totvsmoda/product/v2/references/search

Campo obrigatório.

Formato: Objeto JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

{
	"filter": {
		"classifications": [
			{
				"type": 523,
				"codelist": [
					"001"
				]
			}
		],
		"change": {
			"startDate": "2021-01-01T00:00:01.831Z",
			"endDate": "2021-03-20T00:00:01.831Z",
			"inProduct": true
		}
	},
	"option": {
		"branchinfocode": 20,
		"BranchCodeList": [
			20
		],
		"pricecode": 1
	},
	"expand": "details,classifications,composition,additionalFields",
	"pagesize": 500,
	"page": 1
}

totvsmoda.campos.pmm.categoria.omni

Nome das classificações do TOTVS Moda que serão compostas (concatenadas) para compor um novo atributos, chamado categoriaOmni, nos arquivos JSON de produtos que serão convertidos pelo conector.

Cada nome de classificação deve ser separado pelo valor definido pelo parâmetro totvsmoda.separador.pmm.categoria.omni.

Campo obrigatório.

Formato: Texto

Exemplo: FAMILIA-GENERO-FASE-GRUPO

No exemplo acima os valores das classificações FAMILIA, GENERO, FASE e GRUPO serão concatenados, utilizando o separador -

totvsmoda.separador.pmm.categoria.omni

Separador dos campos de categorias definido no parâmetro totvsmoda.campos.pmm.categoria.omni

Campo não obrigatório.

Formato: Texto

Exemplo: -

No exemplo acima o caractere - (menos) será utilizado para identificar as classificações e concatenar os valores das classificações no atributo categoriaOmni.

Caso não seja especificado o valor padrão é -

totvsmoda.produtos.filtro.startdate.voltar.dias

Quantidade de dias que será diminuído da data atual para realizar a consulta de produtos.

Este parâmetro somente é utilizado caso a query (definida no parâmetro totvsmoda.produtos.body.message.json) contenha filtro de data:
"startDate": "2021-01-01T00:00:01.831Z",
"endDate": "2021-03-20T00:00:01.831Z",

A data a ser utilizada para o endDate será sempre a data da execução da integração acrescida de 1 dia, a fim de evitar diferença de fuso horário entre o TOTVS Moda e o Omni).

A data a ser utilizada para o startDate obedece à seguinte regra:

Caso o parâmetro esteja com valor maior que 0 (zero), o startDate será a data atual diminuída da quantidade de dias definida no parâmetro.
Caso esteja igual a 0 (zero) ou não configurado o startDate será a data de alteração do ultimo registro do produto. Ao executar a integração de produto o sistema grava a maior data de alteração do produto obtida no resultado da requisição com o moda.

Campo não obrigatório.

Formato: Número

Exemplo: 3

Caso não seja especificado o valor padrão é 0

totvsmoda.estoque.endpoint

URL do serviço de consulta de estoque do TOTVS Moda.

Campo obrigatório.

Formato: URL

Exemplo: https://treino.bhan.com.br:9443/api/totvsmoda/product/v2/balances/search

totvsmoda.estoque.body.message.json

JSON de consulta de estoque no TOTVS Moda que será utilizado como body message da requisição à API do Moda.

Este JSON deve ser confeccionado conforme a documentação da API do TOTVS Moda.

Veja https://www30.bhan.com.br:9443/api/totvsmoda/product/v2/swagger/index.html
Endpoint /api/totvsmoda/product/v2/balances/search

Campo obrigatório.

É possível dentro da estrutura de balances passar valores simplificados de forma a diminiuir o tamanho total do JSON (em números de caracteres), conforme a seguinte regra:

BC = BranchCode
sCL = stockCodeList
iT = isTransaction

Exemplo:
... "balances": [
            {
                "BC": 20,
                "sCL": [
                    1
                ],
                "iT": true
            }
        ], ...

Formato: Objeto JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

{
	"filter": {
		"classifications": [
			{
				"type": 523,
				"codelist": [
					"001"
				]
			}
		],
		"change": {
			"startDate": "2021-01-12T08:13:11.211Z",
			"endDate": "2021-01-13T08:13:11.211Z",
			"inStock": true,
			"inProduct": true,
			"branchStockCodeList": [				
				20
			],
			"stockCodeList": [
				1
			]
		}
	},
	"option": {
		"balances": [
			{
				"BranchCode": 20,
				"stockCodeList": [
					1
				],
				"isTransaction": true
			}
		]
	},
	"pagesize": 500,
	"page": 1
}

totvsmoda.produtos.remove.estoque.zero

Indica para o conector de estoque para incluir (valor FALSE) ou não incluir (valor TRUE) produtos com estoque zero no JSON que será convertido e lido pela integração.

Campo não obrigatório.

Formato: Texto, informar TRUE ou FALSE

Exemplo: TRUE

Caso não seja especificado o valor padrão é FALSE

totvsmoda.estoque.campo.desconto.estoque

Nome do campo da API de estoque do TOTVS Moda usado para descontar a quantidade de estoque.

O campo precisa vir com valor inteiro, não nulo, para poder ser usado no desconto.

É possível passar mais de um campo, separados por vírgula.

Formato: Texto

Caso não seja especificado o valor padrão é outputTransaction

totvsmoda.estoque.filtro.startdate.voltar.dias

Quantidade de dias que será diminuído da data atual para realizar a consulta de estoque.

Este parâmetro somente é utilizado caso a query (definida no parâmetro totvsmoda.estoque.body.message.json) contenha filtro de data:
"startDate": "2021-01-01T00:00:01.831Z",
"endDate": "2021-03-20T00:00:01.831Z",

A data a ser utilizada para o endDate será sempre a data da execução da integração acrescida de 1 dia, a fim de evitar diferença de fuso horário entre o TOTVS Moda e o Omni).

A data a ser utilizada para o startDate obedece à seguinte regra:

Caso o parâmetro esteja com valor maior que 0 (zero), o startDate será a data atual diminuída da quantidade de dias definido no parâmetro.
Caso esteja igual a 0 (zero) ou não configurado o startDate será a data de alteração do ultimo registro do estoque. Ao executar a integração de estoque o sistema grava a maior data de alteração do estoque obtida no resultado da requisição com o moda.

Campo não obrigatório.

Formato: Número

Exemplo: 3

Caso não seja especificado o valor padrão é 0

totvsmoda.precos.endpoint

URL do serviço de consulta de preço do TOTVS Moda.

Campo obrigatório.

Formato: URL

Exemplo: https://www30.bhan.com.br:9443/api/totvsmoda/product/v2/prices/search

totvsmoda.precos.body.message.json

JSON de consulta de preço no TOTVS Moda que será utilizado como body message da requisição à API do Moda.

Este JSON deve ser confeccionado conforme a documentação da API do TOTVS Moda.

Veja https://www30.bhan.com.br:9443/api/totvsmoda/product/v2/swagger/index.html
Endpoint /api/totvsmoda/product/v2/prices/search

Campo obrigatório.

Formato: Objeto JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

{
	"filter": {
		"classifications": [
			{
				"type": 5223,
				"codelist": [
					"001"
				]
			}
		],
		"change": {
			"startDate": "2020-03-19T00:00:01.831Z",
			"endDate": "2021-03-20T00:00:01.831Z",
			"inPrice": true,
			"inPromotionalPrice": true,
			"branchPriceCodeList": [20],
			"priceCodeList": [1,3]
		}
	},
	"option": {
		"prices": [
			{
				"branchCode": 20,
				"priceCodeList": [
					1
				],
				"isPromotionalPrice": true
			},
			{
				"branchCode": 20,
				"priceCodeList": [
					3
				],
				"isPromotionalPrice": true
			}
		]
	},
	"pagesize": 500,
	"page": 1
}

totvsmoda.precos.modelo.dados

Indica com o conector irá trabalhar para identificar os preços dentro do JSON de resposta do serviço de consulta de preço.

No modelo PRECOLOJA utilizará os códigos de preço (priceCodes) identificados pelos parâmetros totvsmoda.precos.pricecode.preco.original e totvsmoda.precos.pricecode.preco.promocional para identificar o código do preço Original e descontado dentro do JSON de retorno do serviço de consulta de preço do TOTVS Moda.

No modelo TABELAPRECO utiliza os campos originalprice e price para associar o preço Original e descontado no TOTVS Omni.

Campo não obrigatório.

Formato: Texto, informar TABELAPRECO ou PRECOLOJA

Exemplo: PRECOLOJA

Caso não seja especificado o valor padrão é PRECOLOJA

totvsmoda.precos.pricecode.preco.original

Indica qual é o código do preço (priceCode) do TOTVS Moda a ser utilizado como o preço original (ou preço cheio) do produto no Omni.

Campo obrigatório.

Formato: Número

Exemplo: 1

totvsmoda.precos.pricecode.preco.promocional

Indica qual é o código do preço (priceCode) do TOTVS Moda a ser utilizado como o preço promocional (ou preço descontado) do produto no Omni.

Campo obrigatório.

Formato: Número

Exemplo: 3

totvsmoda.precos.campo.preco.original

Identifica qual é o campo do objeto de preços no JSON de resposta da consulta que tem o valor do preço original (preço cheio ou full price) do produto.

O valor retornado para este campo no JSON será cadastrado no preço original dentro do Omni.

Campo não obrigatório.

Formato: Texto

Exemplo: price

Exemplo do retorno da consulta de preço:
"prices": [
                {
                    "branchCode": 1,
                    "priceCode": 1,
                    "price": 89.99,
                    "promotionalPrice": 49.99
                }
...

Com o exemplo acima, indica que o valor 89.99 será designado como o preço original do produto.

Caso não seja especificado o valor padrão é price

totvsmoda.precos.campo.preco.promocional

Identifica qual é o campo do objeto de preços no JSON de resposta da consulta que tem o valor do preço com desconto do produto.

O valor retornado para este campo no JSON será cadastrado no preço rebaixado (com desconto) dentro do Omni.

OBSOBS1: Caso o valor do campo relativo ao preço promocional não estiver preenchido ou estiver preenchido com valor zero, então é utilizado o valor do campo preço original.
Isto é devido ao fato do TOTVS Omni somente considerar para fins de publicação produtos com preço diferente de zero.

Campo não obrigatório.

OBS2: As promoções por SKU criadas no TOTVS Moda obedecem às seguintes regras:

1) O SKU associado à promoção aparecerá na consulta de preço no dia de início da promoção. O valor da promoção aparecerá no campo "promotionalPrice".

2) O SKU associado à promoção não aparecerá na consulta de preço durante a vigência, portanto não alterando seu preço.

3) O SKU associado à promoção aparecerá na consulta de preço no dia posterior ao fim da promoção. O valor do campo "promotionalPrice" aparecerá como 0 (zero), indicando ao conector para obedecer ao comportamento da observação 1.

4) Embora configurado no TOTVS Moda a nível de SKU, a promoção no TOTVS Omni é associado ao produto, isto é, Código de Referencia + cor.

5) Se dois SKUs de um mesmo Código de Referencia + cor forem colocados em promoções distintas, não há como garantir qual será o preço da promoção para o produto no TOTVS Omni.

Formato: Texto

Exemplo: promotionalPrice

Exemplo do retorno da consulta de preço:
"prices": [
                {
                    "branchCode": 1,
                    "priceCode": 1,
                    "price": 89.99,
                    "promotionalPrice": 49.99
                }
...

Com o exemplo acima, indica que o valor 49.99 será designado como o preço promocional do produto, caso o valor promotionalPrice seja configurado.

Caso não seja especificado o valor padrão é price

totvsmoda.precos.filtro.startdate.voltar.dias

Quantidade de dias que será diminuído da data atual para realizar a consulta de preços.

Este parâmetro somente é utilizado caso a query (definida no parâmetro totvsmoda.precos.body.message.json) contenha filtro de data:
"startDate": "2021-01-01T00:00:01.831Z",
"endDate": "2021-03-20T00:00:01.831Z",

A data a ser utilizada para o endDate será sempre a data da execução da integração acrescida de 1 dia, a fim de evitar diferença de fuso horário entre o TOTVS Moda e o Omni).

A data a ser utilizada para o startDate obedece à seguinte regra:

Caso o parâmetro esteja com valor maior que 0 (zero), o startDate será a data atual diminuída da quantidade de dias definido no parâmetro.
Caso esteja igual a 0 (zero) ou não configurado o startDate será a data de alteração do ultimo registro do preço. Ao executar a integração de preço o sistema grava a maior data de alteração do preço obtida no resultado da requisição com o moda.

Campo não obrigatório.

Formato: Número

Exemplo: 3

Caso não seja especificado o valor padrão é 0

totvsmoda.ftp.produtos.convertedjson.fileprefix

Prefixo a ser utilizado nos arquivos de produto convertidos pelo conector e gravados no FTP.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRODUTOS_OMNI_

totvsmoda.ftp.produtos.convertedjson.subfolder

Sub diretório do diretório raiz definido no parâmetro totvsomni.ftp.base.folder que será utilizado para armazenar arquivos convertidos de produto.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRODUTO

totvsmoda.ftp.produtos.originaljson.fileprefix

Prefixo a ser utilizado nos arquivos de produto originais do TOTVS Moda e gravados no FTP.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRODUTOS_MODA_

totvsmoda.ftp.produtos.originaljson.subfolder

Sub diretório do diretório raiz definido no parâmetro totvsomni.ftp.base.folder que será utilizado para armazenar arquivos originais de produtos do TOTVS Moda.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRODUTO/original_json

totvsmoda.ftp.estoque.convertedjson.fileprefix

Prefixo a ser utilizado nos arquivos de estoque convertidos pelo conector e gravados no FTP.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é ESTOQUE_OMNI_

totvsmoda.ftp.estoque.convertedjson.subfolder

Sub diretório do diretório raiz definido no parâmetro totvsomni.ftp.base.folder que será utilizado para armazenar arquivos convertidos de estoque.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é ESTOQUE

totvsmoda.ftp.estoque.originaljson.fileprefix

Prefixo a ser utilizado nos arquivos de estoque originais do TOTVS Moda e gravados no FTP.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é ESTOQUE_MODA_

totvsmoda.ftp.estoque.originaljson.subfolder

Sub diretório do diretório raiz definido no parâmetro totvsomni.ftp.base.folder que será utilizado para armazenar arquivos originais de estoque do TOTVS Moda.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é ESTOQUE/original_json

totvsmoda.ftp.precos.convertedjson.fileprefix

Prefixo a ser utilizado nos arquivos de preçoconvertidos pelo conector e gravados no FTP.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRECO_OMNI_

totvsmoda.ftp.precos.convertedjson.subfolder

Sub diretório do diretório raiz definido no parâmetro totvsomni.ftp.base.folder que será utilizado para armazenar arquivos convertidos de preço.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRECO

totvsmoda.ftp.precos.originaljson.fileprefix

Prefixo a ser utilizado nos arquivos de preço originais do TOTVS Moda e gravados no FTP.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRECO_MODA_

totvsmoda.ftp.precos.originaljson.subfolder

Sub diretório do diretório raiz definido no parâmetro totvsomni.ftp.base.folder que será utilizado para armazenar arquivos originais de preço do TOTVS Moda.

Campo não obrigatório

Formato: Texto

Caso não seja especificado o valor padrão é PRECO/original_json

totvsmoda.estoque.endpoint.version

Caso esteja preenchido com qualquer valor diferente de 1 utiliza os novos endpoints de estoque do TOTVS Moda.
Caso não tenha valor, usa o endpoint antigo do Moda.

Formato: Número

Exemplo: 2

Caso não seja especificado o valor padrão é 1

...

Árvore de páginas

Versões comparadas

Versão antiga 49

Nova versão 50

Chave