Histórico da Página

...

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:

Bloco de código

language	js
title	JSON
collapse	true

{
	"isInactive": "false",
	"isBloqued": "false"
}

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:

billing: Código para Endereço de Faturamento
shipping: Código para Endereço de Entrega.

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:

Bloco de código

language	js
title	JSON
collapse	true

{
	"billing": "1",
	"shipping": "5"
}

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:

Bloco de código

language	js
title	JSON
collapse	true

{
	"typeCode": "1",
	"isDefault": "true",
	"createWith": "true"
}

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:

Bloco de código

language	js
title	JSON
collapse	true

{
	"typeCode": "2",
	"isDefault": "true",
	"createWith": "true"
}

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:

Bloco de código

language	js
title	JSON
collapse	true

["23","7"]

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:

shipping: Código para Pedido Entrega
pickup: Código para Pedido de Pickup

Ambos códigos são obrigatórios.

Formato: Objeto JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

{
	"shipping": "1",
	"pickup": "4"
}

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:

cnpj: CNPJ cadastrado para o canal no Moda, para ser utilizado no campo representativeCpfCnpj do pedido a ser criado no Moda.
paymentConditionCode: Valor para o campo paymentConditionCode (Condição de Pagamento) do pedido a ser criado no Moda.
priorityCode: Valor para o campo priorityCode (código de Prioridade) do pedido a ser criado no Moda.
Valores para o campo assignorCode (Código do Portador) do pedido a ser criado no Moda:
- assignorCodeC: corresponde ao código do portador padrão para pedidos de cartão.
- assignorCodeB: corresponde ao código do portador padrão para pedidos de boleto.
- assignorCodeP: orresponde ao código do portador padrão para pedidos de Pix.
cnpjMarketPlaces: Uso exclusivo para pedidos Marketplace VTEX (configurado como canal próprio).
Quando um pedido foi feito no marketplace baixado pelo VTEX, vem identificado o AffilateId no JSON do pedido do VTEX. Este código será gravado no pedido e deve ser configurado nesta lista o de-para entre o código e o valor do CNPJ do intermediário a ser enviado para o Moda.

Para cada canal próprio e não próprio deve ser fornecidas estas informações.

Obs: Embora aqui configurado, o código portador (assignorCode) de cartão de crédito somente é enviado caso o trio creditCardBrand, creditCardOperator e installment do pagamento não for identificado pelo Omni.
O assignorCode de cartão de crédito para o Moda é identificado por este trio.

Formato: Array JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

[
	{
		"23": {
			"cnpj": "05314972000174",
			"paymentConditionCode": "001",
			"priorityCode": "99",
			"assignorCodeC": "0",
			"assignorCodeB": "0",
			"assignorCodeP": "0",
			"cnpjMarketPlaces":[
				{"MLB":"<cnpjMLB>"},{"MGL":"cnpjMGL"} 
			]
		}
	},
	{
		"7": {
			"cnpj": "05314972000174",
			"paymentConditionCode": "001",
			"priorityCode": "99",
			"assignorCodeC": "0",
			"assignorCodeB": "0"
			"assignorCodeP": "0"
		}
	}
]

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.

OBS: mesmo que não use a integração com a frete rápido deverá ser informado o campo nomeFreteRapido com o valor "" (vazio).
Caso uma transportadora tenha CNPJs diferentes quando a integração for via frete rápido ou diretamente com a transportadora, deverá ser informado 2 vezes, uma sem o nomeFreteRapido, outra sem o idOmni, conforme exemplo, os primeiros blocos ambos referenciam os CORREIOS (61)

Formato: Array JSON

Exemplo:

Bloco de código

language	js
title	JSON
collapse	true

[
	{
		"idOmni": "61",
		"nomeFreteRapido": "",
		"cnpj": "34028316001266"
	},
	{
		"idOmni": "",
		"nomeFreteRapido": "CORREIOS",
		"cnpj": "72963707000104"
	},
	{
		"idOmni": "63",
		"nomeFreteRapido": "",
		"cnpj": "90523681000165"
	},
	{
		"idOmni": "64",
		"nomeFreteRapido": "",
		"cnpj": "73939449002137"
	},
	{
		"idOmni": "81",
		"nomeFreteRapido": "",
		"cnpj": "73386353000145"
	},
	{
		"idOmni": "",
		"nomeFreteRapido": "JADLOG",
		"cnpj": "90523681000165"
	},
	{
		"idOmni": "",
		"nomeFreteRapido": "LALAMOVE",
		"cnpj": "20537865000107"
	},
	{
		"idOmni": "",
		"nomeFreteRapido": "TOTAL EXPRESS",
		"cnpj": "47112842000107"
	},
	{
		"idOmni": "",
		"nomeFreteRapido": "EXPRESSO FR (TESTE)",
		"cnpj": "69436534000161"
	}
]

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:

