Omie ERP API — clientes, pedidos e produtos.
Nó Omie
O nó de workflow Omie chama a Omie ERP API — ERP em nuvem brasileiro que cobre vendas, NF-e, clientes, produtos e financeiro. A Omie usa estilo RPC de endpoint único: toda requisição é POST com JSON contendo app_key, app_secret, call (nome do method) e param (array de argumentos).
Node ID no editor: omie_request
URL padrão: https://app.omie.com.br/api/v1/geral/clientes/
Auth: app_key + app_secret no JSON body ({{omie_app_key}}, {{omie_app_secret}})
O que faz
- Envia requisições POST para módulos Omie API (clientes, pedidos, produtos, financeiro, etc.)
- Retorna status, data e headers
- Inclui templates de operação para listar/criar/atualizar clientes, pedidos e produtos
- Suporta valores
callcustomizados para qualquer method Omie API documentado pela Omie
Pré-requisitos
- Conta Omie
- App Key e App Secret em Omie → Configurações → Integrações → API
- Integration keys em Configurações → API Keys:
omie_app_keyomie_app_secret
Cada módulo Omie API tem seu próprio caminho de URL (ex.:
/geral/clientes/,/geral/pedidos/,/geral/produtos/). Aponte o campo URL para o módulo que corresponde ao seucallmethod.
Como configurar
Passo 1 — Definir credenciais
- Na Omie, gere ou copie App Key e App Secret
- Em Configurações → API Keys, adicione:
- Name:
omie_app_key— value: sua App Key - Name:
omie_app_secret— value: seu App Secret
- Name:
Ambas as chaves são referenciadas no JSON body — nunca cole diretamente no canvas.
Passo 2 — Adicionar o nó
Arraste Omie da paleta ERP para o canvas e selecione operação pré-construída ou configure manualmente.
Passo 3 — Configurar a requisição
| Campo | Obrigatório | Descrição |
|---|---|---|
| URL / Endpoint | Sim | URL do módulo Omie — deve corresponder à área da API do seu call |
| Method | Não | Sempre POST para Omie (padrão) |
| Headers (JSON) | Não | Content-Type: application/json |
| Body (JSON) | Sim | Payload RPC Omie com app_key, app_secret, call, param |
Estrutura do request body Omie
{
"app_key": "{{omie_app_key}}",
"app_secret": "{{omie_app_secret}}",
"call": "ListarClientes",
"param": [
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N"
}
]
}
call— nome exato do method Omie (case-sensitive)param— array com um objeto contendo parâmetros do method
Operações pré-construídas
| Operação | Módulo URL | call | Finalidade |
|---|---|---|---|
| Buscar clientes | /geral/clientes/ | ListarClientes | Listar clientes |
| Criar cliente | /geral/clientes/ | IncluirCliente | Criar cliente |
| Atualizar cliente | /geral/clientes/ | AlterarCliente | Atualizar cliente |
| Buscar pedidos | /geral/pedidos/ | ListarPedidos | Listar pedidos |
| Buscar produtos | /geral/produtos/ | ListarProdutos | Listar produtos |
Exemplo — criar cliente
- URL:
https://app.omie.com.br/api/v1/geral/clientes/ - Method:
POST - Body:
{
"app_key": "{{omie_app_key}}",
"app_secret": "{{omie_app_secret}}",
"call": "IncluirCliente",
"param": [
{
"codigo_cliente_integracao": "{{variables.crm_lead_id}}",
"razao_social": "{{contact.name}}",
"cnpj_cpf": "{{variables.cpf}}",
"email": "{{contact.email}}",
"telefone1_numero": "{{contact.phone}}"
}
]
}
Use codigo_cliente_integracao como seu ID externo para upserts idempotentes.
Exemplo — listar pedidos com filtro de data
- URL:
https://app.omie.com.br/api/v1/geral/pedidos/ - Body:
{
"app_key": "{{omie_app_key}}",
"app_secret": "{{omie_app_secret}}",
"call": "ListarPedidos",
"param": [
{
"pagina": 1,
"registros_por_pagina": 100,
"filtrar_por_data_de": "01/01/2026",
"filtrar_por_data_ate": "31/01/2026"
}
]
}
Consulte a documentação de methods Omie para nomes exatos de campos de filtro — variam por call.
Passo 4 — Usar dados da resposta
Respostas Omie dependem do call. Methods de listagem tipicamente retornam arrays paginados:
{{omie_1.data.clientes_cadastro}}
{{omie_1.data.pedido_venda_produto}}
{{omie_1.data.produto_servico_cadastro}}
Inspecione o log de execução após teste para confirmar nomes de campos do seu call específico.
Saídas do nó
| Campo de saída | Descrição |
|---|---|
status | HTTP status code |
data | JSON parseado da resposta Omie |
headers | Response headers |
Dicas e boas práticas
- URL deve corresponder ao módulo —
ListarPedidosexige/geral/pedidos/, não URL de clientes - Sempre POST — Omie não usa REST verbs em resource paths; seleção de method é via
call - param é array — mesmo para um único objeto de argumento, encapsule em
[ { ... } ] - Use campos codigo_*_integracao — mapeie IDs WhatsWave/CRM para códigos de integração Omie para upserts confiáveis
- Paginate com pagina / registros_por_pagina — faça loop até buscar todas as páginas
- Formato de data — Omie frequentemente espera strings
DD/MM/YYYYem filtros; confirme na documentação do method - Financeiro e NF-e — módulos adicionais existem sob caminhos
/api/v1/; copie nomescallde documentação Omie developer - Tratamento de erros — Omie pode retornar HTTP 200 com fault objects dentro de
data; adicione nó Condition para verificar campos de erro
Exemplos de uso
Sincronizar clientes Omie com contatos WhatsWave
- Schedule — noturno
- Omie —
ListarClientescom paginação - Loop sobre
clientes_cadastro - Contact create/update — match por
cnpj_cpfou e-mail
Notificar vendas quando pedido grande é feito
- Schedule — a cada 30 minutos
- Omie —
ListarPedidosfiltrado por data - JavaScript — filtrar pedidos acima do limite
- Send WhatsApp — alerta ao gerente comercial
Criar cliente Omie a partir de lead webhook
- Webhook — submissão de formulário landing page
- Omie —
IncluirClientecom dados do formulário - Variable — armazenar
codigo_cliente_omieda resposta - Send WhatsApp — mensagem de boas-vindas
Conferir catálogo de produtos
- Schedule — semanal
- Omie —
ListarProdutos - Nó de e-commerce — buscar catálogo da loja
- JavaScript — diff de SKUs e sinalizar divergências
FAQ
Por que HTTP 404?
URL de módulo incorreta para o call method. Cada área de serviço Omie tem caminho próprio sob /api/v1/.
Por que "Invalid call" ou resposta vazia?
Typo no nome call — deve corresponder exatamente à documentação Omie (ex.: ListarClientes, não listarClientes).
Posso usar GET em vez de POST?
Não — Omie API usa POST para todas as operações.
Onde vão app_key e app_secret?
No body JSON, não nos headers. Templates do nó incluem ambos os placeholders.
Como chamo methods de financeiro ou NF-e?
Altere a URL para o módulo Omie apropriado e defina call + param conforme catálogo Omie API.
Isso difere do nó HTTP?
Mesmo executor, mas Omie inclui URL padrão, placeholders de auth e templates de operação ERP.
Referência da API
| Item | Valor |
|---|---|
| Padrão base | https://app.omie.com.br/api/v1/{module}/ |
| Method | POST (todas as chamadas) |
| Auth | app_key + app_secret no body |
| Content-Type | application/json |
| Docs oficiais | Omie Developer |
URLs de módulos (dos templates de operação)
| Caminho do módulo | Exemplos de call |
|---|---|
/geral/clientes/ | ListarClientes, IncluirCliente, AlterarCliente |
/geral/pedidos/ | ListarPedidos, IncluirPedido, … |
/geral/produtos/ | ListarProdutos, IncluirProduto, … |
Navegue a lista completa de methods no portal de desenvolvedores Omie para financeiro, NF-e, estoque e mais.
Relacionado
Este artigo foi útil?
Precisa de mais ajuda? Falar com suporte