> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agulhao.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 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).



## OpenAPI

````yaml /api/openapi.yaml get /pedidos
openapi: 3.0.1
info:
  title: Agulhão API
  description: API do sistema Agulhão
  version: 1.0.1
  contact:
    email: contato@softros.com.br
    url: https://agulhao.com.br
servers:
  - url: https://api-integracoes.agulhao.com.br
    description: Produção
security:
  - chaveApi: []
tags:
  - name: produtos
  - name: pedidos
  - name: pessoas
  - name: tipos-lancamento
  - name: filiais
paths:
  /pedidos:
    get:
      tags:
        - pedidos
      summary: Buscar pedidos
      description: >-
        Retorna os pedidos do Agulhão. Para consultar os detalhes de um pedido
        específico, informe o parâmetro "id" ou "idExterno" (Exemplo 2).
      operationId: getPedidos
      parameters:
        - name: filialCod
          in: query
          description: Código da filial
          required: false
          schema:
            type: string
            example: '1'
        - name: clienteCod
          in: query
          description: Código do cliente
          required: false
          schema:
            type: string
            example: '1'
        - name: colecaoCod
          in: query
          description: Código da coleção
          required: false
          schema:
            type: string
            example: '1'
        - name: tipoIntervalo
          in: query
          description: >
            Tipo de intervalo para busca dos pedidos: * '1' - Data emissão * '2'
            - Data fechamento
          required: false
          schema:
            type: string
            enum:
              - '1'
              - '2'
        - name: dataInicial
          in: query
          description: Data inicial do intervalo (formato dd/MM/yyyy)
          required: false
          schema:
            type: string
            example: 01/01/2025
        - name: dataFinal
          in: query
          description: Data final do intervalo (formato dd/MM/yyyy)
          required: false
          schema:
            type: string
            example: 31/01/2025
        - name: pagina
          in: query
          description: Página atual da busca
          required: false
          schema:
            type: string
            default: '1'
        - name: qtdePorPagina
          in: query
          description: Quantidade de usuários por página
          required: false
          schema:
            type: string
            default: '100'
        - name: tipoPedido
          in: query
          description: >-
            Tipo do pedido (se não informado, por padrão será retornando somente
            pedidos que são do tipo "Venda"
          required: false
          schema:
            type: string
            enum:
              - VB
              - VE
              - CM
              - TD
        - name: ordemCompra
          in: query
          description: Ordem de compra (quando informado o filtro "tipoPedido" é ignorado)
          required: false
          schema:
            type: string
        - name: id
          in: query
          description: ID interno do agulhão
          required: false
          schema:
            type: string
        - name: idExterno
          in: query
          description: Identificador único do pedido na integração (seu id)
          required: false
          schema:
            type: string
        - name: ultimaAtualizacao
          in: query
          description: Data da última atualização dos produtos (formato ISO 8601)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      filialCod:
                        type: integer
                      pedidoId:
                        type: integer
                      pedidoDataEmissao:
                        type: string
                      pedidoDataFechamento:
                        type: string
                      pedidoPrevisaoEntrega:
                        type: string
                      ultimaAtualizacao:
                        type: string
                      pedidoSaidaStatus:
                        type: string
                      clienteCod:
                        type: integer
                      clienteNome:
                        type: string
                      clienteCidade:
                        type: string
                      clienteUf:
                        type: string
                      vendedorCod:
                        type: integer
                      vendedorNome:
                        type: string
                      valorLiquido:
                        type: number
                      totalPecas:
                        type: number
                      ordemCompra:
                        type: string
                  - type: object
                    properties:
                      id:
                        type: integer
                        description: ID do pedido no Agulhão
                      idExterno:
                        type: string
                        description: ID do pedido na integração
                      integracao:
                        type: integer
                        description: ID da integração
                      linkCompartilhavel:
                        type: string
                      ordemCompra:
                        type: string
                      tipo:
                        type: string
                      descontoDinheiro:
                        type: number
                      valorFrete:
                        type: number
                      observacoes:
                        type: string
                      valorOutros:
                        type: number
                      valorLiquido:
                        type: number
                      valorBruto:
                        type: number
                      status:
                        type: string
                      previsaoEntrega:
                        type: string
                      cliente:
                        type: object
                        properties:
                          id:
                            type: integer
                          documento:
                            type: string
                          nome:
                            type: string
                      entrega:
                        type: object
                        properties:
                          logradouro:
                            type: string
                          complemento:
                            type: string
                          numero:
                            type: string
                          cep:
                            type: string
                          bairro:
                            type: string
                          cidade:
                            type: string
                          uf:
                            type: string
                          ibgeCidade:
                            type: integer
                      produtos:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            idGrade:
                              type: integer
                            quantidade:
                              type: number
                            valorUnitario:
                              type: number
                            referencia:
                              type: string
                            descricao:
                              type: string
                            corNome:
                              type: string
                            cor:
                              type: string
                      pagamentos:
                        type: array
                        items:
                          type: object
                          properties:
                            valor:
                              type: number
                            descricao:
                              type: string
                      duplicatas:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            valor:
                              type: number
                            vencimento:
                              type: string
                            boletoUrl:
                              type: string
                            saldo:
                              type: number
                            status:
                              type: string
                            codigoBarras:
                              type: string
                      ultimaAtualizacao:
                        type: string
                      emissao:
                        type: string
                      fechamento:
                        type: string
                      danfeUrl:
                        type: string
                      xmlNfeUrl:
                        type: string
              examples:
                '1':
                  summary: Retorno da lista de pedidos
                  value:
                    - 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>
                '2':
                  summary: Retorno do pedido detalhado
                  value:
                    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
          headers: {}
      deprecated: false
      security:
        - chaveApi: []
components:
  securitySchemes:
    chaveApi:
      description: Chave da API gerada no agulhão
      type: apiKey
      name: x-api-key
      in: header

````