curl --request GET \
--url https://api-integracoes.agulhao.com.br/pedidos \
--header 'x-api-key: <api-key>'{
"id": "1",
"idExterno": "4560a17a-ea59-4c4b-a2a4-78610dd04d4a",
"descontoDinheiro": 10,
"valorFrete": 15,
"valorOutros": 5,
"valorBruto": 100,
"valorLiquido": 90,
"observacoes": "Observações do pedido",
"status": "pendente",
"cliente": {
"documento": "00000000000000",
"nome": "Nome do Cliente"
},
"entrega": {
"logradouro": "Avenida Paulista",
"complemento": "Apto 101",
"numero": "1000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"uf": "SP",
"ibgeCidade": "3550308"
},
"danfeUrl": "https://api.agulhao.com.br/danfe/1234567890.pdf",
"xmlNfeUrl": "https://api.agulhao.com.br/xml/1234567890.xml",
"previsaoEntrega": "2025-01-01T00:00:00",
"ultimaAtualizacao": "2025-01-01T00:00:00",
"fechamento": "2025-01-02T00:00:00",
"pagamentos": [
{
"descricao": "Dinheiro",
"valor": 100
}
],
"produtos": [
{
"id": 1,
"idGrade": 1,
"quantidade": 1,
"valorUnitario": 100
}
]
}{
"mensagem": "Parâmetros inválidos. Verifique os dados enviados.",
"tecnico": "Erro ao validar os dados do pedido."
}{
"mensagem": "Pedido não encontrado.",
"tecnico": "Erro ao buscar o pedido no banco de dados."
}{
"mensagem": "Erro ao recuperar o pedido.",
"tecnico": "Erro ao buscar o pedido no banco de dados."
}Retorna pedido
Retorna pedido específico
curl --request GET \
--url https://api-integracoes.agulhao.com.br/pedidos \
--header 'x-api-key: <api-key>'{
"id": "1",
"idExterno": "4560a17a-ea59-4c4b-a2a4-78610dd04d4a",
"descontoDinheiro": 10,
"valorFrete": 15,
"valorOutros": 5,
"valorBruto": 100,
"valorLiquido": 90,
"observacoes": "Observações do pedido",
"status": "pendente",
"cliente": {
"documento": "00000000000000",
"nome": "Nome do Cliente"
},
"entrega": {
"logradouro": "Avenida Paulista",
"complemento": "Apto 101",
"numero": "1000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"uf": "SP",
"ibgeCidade": "3550308"
},
"danfeUrl": "https://api.agulhao.com.br/danfe/1234567890.pdf",
"xmlNfeUrl": "https://api.agulhao.com.br/xml/1234567890.xml",
"previsaoEntrega": "2025-01-01T00:00:00",
"ultimaAtualizacao": "2025-01-01T00:00:00",
"fechamento": "2025-01-02T00:00:00",
"pagamentos": [
{
"descricao": "Dinheiro",
"valor": 100
}
],
"produtos": [
{
"id": 1,
"idGrade": 1,
"quantidade": 1,
"valorUnitario": 100
}
]
}{
"mensagem": "Parâmetros inválidos. Verifique os dados enviados.",
"tecnico": "Erro ao validar os dados do pedido."
}{
"mensagem": "Pedido não encontrado.",
"tecnico": "Erro ao buscar o pedido no banco de dados."
}{
"mensagem": "Erro ao recuperar o pedido.",
"tecnico": "Erro ao buscar o pedido no banco de dados."
}Authorizations
Chave da API gerada no agulhão
Query Parameters
Identificador único do pedido
"1"
Identificador único do pedido na integração (seu id)
"4560a17a-ea59-4c4b-a2a4-78610dd04d4a"
Response
Sucesso
Identificador único do pedido no Agulhão
"1"
Identificador único do pedido na integração (seu id)
"4560a17a-ea59-4c4b-a2a4-78610dd04d4a"
Desconto em dinheiro aplicado ao pedido
10
Valor do frete
15
Valor de outros custos adicionais do pedido
5
Valor bruto do pedido (sem descontos)
100
Valor líquido do pedido (com descontos)
90
Observações do pedido
"Observações do pedido"
Status do pedido
"pendente"
"aguardandoDataEnvio"
"aprovando"
"produzindo"
"separando"
"faturando"
"finalizado"
"cancelado"
"conferindo"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
URL do DANFE (Documento Auxiliar da Nota Fiscal Eletrônica)
"https://api.agulhao.com.br/danfe/1234567890.pdf"
URL do XML da Nota Fiscal Eletrônica
"https://api.agulhao.com.br/xml/1234567890.xml"
Data prevista para entrega do pedido
"2025-01-01T00:00:00"
Data da última atualização do pedido
"2025-01-01T00:00:00"
Data de fechamento do pedido
"2025-01-02T00:00:00"
Show child attributes
Show child attributes
Show child attributes
Show child attributes