Histórico da Página
Integração BackOffice Datasul x Ciashop
A integração entre o BackOffice Datasul e a Plataforma e-Commerce da Ciashop tem como objetivo realizar a comunicação da loja de comércio eletrônico com o ERP Datasul.
Sistemas Envolvidos
Linha Ciashop
Ciashop: Sistema vertical desenvolvido pela Ciashop, empresa do ecossistema TOTVS, que dispõe de módulos e aplicativos voltados para o e-commerce. Com a plataforma Framework Ciashop, é possível montar sua própria loja de comércio eletrônico, integrando esta loja com os principais marketplaces disponíveis no mercado.
Linha Datasul (BackOffice)
ERP Datasul: Sistema de BackOffice para gestão de empresas com ênfase no segmento de Manufatura. Disponibiliza módulos de gestão e controle da distribuição com foco nos requisitos comerciais, fiscais e tributários, entre eles: Pedidos de Venda, Faturamento e Embarques.
Integração
A forma de comunicação entre ERP e Ciashop se dará por meio de mensagens enviadas e recebidas de um Web service RESTfull. Os Web services RESTful são serviços construídos com o estilo de arquitetura RESTful. A construção de Web services com a abordagem RESTful está surgindo como uma alternativa popular ao uso de tecnologias baseadas em SOAP para implantação de serviços na Internet, por ser mais leve e ter a capacidade de transmitir dados diretamente via HTTP.
Escopo
A plataforma Framework Ciashop é uma plataforma em que o cliente pode montar sua própria loja de comércio eletrônico.
O Ciashop permite que o cliente monte sua própria loja virtual. Para estabelecer a estrutura da loja virtual com seus departamentos e itens postos à venda, o ERP deverá fornecer tais informações. A loja virtual estará integrada com o ERP transmitindo para este os clientes e pedidos cadastrados na loja virtual.
A forma de comunicação entre ERP e Ciashop se dará por meio de mensagens enviadas e recebidas de um Web service RESTfull. Os Web services RESTful são serviços construídos com o estilo de arquitetura RESTful. A construção de Web services com a abordagem RESTful está surgindo como uma alternativa popular ao uso de tecnologias baseadas em SOAP para implantação de serviços na Internet, por ser mais leve e ter a capacidade de transmitir dados diretamente via HTTP.
O conceito de Marketplace (MP), no comércio eletrônico, é a utilização de uma loja virtual de terceiros para vender os seus produtos. Sales Hub é um aplicativo disponível para Lojas Framework da Ciashop que concentra diversos marketplaces, tais como Extra e Walmart. Por meio deste aplicativo, é possível ofertar os produtos da loja nestes marketplaces e gerenciar os pedidos gerados nestes canais em sua própria loja.
O objetivo da integração é possibilitar a integração dos Cadastros de Famílias Comerciais, Itens, Tabela de Preço e Saldo em Estoque disponível do Datasul para o Ciashop. Assim como, a integração do recebimento de pedidos de venda oriundos do Ciashop e a atualização do status destes pedidos.
Pré-requisitos instalação/implantação/utilização
Datasul
Versão\release 12.1.17
Parâmetros de integração ativo: Cadastros Gerais -> Cadastros Gerais -> Cadastros -> Função: Manutenção Cadastros Gerais Parâmetro Global (CD0101 - Aba Integr II)
Parâmetros de configuração da integração ativo: Menu -> Logística -> Pedidos -> Cadastros -> Função: Parâmetros Integração Ciashop
Instalação/Atualização
Vide tópico Pré-requisitos instalação/implantação/utilização.
Datasul
Vide tópico Pré-requisitos instalação/implantação/utilização.
Controle de Versão
O grupo TOTVS, representado por suas marcas, administrará as demandas de evolução das mensagens de integração e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
Suporte
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos Ciashop e Backoffice Datasul estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Observação: Este modelo de suporte está sendo revisado pela TOTVS.
Transações/Entidades/Mensagens únicas
Método | ID | Descrição | Origem | Destino | Web Services |
Cadastros | 01 | Família Comercial | Datasul | Ciashop | Departments |
02 | Itens | Datasul | Ciashop | Products | |
03 | Preço Item | Datasul | Ciashop | Prices | |
04 | Saldo Estoque | Datasul | Ciashop | Variants | |
Processos | 05 | Receber pedidos | Ciashop | Datasul | Orders |
06 | Atualizar situação dos pedidos | Ciashop | Datasul | Orders | |
07 | Cancelar Pedido | Datasul | Ciashop | Orderstatuses | |
08 | Atualizar NF-e | Datasul | Ciashop | Invoices |
Fluxo das Informações
Os cadastros devem ser realizados no ERP Datasul e replicados para o Ciashop, por meio do programa de carga presente no ERP Datasul. Importante ressaltar que, qualquer movimentação na plataforma do Ciashop (inclusão, alteração, eliminação) não é replicada para o ERP Datasul. A operação de eliminação dos registros (referentes aos cadastros) no ERP Datasul, também não integra com o Ciashop.
Por meio do programaIntegração Batch Ciashop - PD0624, é possível realizar a carga/atualização dos registros em lote, ele pode ser acessado pelo menu do Datasul em: Logística -> Pedidos -> Tarefas.
O sucesso das operações de inclusão e alteração de registros pode ser verificado acessando o programa Monitor Integração Ciashop - PD0625. Por meio deste programa, é possível realizar a consulta do envio dos registros referente aos cadastros de Família Comercial, Itens, Preço Item, Saldo em Estoque, recepção dos pedidos e atualização da situação dos pedidos.
No programa Manutenção Categoria Item - PD0623, é possível definir todas as famílias comercias (Categoria) e seus respectivos itens (Produtos) que serão enviados ao Ciashop. Importante ressaltar que, os itens que serão enviados para o Ciashop precisam obrigatoriamente estarem cadastrados no programa Tabela Preço - CD1508, este cadastro é necessário, pois o preço do produto no Ciashop é o valor informado no campo Preço FOB do programa CD1508. Para que o saldo disponível em estoque do item seja enviado ao Ciashop, é necessário que este possua saldo em estoque disponível, caso o item não possua saldo, é possível realizar o cadastro por meio do programa Transações Diversas Estoque - CE0220.
Para o envio das informações de saldo e preço do item, serão considerados o depósito e a tabela de preço padrão informados no programa Parâmetros Integração Ciashop - PD0310. Obrigatoriamente, todos os itens enviados para o Ciashop deverão estar cadastrados na tabela de preço informada no programa PD0310, assim como deverão estar cadastrados com saldo em estoque para o depósito informado também no PD0310.
Cadastros
A seguir o diagrama de fluxo de informações relacionando os cadastros integrados entre BackOffice Datasul e Ciashop. Depois do diagrama, serão descritos os detalhes da integração de cada cadastro.
- Estabelecimento: Informar o estabelecimento que será utilizado na integração.
- Host: O host deverá ser solicitado a Ciashop.
- Porta Padrão: A porta deverá ser solicitada a Ciashop.
- Token: O token deverá ser solicitado a Ciashop.
- Grupo Cliente: O grupo cliente padrão será utilizado para a inclusão de clientes no ERP, durante a implantação do pedido oriundo do Ciashop no ERP Datasul. As informações que serão consideradas são: Natureza, Portador, Modalidade, Representante, Atividade, Tipo Receita/Despesa e Percentual de Desconto. Estas informações podem ser consultadas por meio do programa CD0701 (Manutenção Grupo Cliente).
- Natureza de operação: Informar neste campo a natureza de operação estadual que será utilizada durante a implantação do pedido de venda no ERP Datasul.
- Natureza de operação interestadual: Informar neste campo a natureza de operação interestadual que será utilizada durante a implantação do pedido de venda no ERP Datasul.
- Tabela de Preço: Na primeira fase a integração não está tratando múltiplas tabelas de preço. A tabela de preço que for parametrizada no Ciashop, deverá ser a mesma informada neste campo.
- Depósito: Na primeira fase a integração não está tratando múltiplos depósitos. Para consulta do saldo em estoque, será considerado apenas o depósito informado neste campo.
- Nr Último Pedido: Este campo será atualizado conforme a entrada de pedidos oriundos do Ciashop no ERP Datasul. Neste campo estará informado sempre o código do último pedido Ciashop que foi buscado pelo programa PD0624 (Integração Batch Ciashop).
Família Comercial:
Para que a integração do cadastro de Família Comercial seja realizada, é obrigatório:
- Integração Ciashop ativada no programa CD0101.
Além disso, é necessário cadastrar esta família comercial no programa Manutenção Categoria Item - PD0623:
- Ao cadastrar uma família comercial, todos os itens vinculados a esta família serão automaticamente apresentados em tela.
As famílias comerciais (no contexto Ciashop possuem a descrição de categorias), enviadas do BackOffice Datasul para o Ciashop, poderão ser consultadas no manager do Ciashop, por meio do menu: Categorias e Produtos -> Gerenciar Categorias:
Item:
Para que a integração do cadastro de itens seja realizada, é obrigatório marcar o parâmetro "Item" no programa Integração Batch Ciashop - PD0624, aba parâmetro:
Além disso, é necessário definir que este item será considerado na integração com o Ciashop por meio do programa Manutenção Categoria Item - PD0623:
- A imagem acima é uma demonstração de que os itens TV-4k e TV-LED serão considerados na integração com o Ciashop.
- Além disso, é necessário cadastrar os itens que serão enviados para o Ciashop na tabela de preço (Tabela Preço - CD1508) que foi informado no programa PD0310.
É necessário informar para os itens que serão enviados ao Ciashop o código EAN/GTIN por meio do campo Cód GTIN (TRIB), que está localizado no programa Atualização Itens Faturamento - CD0903, aba Fiscal.
- Para itens com referência, é necessário que seja informado no campo "tipo de referência" do programa Manutenção Referências Itens - CD1506 a identificação da referência. Por exemplo: Cor, Tamanho e entre outros.
Os itens enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos:
Preço/Tabela de Preço:
Para que a integração da atualização do preço do item seja realizada, é obrigatório:
- Integração Ciashop ativada no programa CD0101.
- A tabela de preço informada no programa PD0310 deve estar cadastrada no manager do Ciashop.
- Definir os itens que serão considerados na integração com o Ciashop por meio do programa Manutenção Categoria Item - PD0623.
Além disso, é necessário cadastrar os preços para todos os itens que serão enviados para o Ciashop por meio do programa Tabela Preço - CD1508:
- O Preço do item que será considerado ao enviar o registro para o Ciashop, é o valor informado no campo Preço FOB do programa CD1508.
Os preços enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos -> Cadastros de Produtos -> Preço e Estoque:
Saldo em Estoque:
Para que a integração da atualização do saldo em estoque disponível dos itens seja realizada, é obrigatório:
- Integração Ciashop ativada no programa CD0101.
O cadastro de saldo em estoque poderá ser realizado por meio do programa Transações Diversas Estoque - CE0220:
- Os itens que serão integrados, deverão estar com saldo em estoque cadastrados para o depósito informado no programa PD0310.
O saldo em estoque enviado do BackOffice Datasul para o Ciashop, poderá ser consultado no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos -> Cadastros de Produtos -> Preço e Estoque:
Por meio do programa Monitor Integração Ciashop - PD0625, é possível realizar a consulta do envio dos registros referente aos cadastros de Família Comercial, Itens, Preço Item, Saldo em Estoque, recepção dos pedidos e atualização da situação dos pedidos:
- Quando um registro for integrado com sucesso, a cor do grid ficará destacada em azul.
- Quando um registro não for integrado com sucesso, a cor do grid ficará destacada em vermelho.
- No grid Ocorrências Integração, é possível detalhar a mensagem com um clique duplo caso necessário.
Recepção do Pedido de Venda:
Para que a recepção do pedido de venda seja realizada é obrigatório:
- Integração Ciashop ativada no programa CD0101 .
- Vincular o ID da transportadora cadastrada no Ciashop por meio do campo “ID Ciashop” presente no programa Transportadores - CD0402. Caso o ID da transportadora não esteja cadastrado no ERP Datasul, o pedido não será importado com sucesso no ERP Datasul.
- É necessário cadastrar o nome do canal de origem presente no Ciashop como um representante no ERP Datasul. Por exemplo, se o canal de origem for o Walmart, o Walmart deverá ser cadastrado como sendo um representante no ERP Datasul.
A recepção do pedido de venda é realizada por meio do parâmetro "Pedido Venda" no programa Integração Batch Ciashop (PD0624), aba parâmetro:
- Por meio do programa Monitor Integração Ciashop - PD0625, será possível verificar se o pedido foi importado com sucesso ou não, em caso de falha, será possível realizar a importação desse pedido novamente por meio do botão "Buscar Pedido", localizado no programa PD0625.
- No programa Parâmetros Integração Ciashop - PD0310, existe o campo Nr Último Pedido, sempre que a recepção do pedido de venda for executada, o pedido a ser solicitado ao Ciashop, sempre será o número do último pedido + 1, ou seja, caso no campo Nr último Pedido esteja armazenado o valor 20, será solicitado ao Ciashop todos os pedidos que possuírem o número de pedido superior ao 20.
- Para a recepção de novos pedidos, utilizar o programa Integração Batch Ciashop - PD0624 para pedidos que já foram importados do Ciashop, mas que por algum motivo não foram incluídos com sucesso, utilizar o botão "Buscar Pedido" do programa Monitor Integração Ciashop - PD0625.
Os pedidos disponíveis no Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Minhas Vendas -> Gerenciar Pedidos -> Listagem de Pedidos:
Atualização da situação do Pedido de Venda:
Para a atualização da situação do pedido de venda, é obrigatório:
- Integração Ciashop ativada no programa CD0101.
A atualização da situação do pedido de venda é realizada por meio do parâmetro "Atualizar situação dos Pedidos " no programa Integração Batch Ciashop - PD0624, aba parâmetro:
- Por meio do programa Monitor Integração Ciashop - PD0625, também será possível atualizar a situação do pedido caso necessário por meio do botão "Atualizar Situação", localizado no programa PD0625.
- Na primeira carga da atualização da situação do pedido, será atualizada a situação de todos os pedidos que já foram importados no BackOffice Datasul, nas próximas atualizações será respeitado a data e o horário gravado nos campos Data e Horário do programa Integração Batch Ciashop - PD0624, aba Parâmetro. Ou seja, será solicitado ao Ciashop, somente os pedidos que foram incluídos ou sofreram atualizações depois da data e horário apresentados no programa PD0624.
- Se por algum motivo, for necessário executar a atualização da situação do pedido com uma data inferior a que está sendo apresentado em tela, utilizar o parâmetro "Atualizar Situação dos Pedidos a partir de", preenchendo também a data e horário para a busca ser realizada com sucesso.
A situação dos pedidos disponíveis no Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Minhas Vendas -> Gerenciar Pedidos -> Listagem de Pedidos. Ou por meio do programa Monitor Integração Ciashop - PD0625 no BackOffice Datasul, coluna "Situação":
Envio da URL de rastreamento para o Ciashop:
Para a atualização da situação do pedido de venda, é obrigatório:
- A nota fiscal deverá ter sido gerada a partir de um pedido de venda oriundo do Ciashop.
O envio da URL de rastreamento para o Ciashop é realizado por meio do botão "Rastreamento" no programa Manutenção Notas Fiscais - FT0502, Aba Inf Gerais:
Ao clicar no botão Rastreamento, informar a URL de rastreamento, ao clicar no botão "OK", esta URL será enviada para o Ciashop:
A URL de rastreamento poderá ser consultada no manager do Ciashop, por meio do menu: Minhas Vendas -> Gerenciar Pedidos -> Listagem de Pedidos -> Visualização do Pedido:
Limitações / Restrições Gerais
- Para itens com referência, o código GTIN/EAN, será gravado somente para a primeira referência do item.
- Ao eliminar um registro no Ciashop, este registro não será eliminado automaticamente no BackOffice Datasul.
- Neste primeiro momento, não é possível trabalhar com múltiplos depósitos.
- Neste primeiro momento, não é possível trabalhar com múltiplas tabelas de preço.
Caso o item possua algum caractere especial no nome, o caractere especial será retirado durante o envio para o Ciashop. No Ciashop o item será apresentado sem caracteres especiais.
Erros de integração:
Código | Erro | Rota de Integração | Situação | Relação |
55117 | Categoria não cadastrada na Ciashop! | DATASUL > CIASHOP | O item enviado está relacionado a uma Família Comercial (Categoria) não cadastrada na Ciashop. | Pedido de Vendas |
55118 | Categoria já existe em outro relacionamento! | DATASUL > CIASHOP | A Família Comercial (Categoria) enviada para Ciashop já está relacionada como "pai" ou como "filho" de outra Categoria. | Pedido de Vendas |
55119 | Item já integrado na Ciashop! | DATASUL > CIASHOP | O item já foi integrado na Ciashop! | Pedido de Vendas |
55120 | Categoria já foi integrada na Ciashop! | DATASUL > CIASHOP | A Família Comercial (Categoria) já foi integrada na Ciashop! | Pedido de Vendas |
55121 | Integração sem sucesso! | DATASUL > CIASHOP | A Integração referente a(o) não ocorreu devido a caracteres especiais não permitidos. | Pedido de Vendas |
55122 | URL já integrada na Ciashop! | DATASUL > CIASHOP | A URL já foi integrada na Ciashop. | Pedido de Vendas |
55123 | Preço não atualizado na Ciashop! | DATASUL > CIASHOP | O Preço não foi atualizado porque o item não foi integrado na Ciashop. | Pedido de Vendas |
55124 | Erro no Saldo em Estoque! | DATASUL > CIASHOP | Não existe Saldo em Estoque para o item no(s) Depósito(s) parametrizado(s) para Integração com a Ciashop. | Pedido de Vendas |
55125 | Erro no Saldo em Estoque para o Estabelecimento! | DATASUL > CIASHOP | Não existe Saldo em Estoque para o item parametrizados para Integração com a Ciashop. | Pedido de Vendas |
55126 | Erro no Saldo em Estoque! | DATASUL > CIASHOP | Não existe Saldo em Estoque disponível para o item em nenhum dos Depósitos parametrizados para Integração com a Ciashop. | Pedido de Vendas |
55127 | Saldo em Estoque permanece inalterado! | DATASUL > CIASHOP | O Saldo em Estoque do Item permanece inalterado desde o último envio para o Ciashop. | Pedido de Vendas |
55128 | Item não Cadastrado! | DATASUL > CIASHOP | O Item não está cadastrado na Tabela de Preço Padrão utilizada para integração com a Ciashop. | Pedido de Vendas |
55220 | Código EAN Inválido! | DATASUL > CIASHOP | Favor verificar se o código EAN está informado no cadastro do item, CD0903, pasta Fiscal, campo "Cod. GTIN (Trib)". Este código deve ser único por item, ou seja, o mesmo código EAN não poderá estar associado a mais de um item. | Pedido de Vendas |
55250 | Referência deve conter um tipo! | DATASUL > CIASHOP | Para itens com referência deve ser informado o tipo da referência no programa CD1506 (Manutenção Referência Item). | Pedido de Vendas |