Buscar pedidos

Retorna os pedidos do Agulhão. Para consultar os detalhes de um pedido específico, informe o parâmetro “id” ou “idExterno” (Exemplo 2).

GET /pedidos

Buscar pedidos

cURL

curl --request GET \
  --url https://api-integracoes.agulhao.com.br/pedidos \
  --header 'x-api-key: <api-key>'

200

1

[
  {
    "filialCod": 123,
    "pedidoId": 123,
    "pedidoDataEmissao": "2023-11-07T05:31:56Z",
    "pedidoDataFechamento": "2023-11-07T05:31:56Z",
    "pedidoPrevisaoEntrega": "2023-11-07T05:31:56Z",
    "clienteCod": 123,
    "clienteNome": "<string>",
    "clienteCidade": "<string>",
    "clienteUf": "<string>",
    "vendedorCod": 123,
    "vendedorNome": "<string>",
    "valorLiquido": 123,
    "ultimaAtualizacao": "<string>",
    "totalPecas": 123,
    "ordemCompra": "<string>"
  }
]

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

tipoPedido · enum<string>

Tipo do pedido (se não informado, por padrão será retornando somente pedidos que são do tipo "Venda"

Available options: VB, VE, CM, TD

ordemCompra · string

Ordem de compra (quando informado o filtro "tipoPedido" é ignorado)

id · string

ID interno do agulhão

idExterno · string

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

Response

200 - application/json

Sucesso

Option 1

Option 2

filialCod · integer

pedidoId · integer

pedidoDataEmissao · string

pedidoDataFechamento · string

pedidoPrevisaoEntrega · string

ultimaAtualizacao · string

pedidoSaidaStatus · string

clienteCod · integer

clienteNome · string

clienteCidade · string

clienteUf · string

vendedorCod · integer

vendedorNome · string

valorLiquido · number

totalPecas · number

ordemCompra · string