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

# Listar orçamentos (propostas comerciais)



## OpenAPI

````yaml https://erp.olist.com/public-api/v3/swagger/swagger-mintlify.json get /orcamentos
openapi: 3.0.0
info:
  title: Olist ERP API v3
  description: >-
    Documentação completa: <a href="https://api-docs.erp.olist.com"
    target="_blank">https://api-docs.erp.olist.com</a>
  version: '3.1'
servers:
  - url: https://api.tiny.com.br/public-api/v3
security: []
paths:
  /orcamentos:
    get:
      tags:
        - Orcamentos
      summary: Listar orçamentos (propostas comerciais)
      operationId: ListarOrcamentosAction
      parameters:
        - $ref: '#/components/parameters/situacaoOrcamentos'
        - $ref: '#/components/parameters/dataInicioOrcamentos'
        - $ref: '#/components/parameters/dataFimOrcamentos'
        - $ref: '#/components/parameters/consultaOrcamentos'
        - $ref: '#/components/parameters/idVendedorOrcamentos'
        - $ref: '#/components/parameters/get_orcamentos_limit'
        - $ref: '#/components/parameters/get_orcamentos_offset'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  itens:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListarOrcamentoItemModelResponse'
                  paginacao:
                    $ref: '#/components/schemas/PaginatedResultModel'
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
components:
  parameters:
    situacaoOrcamentos:
      name: situacao
      in: query
      description: >-
        Situação do orçamento. "Em aberto" retorna Rascunho + Pendente (mesmo
        comportamento da tela).

        - Aguardando - Aguardando

        - Aprovado - Aprovado

        - Concluído - Concluido

        - Em aberto - Aberto

        - Modelo - Modelo

        - Não aprovado - Nao Aprovado

        - Pendente - Pendente

        - Rascunho - Rascunho
      required: false
      schema:
        enum:
          - Aguardando
          - Aprovado
          - Concluído
          - Em aberto
          - Modelo
          - Não aprovado
          - Pendente
          - Rascunho
      x-enumDescriptions:
        - Aguardando - Aguardando
        - Aprovado - Aprovado
        - Concluído - Concluido
        - Em aberto - Aberto
        - Modelo - Modelo
        - Não aprovado - Nao Aprovado
        - Pendente - Pendente
        - Rascunho - Rascunho
    dataInicioOrcamentos:
      name: dataInicio
      in: query
      description: Data inicial do orçamento (Y-m-d)
      required: false
      schema:
        type: string
        example: '2024-01-01'
    dataFimOrcamentos:
      name: dataFim
      in: query
      description: Data final do orçamento (Y-m-d)
      required: false
      schema:
        type: string
        example: '2024-12-31'
    consultaOrcamentos:
      name: consulta
      in: query
      description: Texto para busca no nome do contato ou no número da proposta
      required: false
      schema:
        type: string
    idVendedorOrcamentos:
      name: idVendedor
      in: query
      description: ID do vendedor
      required: false
      schema:
        type: integer
        example: 1
    get_orcamentos_limit:
      name: limit
      in: query
      description: Limite da paginação
      required: false
      schema:
        type: integer
        default: 100
    get_orcamentos_offset:
      name: offset
      in: query
      description: Offset da paginação
      required: false
      schema:
        type: integer
        default: 0
  schemas:
    ListarOrcamentoItemModelResponse:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            id:
              type: integer
              nullable: true
            numeroProposta:
              type: string
              nullable: true
            situacao:
              type: string
              nullable: true
            data:
              type: string
              example: '2024-01-01'
              nullable: true
            dataProximoContato:
              type: string
              example: '2024-01-01'
              nullable: true
            contato:
              $ref: '#/components/schemas/ContatoIdRequestModel'
            nomeModelo:
              type: string
              nullable: true
            valorTotal:
              type: string
              nullable: true
          type: object
    PaginatedResultModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            limit:
              type: integer
            offset:
              type: integer
            total:
              type: integer
          type: object
    ErrorDTO:
      title: ' '
      description: ' '
      properties:
        mensagem:
          description: Mensagem de erro geral
          type: string
          example: Ocorreram erros de validação
        detalhes:
          description: Detalhes específicos do erro
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailDTO'
          example:
            - campo: codigo
              mensagem: O campo código é obrigatório
          nullable: true
      type: object
    ContatoIdRequestModel:
      title: ' '
      description: ' '
      properties:
        id:
          type: integer
          nullable: true
      type: object
    ErrorDetailDTO:
      title: ' '
      description: ' '
      properties:
        campo:
          description: Campo que gerou o erro
          type: string
          example: codigo
        mensagem:
          description: Mensagem de erro específica do campo
          type: string
          example: O campo código é obrigatório
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer

````