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 😉
Para cadastrar o nosso pedido de venda, vamos utilizar o seguinte método:
E a seguinte requisição:
{
"cabecalho": {
"codigo_cliente": 5366578425,
"codigo_pedido_integracao": "API/XXXX1/Ped",
"data_previsao": "10/12/2022",
"etapa": "10",
"numero_pedido": "29996",
"codigo_parcela": "999",
"quantidade_itens": 1,
"codigo_cenario_impostos": 358070701
},
"det": [
{
"ide": {
"codigo_item_integracao": "789456132"
},
"produto": {
"codigo_produto": 5366578297,
"quantidade": 1,
"valor_unitario": 200
}
}
],
"frete": {
"modalidade": "9"
},
"informacoes_adicionais": {
"codigo_categoria": "1.01.03",
"codigo_conta_corrente": 5366579915,
"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
}
]
}
}Nessa requisição, tem alguns pontos importantes a serem observados, e compreendidos
O primeiro deles, é que informamos quem é o cliente e o produto por meio do “código_cliente” e “código_produto”, o mesmo código retornado quando cadastramos ambos, e eles podem ser consultados por aqui:
Outro ponto, é que não informamos nenhum imposto, nem mesmo a CFOP. Mas isso não foi preciso, pois todas essas informações de impostos na API são opcionais, além disso, foi informada a tag “codigo_cenario_impostos”, que já tinha os impostos do produto cadastrado aqui no sistema. Para o seu processo, verifique se a configuração do cenário fiscal foi feita para usar a tag!
A etapa do pedido, se refere em qual etapa desejamos cadastrar o nosso pedido de venda, e cada sistema vai ter a sua, por isso, é importante conferir qual a etapa do seu aplicativo:
A tag “numero_pedido”, é gerada automaticamente pelo sistema quando eu concluir a requisição. Observe que eu preenchi: 29996, mas o número do pedido retornado vai ser outro, pois a tag é preenchida automaticamente
As opções de frete são informadas na própria documentação:
Nesse caso, escolhemos a opção “sem frete”
Caso deseje utilizar um cenário fiscal, assim como as categorias, eles devem ser consultados pelos métodos de listagem:
Após executarmos a nossa requisição, esperamos obter o resultado abaixo:
{
"codigo_pedido": 5370314709,
"codigo_pedido_integracao": "API/XXXX1/Ped",
"codigo_status": "0",
"descricao_status": "Pedido cadastrado com sucesso!",
"numero_pedido": "000000000003508"
}Observe que o número do pedido retornado, foi gerado automaticamente. E aqui está o nosso pedido no sistema:
E já aproveitando o embalo, que tal faturarmos o pedido?
Para isso, utilize o seguinte método:
E a requisição é bem simples:
{
"nCodPed": 5370314709
}📌 Obs.: o faturamento do pedido vai depender das configurações feitas no seu sistema. Por isso, é bom verificar antes, para evitar erros |
📌 Separamos alguns artigos interessantes para você
