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

# Listar pedidos paginados

> Retorna uma lista paginada de pedidos do parceiro com filtros opcionais.



## OpenAPI

````yaml GET /v1/order/paged
openapi: 3.0.1
info:
  title: WebIntegration
  description: Este documento descreve os endpoints disponíveis da API.
  version: '1.0'
servers:
  - url: https://api.staging.cartaosimples.com.br/integration
    description: Servidor para o ambiente de staging
security:
  - bearerAuth: []
paths:
  /v1/order/paged:
    get:
      tags:
        - Pedido
      summary: Listar pedidos paginados.
      description: Retorna uma lista paginada de pedidos do parceiro com filtros opcionais.
      operationId: pagedOrders
      parameters:
        - name: status
          in: query
          description: |
            Filtrar por status do pedido. Campo opcional.

            Valores possíveis:
            - 0 - Indefinido
            - 1 - Em análise
            - 2 - Aprovado
            - 3 - Saldo indisponível
            - 4 - Análise expirada
            - 5 - Pagamento pendente
            - 6 - Biometria recusada
            - 7 - Biometria aprovada
            - 8 - Pagamento recusado
            - 9 - Comprado
            - 10 - Não autorizado
            - 11 - Autorização pendente
            - 12 - Aguardando cadastro
            - 13 - Venda não iniciada
            - 14 - Cancelado
            - 15 - Faturamento
            - 16 - Concluído
            - 17 - Congelado
            - 18 - Confirmação de pagamento pendente
          schema:
            type: integer
            format: int32
        - name: documentoCliente
          in: query
          description: CPF do cliente (somente números). Campo opcional.
          schema:
            type: string
            example: '12345678901'
          example: '12345678901'
        - name: dataInicio
          in: query
          description: Data de início do filtro no formato ISO-8601. Campo opcional.
          schema:
            type: string
            format: date-time
            example: '2025-01-01T00:00:00-03:00'
          example: '2025-01-01T00:00:00-03:00'
        - name: dataFim
          in: query
          description: Data de fim do filtro no formato ISO-8601. Campo opcional.
          schema:
            type: string
            format: date-time
            example: '2025-12-31T23:59:59-03:00'
          example: '2025-12-31T23:59:59-03:00'
        - name: numero
          in: query
          description: Número do pedido. Campo opcional.
          schema:
            type: integer
            format: int64
            example: 1001
          example: 1001
        - name: documentoLoja
          in: query
          description: CNPJ do estabelecimento (somente números). Campo opcional.
          schema:
            type: string
            example: '12345678000195'
          example: '12345678000195'
        - name: descricao
          in: query
          description: Filtrar por descrição do pedido. Campo opcional.
          schema:
            type: string
        - name: pagina
          in: query
          description: 'Número da página. Padrão: 1.'
          schema:
            type: integer
            format: int32
            example: 1
          example: 1
        - name: tamanhoPagina
          in: query
          description: 'Quantidade de itens por página. Padrão: 10.'
          schema:
            type: integer
            format: int32
            example: 10
          example: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Core.Domain.Primitives.IPagedResult_OrderIntegrationResponse
              example:
                items:
                  - id: 3c90c3cc-0d44-4b50-8888-8dd25736052a
                    numero: 1001
                    status:
                      valor: 2
                      descricao: Aprovado
                    total: 1500
                    nomeCliente: João da Silva
                    documentoCliente: '12345678901'
                    prazo: 12
                    razaoSocialEstabelecimento: Loja Exemplo LTDA
                    documentoEstabelecimento: '12345678000195'
                    descricao: Compra de eletrônicos
                    valorAprovado: 1500
                    desembolsado: true
                    criadoEm: '2025-01-15T10:30:00-03:00'
                    desembolsadoEm: '2025-01-16T09:00:00-03:00'
                    valorSolicitado: 1500
                page:
                  temProxima: true
                  temAnterior: false
                  numero: 1
                  tamanho: 10
                  total: 42
                  numeroPaginaMaximo: 5
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '500':
          description: Internal Server Error
components:
  schemas:
    Core.Domain.Primitives.IPagedResult_OrderIntegrationResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/Integration.Shared.Responses.Order.OrderIntegrationResponse
          readOnly: true
        page:
          $ref: '#/components/schemas/Core.Domain.Primitives.Page'
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        tipo:
          type: string
          nullable: true
        titulo:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detalhe:
          type: string
          nullable: true
        instancia:
          type: string
          nullable: true
      example:
        tipo: https://tools.ietf.org/html/rfc7231#section-6.5.1
        titulo: Requisição inválida.
        status: 400
        detalhe: O campo 'cpf' é obrigatório.
        instancia: /v1/order
    Integration.Shared.Responses.Order.OrderIntegrationResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        numero:
          type: integer
          format: int64
        status:
          $ref: '#/components/schemas/Integration.Shared.Responses.Order.OrderStatus'
        total:
          type: number
          format: double
          nullable: true
        nomeCliente:
          type: string
          nullable: true
        documentoCliente:
          type: string
        prazo:
          type: integer
          format: int32
          nullable: true
        razaoSocialEstabelecimento:
          type: string
        documentoEstabelecimento:
          type: string
        descricao:
          type: string
          nullable: true
        valorAprovado:
          type: number
          format: double
          nullable: true
        desembolsado:
          type: boolean
          nullable: true
        criadoEm:
          type: string
          format: date-time
        desembolsadoEm:
          type: string
          format: date-time
          nullable: true
        valorSolicitado:
          type: number
          format: double
          nullable: true
      additionalProperties: false
    Core.Domain.Primitives.Page:
      type: object
      properties:
        temProxima:
          type: boolean
        temAnterior:
          type: boolean
        numero:
          type: integer
          format: int32
        tamanho:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        numeroPaginaMaximo:
          type: integer
          format: int32
      additionalProperties: false
    Integration.Shared.Responses.Order.OrderStatus:
      type: object
      description: >
        Status do pedido. Consulte a legenda completa em [Webhooks → Legenda do
        EnumStatus](/webhooks).
      properties:
        valor:
          type: integer
          format: int32
        descricao:
          type: string
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <token>` onde
        `<token>` é seu TOKEN de autenticação

````