Skip to main content
GET
/
v1
/
order
/
list
Listar pedidos.
curl --request GET \
  --url https://api.staging.cartaosimples.com.br/integration/v1/order/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "numero": 123,
    "status": "<string>",
    "total": 123,
    "nomeCliente": "<string>",
    "documentoCliente": "<string>",
    "prazo": 123,
    "razaoSocialEstabelecimento": "<string>",
    "documentoEstabelecimento": "<string>",
    "descricao": "<string>",
    "valorAprovado": 123,
    "desembolsado": true,
    "criadoEm": "2023-11-07T05:31:56Z",
    "desembolsadoEm": "2023-11-07T05:31:56Z",
    "valorSolicitado": 123
  }
]

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.

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
string

Filtrar por status do pedido. Campo opcional.

​
customerId
string<uuid>

Identificador do cliente. Campo opcional.

​
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

​
estabelecimentoId
string<uuid>

Identificador do estabelecimento. Campo opcional.

​
descricao
string

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

Response

OK

​
id
string<uuid>
​
numero
integer<int64>
​
status
string | null
​
total
number<double> | null
​
nomeCliente
string | null
​
documentoCliente
string | null
​
prazo
integer<int32> | null
​
razaoSocialEstabelecimento
string | null
​
documentoEstabelecimento
string | null
​
descricao
string | null
​
valorAprovado
number<double> | null
​
desembolsado
boolean | null
​
criadoEm
string<date-time>
​
desembolsadoEm
string<date-time> | null
​
valorSolicitado
number<double> | null