CONTEÚDO
- Visão Geral
- Regras de utilização no Totvs Ipass
- Regras de utilização do ERP
- Outras Ações / Ações relacionadas
- Tela XXX
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
Esta documentação tem como objetivo descrever como funciona o envio da carga de Imagem do ERP TOTVS Varejo Supermercados para a plataforma de E-commerce Shopify utilizando a plataforma TOTVS iPaaS como middleware de comunicação. Nesta integração são enviadas imagens, e especificações acerca do SKU.
02. REGRAS DE UTILIZAÇÃO NO TOTVS IPASS
O IPAAS as imagens e especificações de SKUs referente aos produtos no ERP através do endpoint: GET SmPedidoVenda/api/v1/Cadastros/ProdutoSkuEspecificacao.
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 das especificações de SKUs e imagens. 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.
03. TELA XXXXX
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
04. DICIONÁRIO DE CAMPOS
Campos utilizados na integração do endpoint GET SmPedidoVenda/api/v1/Cadastros/ProdutoSkuEspecificacao, e suas respectivas referências no ERP e na plataforma Shopify
Campo | ERP (Linha Consinco) | Shopify |
CompanyId | Parâmetros > Parâmetros > Empresa> Aba Geral > Empresa (max_empresa.nroempresa) | Hub: “CompanyId” Shopify: não existe |
BranchId | Será cadastrado no HUBECOMMERCE como filial, porém o código será Parâmetros > Parâmetros > Empresa> Aba Geral > Empresa (max_empresa.nroempresa) | Hub: “BranchId” Shopify: não existe |
productSpecificationId | Código da Imagem no ERP.
Observação: Este campo não fica visível no ERP, é apenas um sequencial de controle interno do sistema, que entretanto, é utilizado como identificador da imagem durante a integração para o Hub. | Hub: “erpReferenceKey”
Shopify: id
Observações: O campo productSpecificationId é integrado apenas até o Hub, para controle do código de imagem do erp, sendo que no Hub ele será o campo erpReferenceKey, porém ao integrar a imagem no Shopify, ele irá trazer como devolutiva para o Hub, o Id da Imagem no shopify, que no Hube será o campo eCommerceReferenceKey. |
createDate | Refere-se à Data e Hora de inclusão do Cadastro de Produto (map_produto.dtahorinclusao), caso não haja, será enviado um Default com a data 01-Jan-2000. | Hub: “createDate” Shopify: created_at |
lastChange | Última Data e Hora de alteração no Cadastro da imagem do Produto em Cadastros > Aba Produto > Produto > Aba Ecommerce e Aba Imagem
ou caso não haja, será utilizado a última Data e Hora de inclusão no Cadastro de produto (map_produto.dtahorinclusao). Como default caso não exista data e hora nestes campos será enviado 01-jan-2000. | Hub: “lastChange” Shopify: updated_at |
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.
Exemplo: SeqProduto 919 e QtdEmbalagem 12, sendo assim, o ProductSkuId será P919E12 | Hub: “erpReferenceKey” Shopify: variant_ids |
name | Campo Descrição, localizado em Cadastros > Aba Produto > Produto > Aba Ecommerce > Campo na Grid: Descrição. | Hub: “name” Shopify: não existe |
listOfAvailableValues | Lista de Url de imagens. | Hub: “listOfSpecificationValue” Shopify: não existe |
| listOfAvailableValues.value | Campo Url Imagem-Ecommerce, localizado em Cadastros > Aba Produto > Produto > Aba Ecommerce > Campo na Grid: Url Imagem-Ecommerce. | Hub: “value” Shopify: src |
05. TABELAS UTILIZADAS
Coloque o link das tabelas relacionadas