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"
}
'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar"
payload = {
"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"
}
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar"
payload := strings.NewReader("{\n \"pagina\": 123,\n \"limite\": 123,\n \"condutor_id\": 123,\n \"empresa_id\": 123,\n \"cliente_id\": 123,\n \"obter_filiais\": true,\n \"data_hora_solicitacao_min\": \"2023-11-07T05:31:56Z\",\n \"data_hora_solicitacao_max\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pagina\": 123,\n \"limite\": 123,\n \"condutor_id\": 123,\n \"empresa_id\": 123,\n \"cliente_id\": 123,\n \"obter_filiais\": true,\n \"data_hora_solicitacao_min\": \"2023-11-07T05:31:56Z\",\n \"data_hora_solicitacao_max\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pagina\": 123,\n \"limite\": 123,\n \"condutor_id\": 123,\n \"empresa_id\": 123,\n \"cliente_id\": 123,\n \"obter_filiais\": true,\n \"data_hora_solicitacao_min\": \"2023-11-07T05:31:56Z\",\n \"data_hora_solicitacao_max\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "100018001",
"data_hora_solicitacao": "2024-05-02 08:53:42",
"data_hora_solicitacao_utc": "2024-05-02T11:53:42Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": 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_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-02 08:53:49",
"data_hora_pendencia_utc": "2024-05-02T11:53:49Z",
"distancia_coleta_km": null,
"valor_corrida": "7.00",
"valor_corrida_integral": "10.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_solicitacao_utc": "2024-05-03T12:36:44Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": null,
"status_solicitacao": "N",
"cliente_id": "83316",
"nome_passageiro": "Maria Andreia",
"bandeira_chamada_id": "8",
"data_hora_aceite": null,
"data_hora_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-03 09:36:45",
"data_hora_pendencia_utc": "2024-05-03T12:36:45Z",
"distancia_coleta_km": null,
"valor_corrida": "10.50",
"valor_corrida_integral": "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",
"data_hora_inicio": null,
"tipo_pagamento": "D",
"desconto": "0.00",
"tarifa": "Tarifa padrão",
"id_categoria": "71",
"categoria": "Comum",
"descricao_categoria": "Viagens curtas-médias",
"nome_cliente": "Maria Andreia",
"cpf_cliente": "111.222.333-44",
"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"
}
]
}
]
}Corridas
Consultar corridas
Retorna as solicitações da central conforme os filtros informados. O intervalo máximo aceito entre data_hora_solicitacao_min e data_hora_solicitacao_max é de 30 dias. Para acessar este endpoint, o usuário precisa ter a permissão API - Corrida.
O campo valor_corrida traz o valor já líquido, com o desconto do cupom aplicado, e valor_corrida_integral traz o valor bruto da corrida, antes do desconto. Sem cupom aplicado, os dois campos são iguais.
O bloco desejado traz o endereço de destino (endereco, bairro, cidade, estado, lat e lng) e vem null quando a corrida não tem destino definido.
Os campos de data e hora data_hora_solicitacao, data_hora_chegada_local, data_hora_aceite, data_hora_finalizacao, data_hora_cancelamento e data_hora_pendencia continuam no horário da central e no formato AAAA-MM-DD HH:MM:SS. Cada um deles ganhou uma cópia com o sufixo _utc (por exemplo, data_hora_aceite_utc), em ISO 8601 e em UTC (por exemplo, 2023-11-07T05:31:56Z), que vem null quando o original vem null.
Cada corrida da lista traz também, na raiz, os dados de fechamento que antes só vinham no recibo, em qualquer status:
data_hora_inicio: início da corrida (nullenquanto não iniciou), em ISO 8601 e em UTC (por exemplo,2023-11-07T05:31:56Z);tipo_pagamento;desconto: percentual de desconto (0.00quando não há);tarifa,id_categoria,categoriaedescricao_categoria;nome_cliente;cpf_cliente: só quando a corrida não é corporativa (semempresa_id);cnpj_cpf_empresa: só quando a corrida é corporativa (comempresa_id);codigo_cupomegerador_cupom_id: só quando a corrida usou cupom.
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"
}
'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar"
payload = {
"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"
}
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar"
payload := strings.NewReader("{\n \"pagina\": 123,\n \"limite\": 123,\n \"condutor_id\": 123,\n \"empresa_id\": 123,\n \"cliente_id\": 123,\n \"obter_filiais\": true,\n \"data_hora_solicitacao_min\": \"2023-11-07T05:31:56Z\",\n \"data_hora_solicitacao_max\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pagina\": 123,\n \"limite\": 123,\n \"condutor_id\": 123,\n \"empresa_id\": 123,\n \"cliente_id\": 123,\n \"obter_filiais\": true,\n \"data_hora_solicitacao_min\": \"2023-11-07T05:31:56Z\",\n \"data_hora_solicitacao_max\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-vendas.taximachine.com.br/api/v2/integracao/corridas/consultar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pagina\": 123,\n \"limite\": 123,\n \"condutor_id\": 123,\n \"empresa_id\": 123,\n \"cliente_id\": 123,\n \"obter_filiais\": true,\n \"data_hora_solicitacao_min\": \"2023-11-07T05:31:56Z\",\n \"data_hora_solicitacao_max\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "100018001",
"data_hora_solicitacao": "2024-05-02 08:53:42",
"data_hora_solicitacao_utc": "2024-05-02T11:53:42Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": 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_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-02 08:53:49",
"data_hora_pendencia_utc": "2024-05-02T11:53:49Z",
"distancia_coleta_km": null,
"valor_corrida": "7.00",
"valor_corrida_integral": "10.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_solicitacao_utc": "2024-05-03T12:36:44Z",
"data_hora_chegada_local": null,
"data_hora_chegada_local_utc": null,
"status_solicitacao": "N",
"cliente_id": "83316",
"nome_passageiro": "Maria Andreia",
"bandeira_chamada_id": "8",
"data_hora_aceite": null,
"data_hora_aceite_utc": null,
"data_hora_finalizacao": null,
"data_hora_finalizacao_utc": null,
"data_hora_cancelamento": null,
"data_hora_cancelamento_utc": null,
"data_hora_pendencia": "2024-05-03 09:36:45",
"data_hora_pendencia_utc": "2024-05-03T12:36:45Z",
"distancia_coleta_km": null,
"valor_corrida": "10.50",
"valor_corrida_integral": "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",
"data_hora_inicio": null,
"tipo_pagamento": "D",
"desconto": "0.00",
"tarifa": "Tarifa padrão",
"id_categoria": "71",
"categoria": "Comum",
"descricao_categoria": "Viagens curtas-médias",
"nome_cliente": "Maria Andreia",
"cpf_cliente": "111.222.333-44",
"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
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Obrigatório. Sua chave API.
Body
application/json
Página da listagem.
Quantidade de registros por página.
Filtra por condutor.
Filtra por empresa.
Filtra por cliente.
Inclui corridas de filiais quando permitido.
Início do intervalo em formato ISO 8601.
Fim do intervalo em formato ISO 8601.
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 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.