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. | 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. | ||||||||||
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 Campo obrigatório. | Formato: Objeto JSON Exemplo:
| |||||||||
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: 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:
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. | ||||||||||
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 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:
Exemplo: | Formato: Objeto JSON Exemplo:
| |||||||||
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.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: 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:
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. | ||||||||||
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 Campo obrigatório. | Formato: Objeto JSON Exemplo:
| |||||||||
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 Neste exemplo o retorno da consulta de preço: ... 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. Campo não obrigatório. | Formato: Texto Exemplo: promotionalPrice Neste exemplo o retorno da consulta de preço: ... Com o exemplo acima, indica que o valor 49.99 será designado como o preço original do produto. 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: 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:
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 |
...
Nome do Parâmetro | Descrição | Formato do Parâmetro, Exemplo e Observações | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totvsmoda.base.url | Base da URL de acesso ao TOTVS Moda do cliente (de acordo com o site principal - Teste ou Produção). | Formato: https:// <HOST> : <PORTA> Exemplo: https://treino.bhan.com.br:9443 | ||||||||||||||||||
totvsmoda.authn.clientid | Client ID que deve ser criado no TOTVS Moda para acesso de criação de pedidos nas branchs do cliente. | Formato: Texto | ||||||||||||||||||
totvsmoda.authn.clientsecret | Cliente Secret que deve ser criado no TOTVS Moda para acesso de criação de pedidos nas branchs do cliente. | Formato: Texto | ||||||||||||||||||
totvsmoda.authn.granttype | Tipo de Grant utilizado para o Cliente ID e Cliente Secret configurado. Campo não obrigatório. | Formato: Texto Caso não seja especificado o valor padrão é password | ||||||||||||||||||
totvsmoda.authn.username | Usuário criado no TOTVS Moda para acesso à pedidos. | Formato: Texto | ||||||||||||||||||
totvsmoda.authn.password | Senha do usuário criado no TOTVS Moda para acesso à pedidos. | Formato: Texto | ||||||||||||||||||
totvsmoda.clientes.config | Indica se o cliente que realizou a compra será criado no TOTVS Moda Ativo ou Inativo e bloqueado ou não. O valor para este parâmetro deve ser analisado juntamente com a equipe TOTVS Moda do projeto. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.clientes.addressTypeCode | Indica qual é o código do tipo de endereço que será passado na criação do cliente que realizou a compra no TOTVS Moda. Há 2 códigos que precisam ser analisado juntamente com a equipe TOTVS Moda do projeto:
Se um dos códigos não for passado (ex: {"billing": "", "shipping": "5"} ) o cliente será criado sem tipo de endereço correspondente. No exemplo entre parênteses, o endereço de billing não será enviado ao TOTVS Moda durante a criação do cliente. Somente será enviado o endereço de shipping com o código 5. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.clientes.phoneConfig | Indica se deverá criar o cliente no TOTVS Moda com dados de telefone (parâmetro "createWith"="true") e caso seja qual é o código do tipo de telefone e se o telefone será criado como padrão para o cliente. Os valores para este parâmetro devem ser analisados juntamente com a equipe TOTVS Moda do projeto. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.clientes.emailConfig | Indica se deverá criar o cliente no TOTVS Moda com dados de email (parâmetro "createWith"="true") e caso seja qual é o código do tipo de email e se o email será criado como padrão para o cliente. Os valores para este parâmetro devem ser analisados juntamente com a equipe TOTVS Moda do projeto. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.id.canais.proprios | Lista de código de canal que são próprios do cliente (geralmente os canais e-commerce). Vide TOTVS Omni - Lista de IDs do Omni#ListadeIDsdoOmni-ListadeIDsdeCanaisdeVenda Todos os demais canais não presentes nesta lista são considerados pelo conector como canais não próprios (marketplaces ou demais canais). | Formato: Array JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.freightType | Código do tipo de frete a ser usado na criação do pedido. Há 2 códigos que precisam ser analisado juntamente com a equipe TOTVS Moda do projeto:
Ambos códigos são obrigatórios. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.dados.por.channelID | Lista de informações por código de canal próprio ou não próprio, que são necessárias para a criação de pedido. Para cada código de canal é necessário passar:
Para cada canal próprio e não próprio deve ser fornecidas estas informações. | Formato: Array JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.dados.por.logisticID | Lista de informações por operador logístico que são necessárias para a criação de pedido. Quando um pedido Omni envolve entrega, o pedido a ser criado no TOTVS Moda será criado com a informação do CNPJ do operador logístico no campo shippingCompanyCpfCnpj do pedido. Os CNPJs aqui presentes devem constar no TOTVS Moda, caso contrário o TOTVS Moda retornará erro de criação do pedido. Os valores para este parâmetro devem ser analisados juntamente com a equipe TOTVS Moda do projeto. | Formato: Array JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.dados.por.lojaID | Lista de informações por código de loja (campo Identificador externo do registro da loja no Omni), que são necessárias para a criação de pedido. Para cada código de loja é necessário passar:
Para cada código de loja devem ser fornecidas estas informações. Caso a loja não esteja cadastrada nesta lista e o pedido seja designada para ela, a criação do pedido no Moda irá falhar indicando a falta de parametrização. | Formato: Array JSON Exemplo:
ou de forma comprimida para reduzir o tamanho do JSON (em números de caracteres).
| ||||||||||||||||||
totvsmoda.pedidos.productCode.method | Parâmetro utilizado para customizar o valor do productCode do item do pedido na criação do pedido no Moda. De forma geral o campo productCode do Moda corresponde ao SKU do item no Omni, por este motivo utiliza-se o valor getSku. Outros valores possíveis: getEan, getAlphaCode ou getIdProduct. | Formato: Texto Normalmente o valor padrão é getSku. | ||||||||||||||||||
totvsmoda.pedidos.BillingForecastDate.somar.dias | Quantidade de dias a ser somada na data do pedido para cadastro do campo BillingForecastDate na lista de itens do pedido a ser criado no TOTVS Moda. | Formato: Número | ||||||||||||||||||
totvsmoda.pedidos.classification.canais.proprios | Lista de classificações que serão usadas na criação do pedido de canal de venda próprio (presente na lista totvsmoda.pedidos.id.canais.proprios) no Moda Os valores para este parâmetro devem ser analisados juntamente com a equipe TOTVS Moda do projeto. | Formato: Array JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.classification.demais.canais | Lista de classificações que serão usadas na criação do pedido de canal de venda marketplace (não presente na lista totvsmoda.pedidos.id.canais.proprios) no Moda. Os valores para este parâmetro devem ser analisados juntamente com a equipe TOTVS Moda do projeto. | Formato: Array JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.depara.creditCardBrand | Mapeamento entre valores de marca de cartão de crédito que estejam presentes no campo marca de cartão de crédito no pedido no Omni, e a marca de cartão de crédito correspondente registrada no TOTVS Moda. O campo default indica o valor que será utilizado no pedido a ser criado no TOTVS Moda no caso da marca de cartão de crédito não estar inclusa nesta lista. Obrigatório a presença da entrada default no JSON. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.depara.creditCardOperator | Mapeamento entre valores de operador de cartão de crédito que estejam presentes no campo marca de cartão de crédito no pedido no Omni, e o operador de cartão de crédito correspondente registrado no TOTVS Moda. O campo default indica o valor que será utilizado no pedido a ser criado no TOTVS Moda no caso do operador de cartão de crédito não estar inclusa nesta lista. Obrigatório a presença da entrada default no JSON. | Formato: Objeto JSON Exemplo:
| ||||||||||||||||||
totvsmoda.pedidos.discount.code | Código do desconto existente no TOTVS Moda que será aplicado no caso de um pedido com desconto. Importante que este código de desconto no TOTVS Moda não esteja atrelado nem a valor nem a porcentagem. Caso contrário o TOTVS Moda pode lançar um erro quando o conector tentar criar o pedido. | Formato: Número | ||||||||||||||||||
totvsmoda.pedidos.cancel.reason.code | Código da razão para cancelamento do pedido registrado no Moda e que será utilizado pelo Omni quando o pedido tiver que ser cancelado. | Formato: Número | ||||||||||||||||||
totvsmoda.pedidos.default.installment | Valor padrão para número de parcelas para caso de pedido que não seja por cartão de crédito. | Formato: Número | ||||||||||||||||||
totvsmoda.pedidos.default.paymentBranch | Valor a ser utilizado na criação de pedidos para identificar a empresa no TOTVS Moda responsável pelo pagamento (paymentBranch). O conector do Moda tenta recuperar o atributo de pedido tiendaSuministradora (Caso em que o canal de venda decide a loja que vai ser designada para o pedido). Caso o valor não tenha sido passado pelo conector do canal de venda, então o Omni usa o valor configurado neste propriedade para o paymentBranch. Caso também não tenha sido preenchido este valor na propriedade então por fim o Omni usa o Id da loja que o pedido foi designado. | Formato: Número Exemplo: 1 | ||||||||||||||||||
totvsmoda.pedidos.order.number | Será utilizado para fazer transformações no campo customerOrderCode, a fim de evitar estouro de limite de caracteres (Criado para pedidos importados pelo conector Skyhub/B2W) Valores descritos no "from" devem ser identicos ao que for descer do canal. | Formato: json Exemplo:
|
...