Skip to main content
GET
/
v1
/
order
/
paged
Listar pedidos paginados.
curl --request GET \
  --url https://api.staging.cartaosimples.com.br/integration/v1/order/paged \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Query Parameters

​
status
integer<int32>

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
​
documentoCliente
string

CPF do cliente (somente números). Campo opcional.

Example:

"12345678901"

​
dataInicio
string<date-time>

Data de início do filtro no formato ISO-8601. Campo opcional.

Example:

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

​
dataFim
string<date-time>

Data de fim do filtro no formato ISO-8601. Campo opcional.

Example:

"2025-12-31T23:59:59-03:00"

​
numero
integer<int64>

Número do pedido. Campo opcional.

Example:

1001

​
documentoLoja
string

CNPJ do estabelecimento (somente números). Campo opcional.

Example:

"12345678000195"

​
descricao
string

Filtrar por descrição do pedido. Campo opcional.

​
pagina
integer<int32>

Número da página. Padrão: 1.

Example:

1

​
tamanhoPagina
integer<int32>

Quantidade de itens por página. Padrão: 10.

Example:

10

Response

OK

​
items
object[]
read-only
​
page
object