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:
| ||||||||||||||||||
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:
|
...