As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades.
Descubra como incluir um Orçamento ou Pedido de Venda através da API! 🚀
Tópicos do Artigo:
Informações importantes
Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:
✅ Acessando a documentação: Consulte nossa documentação oficial para entender os endpoints disponíveis e seus respectivos parâmetros.
🔑 Chaves de Integração da API: Saiba como obter e utilizar suas credenciais de acesso para autenticar as requisições.
⚙️ Características e Recomendações: Fique por dentro das melhores práticas para otimizar sua experiência com a API da Omie.
🔐 Login no Portal: Para testar suas requisições no Portal do Desenvolvedor é necessário fazer login na plataforma com o mesmo e-mail e senha que você já usa no ERP. Fácil, né? 😉
🧪 Aplicativo Teste: Aprenda a criar um Aplicativo Teste gratuito e descubra, na prática, como utilizar nossas APIs e aproveitar ao máximo os nossos recursos.
💡 Dica Omie: Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.
Listando as informações para o Orçamento/Pedido
1) Para gerar o Orçamento/Pedido via API, será necessário ter em mãos algumas informações para preenchimento na requisição, como os códigos de Cliente, Produto, etapa do processo de Faturamento, Categoria, Conta Corrente e Cenário Fiscal.
Para isso, realize a listagem das informações a partir dos métodos relacionados:
Possui dúvida sobre como obter listagens via API?
Consulte este exemplo prático: Listando as informações via API
2) Localize os registros desejados nas listagens e realize validações nas seguintes tags:
Listagem de Clientes:
"codigo_cliente_omie"Listagem de Produtos:
"codigo_produto"Listagem de Etapas de Faturamento:
"cCodigo"Listagem de Categorias:
"codigo"Listagem de Contas Correntes:
"nCodCC"Listagem de Cenários Fiscais:
"nCodigo"
Essas tags contém os códigos identificadores do registro desejado, que servem como referência para consultas e para a realização de operações via API. Anote eles para prosseguir com o processo de criação do Orçamento/Pedido de Venda com esses dados!
Incluindo um Orçamento ou Pedido de Venda via API
1) Após acessar a Listagem de APIs do Developer Omie e realizar a consulta das informações que serão utilizadas em seu Orçamento/Pedido, navegue pela página e dê um duplo clique sobre o serviço "Pedidos de Venda", para acessar a documentação e listagem de métodos disponíveis para ele:
2) Para cadastrar o Orçamento/Pedido, utilize o método:
3) Após selecionar o método desejado no índice do canto direito (1), assim você será levado a parte da página com informações sobre o mesmo, contendo dados de parâmetros e requisição exemplo (2).
Para realizar um teste rápido com os parâmetros básicos, role a página até o final da requisição exemplo e clique em "Teste agora mesmo" (3):
💡 Entendendo os parâmetros
💡 Entendendo os parâmetros
Por aqui, você encontrará uma lista dos parâmetros disponíveis para sua requisição, incluindo:
Nome – Identifica a variável dentro da API.
Tipo de dado – Indica o formato esperado (integer, string, decimal, etc.)
Descrição – Explica a finalidade do parâmetro e como utilizá-lo.
Para obter mais detalhes sobre um parâmetro específico, basta passar o mouse sobre o ícone ➕, e uma explicação detalhada será exibida.
4) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:
5) Após realizar o login, você será direcionado para a tela de testes do Developer, onde poderá configurar e enviar requisições para a API. Veja como cada campo funciona:
(1) Endpoint: O Omie preencherá automaticamente este campo com:
🔗
https://app.omie.com.br/api/v1/produtos/pedido/(2) Aplicativo ou Chave de Acesso: Aqui, você verá uma lista dos aplicativos aos quais seu e-mail tem acesso. Basta selecionar o desejado, e os campos App Key e App Secret serão preenchidos automaticamente.
Caso precise testar um aplicativo que não aparece na lista, selecione "O aplicativo que eu quero não está na lista" e insira manualmente suas credenciais.
(3) Call: O Omie definirá automaticamente o tipo de chamada como IncluirPedido.
(4) Conteúdo: Este é o campo onde você configurará sua requisição, inserindo os dados necessários para cadastrar um Pedido.
6) Ajuste o preenchimento das tags "codigo_cliente", "etapa", "produto", "codigo_categoria", "codigo_conta_corrente", e demais tags desejadas, conforme o Orçamento ou Pedido de Venda que deseja criar.
A seguir, demonstraremos um exemplo de requisição:
{
"cabecalho": {
"codigo_cliente": 3792227,
"codigo_pedido_integracao": "1740660039",
"data_previsao": "27/02/2025",
"etapa": "10",
"numero_pedido": "78367",
"codigo_parcela": "999",
"quantidade_itens": 2
},
"det": [
{
"ide": {
"codigo_item_integracao": "4422421"
},
"inf_adic": {
"peso_bruto": 150,
"peso_liquido": 150
},
"produto": {
"cfop": "5.102",
"codigo_produto": "4422421",
"descricao": "Telefone Celular X",
"ncm": "9403.30.00",
"quantidade": 1,
"tipo_desconto": "V",
"unidade": "UN",
"valor_desconto": 0,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 11850365,
"consumidor_final": "S",
"enviar_email": "N"
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "28/02/2025",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "01/06/2025",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
}
}
💡 Dicas
Neste exemplo, não informamos nenhum imposto e nem a Tag
codigo_cenario_impostos. Deste modo, como não foi informado, no Orçamento/Pedido criado será assumido o Cenário Fiscal Padrão.
Para criar um Orçamento, a tag
"etapa"deve ser informada com o valor"00". Caso o recurso de geração de Orçamento de Venda de Produtos não esteja ativo em seu App, com o envio da requisição com essa informação ele será automaticamente ativado:
A tag
“numero_pedido”é gerada automaticamente pelo sistema após o envio da requisição. Apesar disso, você pode indicar um código interno para o pedido na tag"codigo_pedido_integracao".
As opções de frete são informadas na própria documentação:
7) Após enviar a requisição, o resultado será demonstrado em tela, no canto direito.
Caso todos os parâmetros tenham sido corretamente informados, você receberá uma resposta positiva sobre a inclusão.
(1) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos.
(2) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso.
(3) Corpo: é nessa parte que será exibido o retorno da requisição enviada.
8) Com o cadastro realizada, você poderá visualizar o Orçamento/Pedido em seu aplicativo:
ℹ Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.
Orçamento de Venda ("etapa:" "00")
Orçamento de Venda ("etapa:" "00")
Pedido de Venda ("etapa" com outros valores)
Pedido de Venda ("etapa" com outros valores)
💡 Precisa alterar o Orçamento/Pedido de Etapa ou faturá-lo?
Utilize os métodos abaixo:
📚 Artigos Relacionados
