Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:
💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code) |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉
Nesse artigo, temos:
Listando as etapas de venda
Antes de listar as etapas, é necessário que no seu aplicativo Omie, já tenha configurado uma coluna específica no Kanban de vendas para os orçamentos! Para isso, confira a documentação abaixo:
E marque a opção para "Permitir que o pedido de venda seja marcado como uma proposta (ou orçamento)."
Com isso feito, vamos utilizar o seguinte método: EtapasFaturamento
Localize a tag "cDescOperacao": "Venda de Produto"
, pois nela serão indicadas as etapas:
"etapas": [
{
"cCodigo": "00",
"cDescrPadrao": "Proposta",
"cDescricao": "Orçamento",
"cInativo": "S"
}
(...)
Localize a etapa de "Orçamento" e junto dela haverá também a tag "cCodigo". Guarde a informação dessa tag, pois ela será importante ao enviar o pedido e cadastrar como orçamento no Omie!
Criando o orçamento
Para cadastrar o nosso pedido de venda, vamos utilizar o seguinte método: IncluirPedido
E a seguinte requisição:
{
"cabecalho": {
"codigo_cliente": 3291990653,
"codigo_pedido_integracao": "API/XY1/Ped",
"data_previsao": "10/12/2022",
"etapa": "00",
"numero_pedido": "29996",
"codigo_parcela": "999",
"quantidade_itens": 1,
"codigo_cenario_impostos": 2163772441
},
"det": [
{
"ide": {
"codigo_item_integracao": "789456132"
},
"produto": {
"codigo_produto": 3342938591,
"quantidade": 1,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 3291672614,
"consumidor_final": "S",
"enviar_email": "N"
},
"lista_parcelas": {
"parcela": [
{
"data_vencimento": "29/07/2022",
"numero_parcela": 1,
"percentual": 50,
"valor": 100
},
{
"data_vencimento": "03/10/2022",
"numero_parcela": 2,
"percentual": 50,
"valor": 100
}
]
}
}
Observe que na tag "etapa"
foi informado o mesmo código retornado nas etapas de faturamento!
Temos um artigo explicando em detalhes todas as tags relacionadas ao método da inclusão do pedido de venda por API, que vale a pena dar uma conferida:
Ao executar a requisição, ele será cadastrado no sistema com um orçamento:
📌 Separamos alguns artigos interessantes para você: