Skip to main content
POST
/
corridas
/
consultar
Consultar corridas
curl --request POST \
  --url https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "pagina": 123,
  "limite": 123,
  "condutor_id": 123,
  "empresa_id": 123,
  "cliente_id": 123,
  "obter_filiais": true,
  "data_hora_solicitacao_min": "2023-11-07T05:31:56Z",
  "data_hora_solicitacao_max": "2023-11-07T05:31:56Z"
}
'
{
  "success": true,
  "data": [
    {
      "id": "100018001",
      "data_hora_solicitacao": "2024-05-02 08:53:42",
      "data_hora_chegada_local": null,
      "status_solicitacao": "N",
      "cliente_id": "83605",
      "nome_passageiro": "Rogério Barreto",
      "empresa_id": null,
      "bandeira_chamada_id": "8",
      "data_hora_aceite": null,
      "data_hora_finalizacao": null,
      "data_hora_cancelamento": null,
      "data_hora_pendencia": "2024-05-02 08:53:49",
      "distancia_coleta_km": null,
      "valor_corrida": "7.00",
      "condutor_especificado": false,
      "com_retorno": false,
      "condutor_id": "",
      "nome_condutor": "",
      "telefone_condutor": "",
      "veiculo": "",
      "placa_veiculo": "",
      "cor_veiculo": null,
      "duracao_corrida": "0",
      "distancia_percorrida_km": "0",
      "taxas_cancelamento": null,
      "paradas": []
    },
    {
      "id": "100018035",
      "data_hora_solicitacao": "2024-05-03 09:36:44",
      "data_hora_chegada_local": null,
      "status_solicitacao": "N",
      "cliente_id": "83316",
      "nome_passageiro": "Maria Andreia",
      "bandeira_chamada_id": "8",
      "data_hora_aceite": null,
      "data_hora_finalizacao": null,
      "data_hora_cancelamento": null,
      "data_hora_pendencia": "2024-05-03 09:36:45",
      "distancia_coleta_km": null,
      "valor_corrida": "10.50",
      "condutor_especificado": false,
      "com_retorno": false,
      "condutor_id": "",
      "nome_condutor": "",
      "telefone_condutor": "",
      "veiculo": "",
      "placa_veiculo": "",
      "cor_veiculo": null,
      "duracao_corrida": "0",
      "distancia_percorrida_km": "0",
      "taxas_cancelamento": null,
      "partida": {
        "endereco": "Rua Altaneira",
        "complemento": null,
        "referencia": null,
        "bairro": "Campo Grande",
        "cidade": "Rio de Janeiro",
        "estado": "RJ",
        "lat": "-22.8743056",
        "lng": "-43.5626744"
      },
      "paradas": [
        {
          "id": "896",
          "endereco": "Praia do Arpoador",
          "complemento": "",
          "bairro": "Arpoador",
          "cidade": "Rio de Janeiro",
          "uf": "RJ",
          "lat": "-22.988420900610592",
          "lng": "-43.1934916318077",
          "ordem": 0,
          "numero_pedido": "2"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

​
api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
​
pagina
integer

Página da listagem.

​
limite
integer

Quantidade de registros por página.

​
condutor_id
integer

Filtra por condutor.

​
empresa_id
integer

Filtra por empresa.

​
cliente_id
integer

Filtra por cliente.

​
obter_filiais
boolean

Inclui corridas de filiais quando permitido.

​
data_hora_solicitacao_min
string<date-time>

Início do intervalo em formato ISO 8601.

​
data_hora_solicitacao_max
string<date-time>

Fim do intervalo em formato ISO 8601.

​
status_solicitacao
enum<string>

Status da corrida. Caso não seja informado, todos serão considerados. Valores aceitos: Redistribuindo (T), Aguardando pagamento (R), Não atendida (N), Distribuindo (D), Em espera (S), Cancelada (C), Finalizada (F), Em andamento (E), Pendente (P), Aceita (A), Aguardando aceite (G), Agrupada (U).

Available options:
T,
R,
N,
D,
S,
C,
F,
E,
P,
A,
G,
U
​
tipo_pagamento
enum<string>

Tipo de pagamento selecionado pelo cliente. Caso não seja informado, todos serão considerado. Valores aceitos: Dinheiro (D), Débito (máquina) (B), Crédito máquina (C), eTicket (T), Voucher (V), Pix (X), Picpay (P), Whatsapp (H), Cartão via app (A), Faturado (F), Pix via app (I), Carteira de créditos (R).

Available options:
D,
B,
C,
T,
V,
X,
P,
H,
A,
F,
I,
R

Response

200 - application/json

Sucesso

The response is of type object.