Skip to main content
GET
/
pedidos
Retorna pedidos
curl --request GET \
  --url https://api-integracoes.agulhao.com.br/pedidos \
  --header 'x-api-key: <api-key>'
[
  {
    "filialCod": 1,
    "pedidoId": 1,
    "pedidoDataEmissao": "2025-01-01T00:00:00",
    "pedidoDataFechamento": "2025-01-01T00:00:00",
    "pedidoPrevisaoEntrega": "2025-01-01T00:00:00",
    "pedidoSaidaStatus": "Digitando",
    "clienteCod": 1,
    "clienteNome": "Nome do Cliente",
    "clienteCidade": "São Paulo",
    "clienteUf": "SP",
    "vendedorCod": 1,
    "vendedorNome": "Nome do Vendedor",
    "valorLiquido": 1000,
    "totalPecas": 10
  }
]

Authorizations

​
x-api-key
string
header
required

Chave da API gerada no agulhão

Query Parameters

​
filialCod
string

Código da filial

Example:

"1"

​
clienteCod
string

Código do cliente

Example:

"1"

​
colecaoCod
string

Código da coleção

Example:

"1"

​
tipoIntervalo
enum<string>

Tipo de intervalo para busca dos pedidos: * '1' - Data emissão * '2' - Data fechamento

Available options:
1,
2
​
dataInicial
string

Data inicial do intervalo (formato dd/MM/yyyy)

Example:

"01/01/2025"

​
dataFinal
string

Data final do intervalo (formato dd/MM/yyyy)

Example:

"31/01/2025"

​
pagina
string
default:1

Página atual da busca

​
qtdePorPagina
string
default:100

Quantidade de usuários por página

Response

200 - application/json

Sucesso

​
filialCod
number

Código da filial

Example:

1

​
pedidoId
number

Identificador único do pedido

Example:

1

​
pedidoDataEmissao
string<date-time>

Data de emissão do pedido

Example:

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

​
pedidoDataFechamento
string<date-time>

Data de emissão do pedido

Example:

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

​
pedidoPrevisaoEntrega
string<date-time>

Data de emissão do pedido

Example:

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

​
pedidoSaidaStatus
enum<string>

Status do pedido

Available options:
Digitando,
Analisando,
Aprovando,
Aguardando data envio,
PCP/Produzindo,
Separando,
Conferindo,
Faturando,
Despachado,
Cancelado
Example:

"Digitando"

​
clienteCod
number

Código do cliente

Example:

1

​
clienteNome
string

Nome do cliente

Example:

"Nome do Cliente"

​
clienteCidade
string

Cidade do cliente

Example:

"São Paulo"

​
clienteUf
string

UF do cliente

Example:

"SP"

​
vendedorCod
number

Código do vendedor

Example:

1

​
vendedorNome
string

Nome do vendedor

Example:

"Nome do Vendedor"

​
valorLiquido
number<float>

Valor líquido do pedido

Example:

1000

​
totalPecas
number<float>

Total de peças no pedido

Example:

10