Como integrar com o ERP Omie

Parte 1: Configurações Gerais

Nesta primeira etapa, você aprenderá como preencher e ativar corretamente as Configurações Gerais da integração com o Omie ERP dentro da plataforma. Essa configuração é essencial para garantir o bom funcionamento da comunicação entre os sistemas.

1. Status da Integração

• Opção: Ativo / Inativo
  
• Recomendado: Ativo
  
• Função: Ativa ou desativa toda a integração com o Omie.

Deixe como “Ativo” para que a comunicação entre a plataforma e o Omie funcione.

2. Processar callback do Webhook

• Opção: Ativo / Inativo
  
• Recomendado: Ativo
  
• Função: Permite que o Omie envie atualizações automáticas de pedidos para a plataforma via Webhook.

Importante: para que o processamento funcione corretamente, é necessário configurar a URL de callback da plataforma dentro do Omie.

Essa URL deve ser solicitada ao time de implantação responsável pela sua integração.

Com o webhook configurado, você não precisa buscar manualmente atualizações de status — elas virão automaticamente assim que forem alteradas no Omie.

3. Permitir a atualização das dimensões

• Opção: ativo / inativo
  
• Recomendado: Conforme o controle do catálogo de produtos (em muitos casos, deixe como Inativo)
  
• Função: Permite que as dimensões (altura, largura, profundidade) dos produtos sejam atualizadas pela integração.

Habilite somente se o Omie for a fonte de verdade das dimensões dos produtos.

4. APP Key e APP Secret

• O que são: São credenciais de autenticação fornecidas pelo Omie para autorizar a integração.
  
• Onde obter: No painel do Omie, dentro do módulo de API.
  
• Campos obrigatórios:
  
  • APP Key: Identificador da aplicação.
    
  • APP Secret: Senha segura da aplicação.

Essas credenciais garantem que a comunicação com o Omie seja segura e autenticada.

5. Código do Local de Estoque

• Função: informa de qual local do estoque (dentro do Omie) a plataforma deve considerar os saldos.

Importante para empresas com múltiplos centros de distribuição.

6. Código da Categoria do Pedido

• Função: Classificação interna usada pelo Omie para categorizar os pedidos recebidos.

Esse código precisa estar previamente cadastrado no Omie.

7. Código da Modalidade de Frete

• Opção comum: 1 – Frete por conta do destinatário
  
• Função: Define como o frete será registrado nos pedidos importados para o Omie.

Outras opções podem ser utilizadas conforme a operação da loja (ex: CIF, FOB etc.).

8. Total de registros no cadastro de produtos

• Padrão sugerido: 200
  
• Função: Define quantos produtos serão buscados por requisição no momento do cadastro.

Evite colocar números muito altos para não sobrecarregar a API do Omie.

9. Total de registros na atualização do estoque dos produtos

• Padrão sugerido: 200
  
• Função: Limita a quantidade de produtos a serem atualizados por requisição.

Ideal para manter a estabilidade na comunicação com o Omie.

Finalizando

Depois de preencher todas as informações, clique em “Testar” para validar a conexão com o Omie.
Se a conexão estiver correta, você poderá seguir para os próximos passos da integração.

Parte 2: Mapeamento de Tipos de Pagamento

O mapeamento de pagamentos é essencial para garantir que os pedidos da plataforma sejam lançados corretamente no ERP Omie, com o tipo de pagamento correspondente.

Objetivo desta etapa

Relacionar os meios de pagamento utilizados na plataforma com os tipos de pagamento do Omie ERP, garantindo que os lançamentos financeiros e pedidos estejam corretos.

Como funciona o mapeamento

A plataforma exibe os meios de pagamento disponíveis na loja virtual, organizados por  gateway e bandeiras (ex: Cielo, Rede, Pagar.me, PagSeguro, etc.).

Para cada um desses meios, você deve:

1. Selecionar o tipo de pagamento equivalente no Omie (ex: Cartão de Crédito, Boleto, PIX).
   
2. Garantir que a escolha seja compatível com o que será processado e registrado nos pedidos no ERP.
   

Exemplos de mapeamento (visíveis nas telas fornecidas)

Tipo de pagamento na plataforma	Tipo de pagamento ERP
American Express	Cartão de Crédito
Boleto Bancário	Boleto Bancário
Pix	Pagamento Instantâneo (PIX)
MasterCard, Visa, Elo, etc.	Cartão de Crédito
PagSeguro / Moip / Paypal	Selecionar conforme o tipo real da transação (geralmente Cartão de Crédito ou Boleto)

Dica: Mesmo gateways como Pagar.me podem oferecer diversos meios (Pix, boleto, crédito). O mapeamento deve ser feito com base na forma final de pagamento, e não apenas no gateway.

