Histórico da Página
CONTEÚDO
- Visão Geral
...
- Regras de utilização
...
- Outras Ações / Ações relacionadas
...
- Principais Campos e Parâmetros
...
- no Totvs Ipass
- Regras de utilização do ERP
- Dicionário de Campos
- Acompanhamento das cargas no Hubecommerce
- Links úteis
01. VISÃO GERAL
Esta documentação tem como objetivo descrever como funciona o envio de SKU do ERP TOTVS Varejo Supermercados para a plataforma de E-commerce Shopify utilizando a plataforma TOTVS iPaaS como middleware de comunicação.
O SKU ou Unidade de Manutenção de Estoque, é utilizado como forma de identificação e rastreio de cada produto pertencente ao estoque de uma empresa, que por sua vez, tem como objetivo facilitar o controle e gestão de cada produto, sendo, atribuído com base em suas características, das quais podem ser destacadas:
- Peso
- Tamanho
- Embalagem
- Quantidade
- Código ou descrição do Produto
Além de outras informações, das quais também podem ser incluídas com o objetivo de identificar e facilitar o controle do produto no sistema, distinguindo variações, similaridades, e informações de cada produto.
02.
...
REGRAS DE UTILIZAÇÃO NO TOTVS IPASS
O IPAAS consulta os SKUs referente aos produtos no ERP através do endpoint: GET SmPedidoVenda/api/v1/Cadastros/ProdutoSku.
IMPORTANTE!
Para funcionamento é necessário ter o módulo web SmPedidoVendaAPI instalado a partir da versão 24.01.026 e 24.07.001 instalados no cliente.
Especificações e configurações para envio da carga de SKU do ERP para o Shopify:
- DtaHorAlteracao - O iPaaS faz o controle por data e hora do envio das cargas, dessa forma, consegue gerenciar para obter as alterações ou inclusões à respeito do SKU. De modo que, a definição de à partir de qual data e hora de inclusão ou alterações, é controlada no IPASS, através do HubeEcommerce( Integration Backoffice (totvs.app) ), em Aba de Configurações > SyncControl > SyncControl por Matriz > Campo: SKU. Desta forma, este campo, será configurado à partir de qual data e hora serão enviadas as cargas que sofreram alterações ou criações acerca de SKUs, neste período.
- Page - A paginação é realizada e controlada no IPASS, através do HubeEcommerce( Integration Backoffice (totvs.app) ), em Aba de Configurações > SyncControl > SyncControl por Matriz > SKU > Campo: Página, nela será possível a escolha da página ao qual quer fazer a busca das informações no ERP.
- Nrosegmento - Utilizada para obtenção do segmento em que será utilizado para busca do SKU no ERP, ao qual será enviado ao Shopify (variável no Ipass: nrosegmento)
- NroDivisao - Utilizada para obter a divisão do segmento em que será utilizado para busca do SKU no ERP, ao qual será enviado ao Shopify (variável no Ipass: nro_divisao)
- PageSize - Utilizada para definir o número máximo de registros que poderão ser retornados por página em uma requisição para retorno das informações de SKU do ERP, as quais serão enviadas ao Shopify (variável no Ipass: sku_pagesize)
- Versão da API do Shopify - A configuração de qual versão da Api de integração do Shopify está sendo utilizada, é definido através das variáveis de projeto no Ipass, representada pela variável shopify_api_version. Importante ressaltar que a variável deve ser alterada apenas pela Totvs, pois, uma alteração sem aviso prévio poderá ocasionar problemas na integração com a plataforma Shopify
Para alterar variáveis de projeto no Ipass, basta, no aplicativo Totvs Ipass, ir à barra de navegação na lateral esquerda e selecionar a opção Integrações. Após esse passo, selecione o projeto no qual está localizada a integração com o Shopify e clique na opção Configurar Projeto, localizada na parte superior da tela. Feito isso, aparecerá a seção de Variáveis, na qual será possível alterar cada variável conforme a necessidade de configuração da integração.
Detalhamento do fluxo de configuração de variáveis
Menu Integrações
Configurações do Projeto
Variáveis do Projeto
Importante Destacar!
Importante ressaltar que a variável shopify_api_version deve ser alterada apenas pela Totvs, pois, uma alteração sem aviso prévio poderá ocasionar problemas na integração com a plataforma Shopify
03. REGRAS DE UTILIZAÇÃO DO ERP
- O status da embalagem, deve estar ativo na família . (Map_Famembalagem.Status)
- O status de venda do produto de acordo com sua embalagem, deve estar ativo no cadastro de produto (Mrl_Prodempseg.Statusvenda)
- A integração de produto com o E-Commerce, deve estar ativo no cadastro de produto. (Map_Produto.Indintegraecommerce)
04. DICIONÁRIO DE CAMPOS
Campos utilizados no fluxo de integração de pedidos do Shopify para o Hub.
Campo | ERP (Linha Consinco) |
| SeqProduto | Refere-se ao Código do Produto no ERP, localizado em Cadastros > Aba Produto > Produto > Aba Geral > Campo: Código (Código do Produto). |
| NroEmpresa | Parâmetros > Parâmetros > Empresa> Aba Geral > Empresa (max_empresa.nroempresa) |
DtaHorInclusao | Será um Default com a data 01-Jan-2000. |
| DtaHorAlteracao | Data e Hora de alteração no Cadastro de produto (mrl_prodempseg.dtaalteracao), ou a última data e hora de alteração do preço da embalagem no Cadastro de família em Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Data Alteração (map_famembalagem.dtahoraltembpreco), caso não tenha alterações, retornará como default a mesma data utilizada no campo DtaHorInclusao. |
| Ativo | Indica status de Ativo do SKU, variando entre ativo que é enviado como true e inativo que é enviado como false.
As informações estão detalhadas no tópico 3 - Regras de Utilização no ERP |
| IndKit | Refere-se à associação de produtos similares, caso exista, para o SKU à ser integrado. Recebe as opções S e N, respectivamente Sim ou Não. |
| Embalagem | Embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Embalagem, concatenado com o campo Quantidade em Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: *Quantidade. |
| CodAcesso | Refere-se ao campo Códigos, localizando em Cadastros > Aba Produto > Produto > Aba Códigos > Campo: Código, |
| RefFabricante | Referência do Fabricante(map_produto.reffabricante), localizado em Cadastros > Aba Produto > Produto > Aba Geral > Campo: Referência do Fabricante. |
| NroSegmento | Utilizada para obtenção do segmento em que será utilizado para busca do SKU no ERP, ao qual será enviado ao Shopify. |
| NroDivisao | Utilizado para a obtenção da Divisão em que será utilizado para busca do SKU no ERP, ao qual será enviado ao Shopify. |
| Fields | Utilizado para filtrar os campos aos quais deseja que retorne no Response do endpoint em questão, ao executá-lo. |
| Order | Campo responsável pela ordenação da consulta retornada pela API. |
| Page | Paginação para busca das informações de SKU no ERP. |
| PageSize | Utilizada para definir o número máximo de registros que poderão ser retornados por página em uma requisição para retorno das informações de SKU do ERP, as quais serão enviadas ao Shopify. |
Campos utilizados no fluxo de integração de pedidos do Hub para o ERP, , através do endpoint GET SmPedidoVenda/api/v1/Cadastros/ProdutoSku, e suas respectivas referências no Hub e no ERP.
Campo | ERP (Linha Consinco) | Shopify |
productSKUId | Cadastros > Aba Produto > Produto > Aba Geral > Campo: Código (Código do Produto) concatenado com a quantidade da embalagem do produto (map_produto.seqproduto e map_famembalagem.qtdembalagem). Porém, terão as identificações P antes do SeqProduto, e E antes de QtdEmbalagem. | Hub: “erpReferenceKey” Shopify: sku |
createDate | Será um Default com a data 01-Jan-2000. | Hub: “createDate” Shopify: created_at |
lastChange | Última Data e Hora de alteração no Cadastro de produto (mrl_prodempseg.dtaalteracao), ou a última data e hora de alteração do preço da embalagem no Cadastro de família em Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Data Alteração (map_famembalagem.dtahoraltembpreco), caso não tenha alterações, retornará como default a mesma data utilizada no campo createDate. | Hub: “lastChange” Shopify: updated_at |
name | Refere-se ao campo Nome Produto E-Commerce, localizado em Cadastros > Aba Produto > Produto > Aba E-Commerce > Campo: Nome Produto E-Commerce (prod.nomeprodutoecomm), ou então, caso este campo não esteja preenchido, pois, é opcional no cadastro do produto, é utilizado o campo Descrição Reduzida em Cadastros > Aba Produto > Produto > Aba Geral > Campo: Descrição Reduzida (map_produto.descreduzida). | Hub: “name” Shopify: title |
width | Largura da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Largura (cm). | Hub: “width” Shopify: não existe |
realWidth | Largura da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Largura (cm). | Hub: “realWidth” Shopify: não existe |
weightKg | Peso bruto da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Peso Bruto (kg). | Hub: “weightKg” Shopify: weight |
RealWeightKg | Peso bruto da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Peso Bruto (kg). | Hub: “RealWeightKg” Shopify: weight |
length | Profundidade da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Profund. (cm). | Hub: “length” Shopify: não existe |
realLength | Profundidade da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Profund. (cm). | Hub: “realLength” Shopify: não existe |
height | Altura da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Altura (cm). | Hub: “height” Shopify: não existe |
realHeight | Altura da embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Altura (cm). | Hub: “realHeight” Shopify: não existe |
unitMultiplier | Caso no cadastro da família do produto, esta, esteja selecionada como pesável em Cadastros > Aba Família > Família > Aba Geral > Características > Campo: É pesável, será utilizado o campo Múltiplo de Venda localizado em Cadastros > Aba Produto > Produto > Aba E-Commerce > Campo: Múltiplo de Venda (map_produto.qtdmultiplovdaecommerce), ou caso não tenha valor atribuído para este campo, será utilizado o valor default 1.00, como unidade de multiplicação. | Hub: “unitMultiplier” Shopify: não existe |
measurementUnit | Embalagem no Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: Embalagem, concatenado com o campo Quantidade em Cadastro de família, em Cadastros > Aba Família > Família> Aba Embalagens > Campo: *Quantidade. | Hub: “measurementUnit” Shopify: weight_unit |
manufacturer | Referência do Fabricante(map_produto.reffabricante), localizado em Cadastros > Aba Produto > Produto > Aba Geral > Campo: Referência do Fabricante. | Hub: “manufacturer” Shopify: não existe |
productRootTitle | Refere-se ao campo Nome Produto E-Commerce, localizado em Cadastros > Aba Produto > Produto > Aba E-Commerce > Campo: Nome Produto E-Commerce (prod.nomeprodutoecomm), ou então, caso este campo não esteja preenchido, pois, é opcional no cadastro do produto, é utilizado o campo Descrição Reduzida em Cadastros > Aba Produto > Produto > Aba Geral > Campo: Descrição Reduzida (map_produto.descreduzida). | Hub: “productRootTitle” Shopify: option1 |
companyId | Será nulo, pois, no conceito de SKU para integração shopify, não será tratado com diferenciais por empresa, e sim no âmbito geral de integração, porém, caso houvesse, este campo seria responsável pelo campo nroempresa, localizado em Parâmetros > Parâmetros > Empresa> Aba Geral > Empresa (max_empresa.nroempresa). | Hub: “companyId” Shopify: não existe |
| branchId | Será nulo, pois, no conceito de SKU para integração shopify, não será tratado com diferenciais por empresa, e sim no âmbito geral de integração, porém, caso houvesse, este campo seria responsável pelas empresas filiais, representado pelo campo nroempresa, localizado em Parâmetros > Parâmetros > Empresa> Aba Geral > Empresa (max_empresa.nroempresa). | Hub: “branchId” Shopify: não existe |
isAvaiable | Enviado como default true. | Hub: “isAvaiable” Shopify: não existe |
price | Este preço será o valor default caso não tenha tabela de preço para o produto. O preço é definido por produto, segmento e quantidade da embalagem. | Hub: “price” Shopify: price |
listPrice | Será enviado como default 0, pois não será enviada uma lista de preço pelo SKU. | Hub: “listPrice” Shopify: presentment_prices |
modalType | Será enviado como nulo, pois, não é utilizado tanto no HubEcommerce, quanto, no Shopify. | Hub: “modalType” Shopify: não mapeado |
modalId | Será enviado como 0, pois, não é utilizado tanto no HubEcommerce, quanto, no Shopify. | Hub: “modalId” Shopify: não existe |
cubicWeight | Será enviado como 0, pois, não é utilizado tanto no HubEcommerce, quanto, no Shopify. | Hub: “cubicWeight” Shopify: não existe |
commercialConditionId | Será enviado como 0, pois, não é utilizado tanto no HubEcommerce, quanto, no Shopify. | Hub: “commercialConditionId” Shopify: não existe |
groupCode | Será enviado como nulo, pois, não é utilizado tanto no HubEcommerce, quanto, no Shopify. | Hub: “groupCode” Shopify: não existe |
inventoryItemId | Será enviado como nulo, pois este campo é originado e populado pelo Shopify, após o retorno da integração. Refere-se ao número de identificação deste produto no inventário da plataforma Shopify. Após a integração do SKU no Shopify, o campo inventoryItemId do HubEcommerce é atualizado, recebendo o valor de inventory_item_id do Shopify. Observação: Este campo não deve ter valor retornado ao ERP; é apenas um controle entre o HubEcommerce e o Shopify. | Hub: “inventoryItemId” Shopify: inventory_item_id |
disableStock | Enviado como default false. | Hub: “disableStock” Shopify: não existe |
updateBrand | Enviado como default false. | Hub: “updateBrand” Shopify: não existe |
productRootId | Refere-se ao Código do Produto no ERP, localizado em Cadastros > Aba Produto > Produto > Aba Geral > Campo: Código (Código do Produto). | Hub: “productRootERPReferenceKey” Shopify: não existe |
rewardValue | Enviado como default 0, pois não é utilizado no processo de integração ao Shopify. | Hub: “rewardValue” Shopify: não existe |
isActive | Indica status de Ativo do SKU, variando entre ativo que é enviado como true e inativo que é enviado como false.
As informações estão detalhadas no tópico 3 - Regras de Utilização no ERP | Hub: “isActive” Shopify: não existe |
isKit | Refere-se à associação de produtos similares, caso exista, para o SKU à ser integrado. Retornando true caso exista, e false, caso não exista. | Hub: “isKit” Shopify: não existe |
listOfEAN | Refere-se ao campo Códigos, localizando em Cadastros > Aba Produto > Produto > Aba Códigos > Campo: Código, | Hub: “listOfBarCode” Shopify: barcode |
05. ACOMPANHAMENTO DAS CARGAS NO HUBECOMMERCE
Painel de monitoramento: https://hubecommerce.totvs.app/product-sku
06. LINKS ÚTEIS
Link: Detalhamento do fluxo
...
03. TELA XXXXX
Outras Ações / Ações relacionadas
...
04. TELA XXXXX
Principais Campos e Parâmetros
...
| Card documentos | ||||
|---|---|---|---|---|
|
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas