Skip to main content
GET
/
v1
/
order
/
{orderId}
Obter pedido.
curl --request GET \
  --url https://api.staging.cartaosimples.com.br/integration/v1/order/{orderId} \
  --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

Path Parameters

​
orderId
string<uuid>
required

Identificador único do pedido.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

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