Importante:

• se o mapeamento for feito incorretamente, os pedidos podem não ser lançados no Omie ou ser lançados com erro no financeiro;
  
• Certifique-se de que todos os meios utilizados na loja estejam mapeados;
  
• Para meios de pagamento próprios, como “Proprio”, defina um tipo genérico coerente (ex: transferência, dinheiro, etc.).

Finalizando essa etapa

Depois de configurar todos os tipos corretamente:

• revise os campos;
  
• verifique com o time financeiro se os tipos mapeados estão de acordo com a operação.

Salve as configurações para finalizar essa etapa.

Parte 3: Mapeamento de Formas de Envio

Nesta etapa, você vai aprender a relacionar os tipos de envio cadastrados na plataforma com os tipos de envio registrados no Omie ERP.

Este processo é essencial para garantir que as informações logísticas dos pedidos sejam integradas corretamente ao Omie, permitindo a emissão adequada de notas fiscais e controle do frete.

Objetivo do Mapeamento

O objetivo é relacionar as formas de envio da loja com os códigos de modalidade de frete do Omie ERP, especificando quem arca com o custo do frete e como ele é transportado.

Exemplos comuns de formas de envio na loja

Tipo de envio na plataforma	Descrição
Correios API	Integração com PAC / SEDEX
Transportadora XYZ	Transporte contratado externo
Mercado Envios / Loggi / ShipSmart	Plataformas terceirizadas de envio
Datafrete / Frenet / w.envios	Gateways de cálculo de frete

Como fazer o mapeamento corretamente

1. Vá até o menu “Mapeamento de Formas de Envio”.
   
2. Para cada tipo de envio listado em “Tipos de Envio”, escolha o tipo correspondente do Omie na coluna à direita.
   
3. A correspondência deve refletir como e por quem o frete será realizado.

Atenção!

• Um mapeamento incorreto pode gerar erros na emissão de NF-e, problemas contábeis ou informações imprecisas no pedido.
  
• Consulte o responsável fiscal/contábil do cliente em caso de dúvida sobre quem deve arcar com o frete.

Finalizando essa etapa

Após concluir o mapeamento:

• Verifique se todas as formas de envio ativas na loja estão devidamente mapeadas.
  
• Salve as configurações para garantir que os próximos pedidos sejam integrados corretamente.

Parte 4: Mapeamento de Status

Nesta etapa, você aprenderá como configurar o mapeamento de status dos pedidos entre a loja plataforma e o ERP Omie. Esse processo garante que o andamento dos pedidos seja corretamente refletido no ERP, mantendo as informações sincronizadas entre os dois sistemas.

Objetivo do Mapeamento de Status

O mapeamento serve para:

• Relacionar os status operacionais da loja com os status internos do Omie.
  
• Automatizar a evolução do pedido no ERP conforme o fluxo da loja.
  
• Facilitar a emissão de notas fiscais, controle logístico e financeiro no Omie.

Exemplo de Status na Plataforma

Status na plataforma	Quando ocorre
Aguardando Pagamento	Cliente finalizou o pedido, mas ainda não pagou
Pago	Pagamento confirmado (boleto, cartão, Pix etc.)
Pedido Faturado	Nota fiscal foi emitida pela loja
Pedido Enviado	Pedido foi despachado pela loja
Entrega Realizada	Cliente recebeu o pedido
Pedido Cancelado	Pedido foi cancelado por alguma razão

Exemplo de Status Correspondentes no Omie

Status plataforma	Status ERP (Omie)	Finalidade no ERP
Aguardando Pagamento	Pedido de Venda	Pedido lançado, aguardando faturamento
Pago	Faturar	Pedido pronto para ser faturado
Pedido Faturado	Faturado	Nota fiscal emitida
Pedido Enviado	Enviado	Pedido saiu para entrega
Entrega Realizada	Entregue	Pedido entregue ao cliente
Pedido Cancelado	Proposta	Pedido cancelado ou inativado no ERP

Como configurar o mapeamento de status

1. Acesse a aba “Mapeamento de Status” no painel de integração.
   
2. Para cada status listado na coluna Status plataforma, selecione o status correspondente do Omie na coluna Status ERP.
   
3. Siga o exemplo recomendado ou ajuste conforme a lógica de operação da empresa.

Exemplo prático na interface

Abaixo, veja como deve ficar a configuração com base nas boas práticas:

Status na plataforma	Status no ERP Omie
Aguardando Pagamento	Pedido de Venda
Pago	Faturar
Pedido Faturado	Faturado
Pedido Enviado	Enviado
Entrega Realizada	Entregue
Pedido Cancelado	Proposta