b ou branch: Código da empresa do Moda que corresponde ao código de loja cadastrado no Omni. Este parâmetro permite que, por exemplo, para um pedido que o Omni designou para a loja 1, o conector crie este pedido na empresa 99 no Moda (primeira entrada no exemplo de JSON).
c ou cnpj: CNPJ da empresa do Moda, que será utilizado no campo representativeCpfCnpj do pedido nos casos que o pedido é proveniente de canal próprio.
Código do operador que será utilizado na criação do pedido no Moda (campo operationCode):
- oC ou opCodeC: corresponde ao código da operação para pedidos de entrega (shipping) pagos no canal de venda.
- oP ou opCodeP: corresponde ao código da operação para pedidos de retirada (pickup) pagos no canal de venda.
- oPC ou opCodePgPdvC: corresponde ao código da operação para pedidos de entrega (shipping) pagos no PDV (utilizado somente em caso de pedido de Prateleira Infinita).
- oPP ou opCodePgPdvP: corresponde ao código da operação para pedidos de retirada (pickup) pagos no PDV (utilizado somente em caso de pedido de Prateleira Infinita).
iC ou intCnpj: CNPJ do intermediário da compra. Usado na criação do pedido no Moda (campo intermediaryCnpj) para pedidos provenientes de canal próprio. Se o parâmetro não for informado, for informado com valor nulo ou vazio ("") o parâmetro intermediaryCnpj não é enviado para o TOTVS Moda na criação do pedido.

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:

Bloco de código

language	js
title	JSON
collapse	true

[
	{
		"1": {
			"branch": "99",
			"cnpj": "14078646000311",
			"opCodeC": "800",
			"opCodeP": "800",
			"opCodePgPdvC": "5104",
			"opCodePgPdvP": "5199",
			"intCnpj": "14078646000311"
		}
	},
	{
		"3": {
			"branch": "3",
			"cnpj": "14078646000368",
			"opCodeC": "800",
			"opCodeP": "800",
			"opCodePgPdvC": "5104",
			"opCodePgPdvP": "5199",
			"intCnpj": "14078646000368"
		}
	},
	{
		"4": {
			"branch": "4",
			"cnpj": "14078646000449",
			"opCodeC": "800",
			"opCodeP": "800",
			"intCnpj": "14078646000449"
		}
	}
]

ou de forma comprimida para reduzir o tamanho do JSON (em números de caracteres).

Bloco de código

language	js
title	JSON Compactado
collapse	true

[
	{
		"1": {
			"b": "99",
			"c": "14078646000311",
			"oC": "800",
			"oP": "800",
			"oPC": "5104",
			"oPP": "5104",
			"iC": "14078646000311"
		}
	},
	{
		"3": {
			"b": "3",
			"c": "14078646000368",
			"oC": "800",
			"oP": "800",
			"oPC": "5104",
			"oPP": "5104",
			"iC": "14078646000368"
		}
	},
	{
		"4": {
			"b": "4",
			"c": "14078646000449",
			"oC": "800",
			"oP": "800",
			"oPC": "5104",
			"oPP": "5104",
			"iC": "14078646000449"
		}
	}
]

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:

Bloco de código

language	js
title	JSON
collapse	true

[
	{
		"classificationTypeCode": 1,
		"classificationCode": "1"
	},
	{
		"classificationTypeCode": 100,
		"classificationCode": "2"
	}
]

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:

Bloco de código

language	js
title	JSON
collapse	true

[
	{
		"classificationTypeCode": 1,
		"classificationCode": "1"
	},
	{
		"classificationTypeCode": 100,
		"classificationCode": "2"
	}
]

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:

Bloco de código

language	js
title	JSON
collapse	true

{
	"VISA": "VISA",
	"MASTERCARD": "MASTERCARD",
	"ELO": "ELO",
	"AMEX": "AMEX",
	"DINERS": "DINERS",
	"default": "MASTERCARD"
}

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:

Bloco de código

language	js
title	JSON
collapse	true

{
	"CIELO": "CIELO",
	"REDE": "REDE",
	"default": "REDE"
}

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.
com isso um pedido Lojas Americanas-1635967057347 será transformado para AME-1635967057347

Formato: json

Exemplo:

Bloco de código

language	js
title	JSON

[
    {
        "channel": "38",
        "alias": [
            {
                "from": "Lojas Americanas",
                "to": "AME"
            },
            {
                "from": "Americanas",
                "to": "AME"
            },
            {
                "from": "Submarino",
                "to": "SUB"
            },
            {
                "from": "Shoptime",
                "to": "SHO"
            }
        ]
    }
]

totvsmoda.pedido.correcao.desconto100porcento

Flag que controla se o conector do TOTVS Moda deve realizar a correção de valores para itens com 100% de desconto.
Se ligada, 1 centavo será retirado do desconto do item e adicionado à outro item ou ao frete do pedido.

Formato: Texto, informar TRUE ou FALSE

Exemplo: TRUE

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

Informações

title	Observação

Para que os pedidos do tipo de entrega em domicilio (Shipping) integrem naturalmente ao ERP, a informação do Código do Serviço Postal dos transportadores precisam ser previamente cadastrada no componente EXPFM006 do ERP TOTVS Moda.

...

Árvore de páginas

Versões comparadas

Versão antiga 51

Nova versão Atual

Chave