Retorna pedido

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": "<string>",
  "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
    }
  ]
}

GET

pedidos

Retorna pedido

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": "<string>",
  "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
    }
  ]
}

Authorizations

x-api-key

string

header

required

Chave da API gerada no agulhão

Query Parameters

string

Identificador único do pedido

Example:

"1"

idExterno

string

Identificador único do pedido na integração (seu id)

Example:

"4560a17a-ea59-4c4b-a2a4-78610dd04d4a"

Response

Sucesso

string

Identificador único do pedido no Agulhão

Example:

"1"

idExterno

string

Identificador único do pedido na integração (seu id)

Example:

"4560a17a-ea59-4c4b-a2a4-78610dd04d4a"

descontoDinheiro

number<float>

Desconto em dinheiro aplicado ao pedido

Example:

10

valorFrete

number<float>

Valor do frete

Example:

15

valorOutros

number<float>

Valor de outros custos adicionais do pedido

Example:

5

valorBruto

number<float>

Valor bruto do pedido (sem descontos)

Example:

100

valorLiquido

number<float>

Valor líquido do pedido (com descontos)

Example:

90

observacoes

string

Observações do pedido

Example:

"Observações do pedido"

status

string

Status do pedido

cliente

object

Show child attributes

cliente.documento

string

CNPJ ou CPF do cliente

Example:

"00000000000000"

cliente.nome

string

Nome do cliente

Example:

"Nome do Cliente"

entrega

object

Show child attributes

entrega.logradouro

string

Logradouro do endereço de entrega

Example:

"Avenida Paulista"

entrega.complemento

string

Complemento do endereço de entrega

Example:

"Apto 101"

entrega.numero

string

Número do endereço de entrega

Example:

"1000"

entrega.bairro

string

Bairro do endereço de entrega

Example:

"Bela Vista"

entrega.cidade

string

Nome da cidade do endereço de entrega

Example:

"São Paulo"

entrega.uf

string

Sigla da unidade federativa do endereço de entrega

Example:

"SP"

entrega.ibgeCidade

string

Código IBGE da cidade do endereço de entrega

Example:

"3550308"

danfeUrl

string

URL do DANFE (Documento Auxiliar da Nota Fiscal Eletrônica)

Example:

"https://api.agulhao.com.br/danfe/1234567890.pdf"

xmlNfeUrl

string

URL do XML da Nota Fiscal Eletrônica

Example:

"https://api.agulhao.com.br/xml/1234567890.xml"

previsaoEntrega

string<date-time>

Data prevista para entrega do pedido

Example:

"2025-01-01T00:00:00"

ultimaAtualizacao

string<date-time>

Data da última atualização do pedido

Example:

"2025-01-01T00:00:00"

fechamento

string<date-time>

Data de fechamento do pedido

Example:

"2025-01-02T00:00:00"

pagamentos

object[]

Show child attributes

pagamentos.descricao

string

Descrição do pagamento

Example:

"Dinheiro"

pagamentos.valor

number<float>

Valor do pagamento

Example:

100

produtos

object[]

Show child attributes

produtos.id

number<integer>

Identificador único do produto

Example:

1

produtos.idGrade

number<integer>

Identificador único da grade do produto

Example:

1

produtos.quantidade

number<integer>

Quantidade do produto no pedido

Example:

1

produtos.valorUnitario

number<float>

Valor unitário do produto no pedido

Example:

100

Retorna produtos Cria um novo pedido

⌘I

produtos-bt

pedidos-bt

pessoas-bt

tipos-lancamento-bt

filiais-bt

Retorna pedido

Authorizations

Query Parameters

Response