Esses mapeamentos são visíveis na tela do sistema como mostrado nas imagens enviadas.

Atenção!

• Um mapeamento incorreto pode impedir a emissão de notas fiscais, bloqueio de pedidos ou duplicidade de dados no ERP.
  
• Em caso de dúvida, consulte o responsável pela operação fiscal ou comercial da empresa para entender como o ERP é utilizado.

Finalizando essa etapa

Após o mapeamento:

1. Confirme se todos os status utilizados pela loja estão mapeados corretamente.
   
2. Salve as alterações para garantir que os próximos pedidos sejam atualizados automaticamente no Omie.

Realize testes para simular o fluxo completo do pedido e validar o comportamento esperado.

Parte 5: Tela de Sincronizações

Nesta parte do treinamento, vamos apresentar a tela de Sincronizações, onde é possível visualizar o histórico de comunicação entre a plataforma e o ERP Omie.

O que é a Tela de Sincronizações?

A tela de Sincronizações exibe uma lista de eventos de integração que foram processados entre os dois sistemas.

Cada linha representa uma tentativa de envio de dados (como pedidos ou subpedidos) da plataforma para o Omie.

Informações exibidas na tela:

Campo	Descrição
ID Sincronização	Identificador único da tentativa de sincronização
Domínio	Tipo de dado que foi sincronizado (por exemplo: pedido ou subpedido)
Data	Data e hora em que a sincronização ocorreu

Importante saber:

• Essa tela é apenas informativa, não exige nenhuma ação do usuário.
  
• Serve para acompanhamento e consulta técnica, caso seja necessário verificar o histórico de integração.
  
• Em caso de falha na integração (que será tratada em outra tela), a equipe de suporte poderá usar esses dados para investigação.

Dica prática

Se você estiver fazendo testes de integração, pode acompanhar essa tela para verificar se os pedidos foram sincronizados corretamente com o Omie.

Sem ações manuais

• Não é possível editar, reenviar ou excluir registros nesta tela.
  
• A sincronização é feita de forma automática e transparente para o usuário, com base nas configurações feitas nas etapas anteriores (pagamento, frete, status, etc.).

Parte 6: Tela de Histórico

A tela Histórico de Sincronizações exibe os detalhes completos das comunicações entre a plataforma e o ERP Omie. Ela serve para consultar o resultado de cada tentativa de integração, mostrando se houve sucesso ou erro em cada operação.

Para que serve essa tela?

Esta tela permite:

• Acompanhar se os dados foram enviados corretamente ao Omie.
  
• Visualizar mensagens de erro que possam indicar falhas de integração (como produtos não encontrados, estoques não atualizados, etc.).
  
• Observar a mensagem completa de retorno da API do Omie.

Importante: essa tela é somente informativa. Não há nenhuma ação manual disponível aqui.

Corrigir erros exige revisar os dados na plataforma ou no Omie, e em alguns casos, reprocessar a sincronização.

Campos exibidos:

Campo	Descrição
ID	Identificador da linha de histórico
ID Sincronização	Refere-se à tentativa de envio (ligado à aba “Sincronizações”)
Domínio	Tipo de dado enviado: produto, pedido, cliente, saldo-estoque etc.
Status	Resultado da sincronização: sucesso (verde) ou erro (vermelho)
Mensagem	Detalhes da resposta do Omie
Data	Data e hora da sincronização

Exemplo de Sucesso

• Domínio: saldo-estoque
  
• Status: sucesso
  
• Mensagem: “SKU: ABC123 -> estoque atualizado com sucesso.”

Isso indica que o produto com esse SKU teve o estoque atualizado corretamente no Omie.

Exemplo de Erro

• Domínio: produto
  
• Status: erro
  
• Mensagem: “ERROR: Não existem registros para a página [1]!”

Esse erro pode indicar que não há produtos cadastrados para sincronizar ou que houve uma falha na consulta de dados. Geralmente, está relacionado a filtros ou ausência de dados válidos.

O que fazer em caso de erro?

Embora não seja possível corrigir ou reenviar diretamente por essa tela, os passos recomendados são:

1. Verifique os dados na plataforma (produto, cliente, estoque, etc.).
   
2. Revise as configurações de integração (ex: se o SKU está corretamente mapeado).

Se necessário, solicite suporte técnico com base na mensagem apresentada no erro para o ERP e sequencialmente para a plataforma..

Tela de Sincronização de Pedidos

A tela de Sincronização de Pedidos permite acompanhar, filtrar e forçar a sincronização dos pedidos entre a plataforma e o Omie, garantindo que os dados estejam sempre atualizados nos dois sistemas.

Onde acessar:

Menu → Sincronizações → Aba Sincronização de pedidos

Visão geral da tela

A tela apresenta uma tabela com o histórico de integração dos pedidos, exibindo as seguintes colunas:

• Pedido Uappi: número do pedido interno da plataforma.
  
• Subpedido Uappi: identificador de subpedidos (quando aplicável).
  
• Código do pedido de venda Omie: código gerado para o pedido ao ser enviado ao Omie.
  
• Pedido de venda Omie: número do pedido registrado no Omie.
  
• Status da sincronização: indica se a integração foi bem-sucedida ou apresentou erro.
  
• Data: data e hora da última sincronização.
  
• Ícone de atualização 🔁: permite forçar a sincronização manualmente.

Filtros disponíveis

Você pode refinar a visualização dos pedidos utilizando os seguintes filtros no topo da tela:

• Pedido Uappi: filtra por número de pedido específico.
  
• Status da sincronização:
  
  • Todos (padrão)
    
  • Erro
    
  • Sucesso
    
• Período da sincronização: selecione a data de início e fim para consultar os pedidos sincronizados no intervalo desejado.

Após configurar os filtros, clique em Filtrar para aplicar ou em Restaurar para limpar os campos.

Forçar sincronização

Caso algum pedido precise ser reenviado ou atualizado no Omie, clique no ícone 🔁 (setas circulares) na linha correspondente. Isso executará uma nova tentativa de sincronização para aquele pedido específico.

Essa função é útil quando a sincronização automática falha ou quando houve alguma alteração no pedido.

Dicas úteis

• Pedidos com status “sucesso” indicam que foram integrados corretamente ao Omie.
  
• Se o status for “erro”, verifique o motivo no sistema de logs ou histórico e tente forçar a sincronização após corrigir.

Sempre utilize o filtro por data para melhorar o desempenho da tela em períodos com muitos pedidos.

Boas Práticas de Integração – Omie x Plataforma (Uappi)

Para garantir que a integração entre o Omie (ERP) e a plataforma Uappi funcione corretamente e de forma estável, é fundamental seguir algumas boas práticas operacionais e técnicas:

1. Cadastro de produtos sempre no ERP

• Evite cadastrar produtos diretamente na Uappi.
  
• Os produtos devem ser cadastrados no Omie, que é o sistema centralizador das informações.
  
• Após o cadastro no Omie, os produtos serão enviados automaticamente para a plataforma Uappi via sincronização.

Cadastrar produtos manualmente na Uappi pode gerar conflitos de dados, duplicações ou falhas na atualização de preços e estoque.

2. Cuidado com alterações nos mapeamentos

• Alterações nas configurações de:
  
  • Tipos de pagamento
    
  • Formas de envio
    
  • Status de pedidos
    
• …podem interromper ou afetar a sincronização automática de produtos, pedidos e demais informações.

Antes de editar qualquer mapeamento, revise o impacto com o time técnico ou responsável pela integração.

3. Acesse detalhes do pedido com um clique

• Na tela de sincronização de pedidos, você verá o ícone do Omie (geralmente ao lado do código do pedido).
  
• Ao clicar nesse ícone, é possível visualizar as informações de integração detalhadas do pedido, como:
  
  • ID do pedido no Omie
    
  • Status da exportação
    
  • Possíveis erros ou falhas

4. Ver histórico de sincronização de estoque por produto

• No cadastro individual do produto, há uma aba ou seção chamada Histórico.
  
• Nessa área, você pode verificar o histórico de sincronização de estoque daquele item com o Omie.
  
• Ideal para consultar se o estoque foi atualizado corretamente após movimentações (vendas, ajustes, etc.).

Resumo:

Ação	Onde fazer	Observação
Cadastro de produtos	Omie (ERP)	Nunca fazer direto na Uappi
Alteração de mapeamentos	Com cautela	Pode afetar integrações
Consultar integração de pedidos	Tela de pedidos (ícone Omie)	Verifique status e detalhes
Ver histórico de estoque	Cadastro do produto > Histórico	Acompanhe sincronizações

Criação de Atributos: siga as regras do Omie

Ao cadastrar produtos com variações (como tamanho, voltagem, cor etc.), use os atributos simples do Omie seguindo a estrutura abaixo, para evitar falhas na sincronização com a Uappi.

Observações importantes:

• Produtos sem atributos podem ser cadastrados normalmente, sem característica.
  
• Ao enviar para a Uappi, eles serão tratados como produtos únicos, sem agrupamento.
  
• Alterações incorretas nas características podem gerar erros de sincronização com o HUB ou marketplace.

Dúvidas?

Acesse nosso Help Center para ver mais conteúdos sobre a plataforma Uappi!