Obter solicitações

curl --request GET \
  --url https://api-vendas.taximachine.com.br/api/integracao/solicitacao \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'api-key: <api-key>'

import requests

url = "https://api-vendas.taximachine.com.br/api/integracao/solicitacao"

headers = {
    "Authorization": "Basic <encoded-value>",
    "api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};

fetch('https://api-vendas.taximachine.com.br/api/integracao/solicitacao', 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/integracao/solicitacao",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-vendas.taximachine.com.br/api/integracao/solicitacao"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-vendas.taximachine.com.br/api/integracao/solicitacao")
  .header("Authorization", "Basic <encoded-value>")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-vendas.taximachine.com.br/api/integracao/solicitacao")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "response": [
    {
      "id": "790",
      "data_hora_solicitacao": "2021-02-18 10:23:42",
      "data_hora_solicitacao_utc": "2021-02-18T13:23:42Z",
      "data_hora_chegada_local": "2021-02-18 10:24:42",
      "data_hora_chegada_local_utc": "2021-02-18T13:24:42Z",
      "status_solicitacao": "A",
      "cliente_id": "1",
      "nome_passageiro": "NOME DO CLIENTE",
      "empresa_id": null,
      "bandeira_chamada_id": "1",
      "data_hora_aceite": "2021-02-18 10:23:42",
      "data_hora_aceite_utc": "2021-02-18T13:23:42Z",
      "data_hora_finalizacao": null,
      "data_hora_finalizacao_utc": null,
      "data_hora_cancelamento": null,
      "data_hora_cancelamento_utc": null,
      "data_hora_pendencia": null,
      "data_hora_pendencia_utc": null,
      "distancia_coleta_km": "1.00",
      "valor_corrida": "0.00",
      "condutor_especificado": false,
      "com_retorno": false,
      "condutor_id": "1",
      "nome_condutor": "NOME DO CONDUTOR",
      "telefone_condutor": "(99) 99999-9999",
      "veiculo": "NOME DO VEICULO",
      "placa_veiculo": "ABC-1234",
      "cor_veiculo": "AZUL",
      "duracao_corrida": "0",
      "distancia_percorrida_km": "0.00",
      "data_hora_inicio": null,
      "tipo_pagamento": "D",
      "desconto": "0.00",
      "tarifa": "Tarifa padrão",
      "id_categoria": "71",
      "categoria": "Moto",
      "descricao_categoria": "Entregas rápidas",
      "nome_cliente": "NOME DO CLIENTE",
      "cpf_cliente": "111.222.333-44",
      "taxas_cancelamento": null,
      "paradas": [],
      "desejado": null
    }
  ]
}

Solicitação

Obter Solicitações

Ao acionar, são retornadas todas as solicitações da central conforme os parâmetros informados.

O bloco desejado traz o endereço de retorno (endereco, bairro, cidade, estado, lat e lng) e vem null quando a entrega não tem retorno, o mesmo critério de com_retorno. Os destinos da entrega continuam em paradas.

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 entrega traz também, na raiz, os dados de fechamento que antes só vinham no recibo, em qualquer status, na consulta por id_mch e na listagem:

data_hora_inicio: início da entrega (null enquanto não iniciou), em ISO 8601 e em UTC (por exemplo, 2023-11-07T05:31:56Z);
tipo_pagamento;
desconto: percentual de desconto (0.00 quando não há);
tarifa, id_categoria, categoria e descricao_categoria;
nome_cliente;
cpf_cliente: só quando a entrega não é corporativa (sem empresa_id);
cnpj_cpf_empresa: só quando a entrega é corporativa (com empresa_id);
codigo_cupom e gerador_cupom_id: só quando a entrega usou cupom.

GET

solicitacao

Obter solicitações

curl --request GET \
  --url https://api-vendas.taximachine.com.br/api/integracao/solicitacao \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'api-key: <api-key>'

import requests

url = "https://api-vendas.taximachine.com.br/api/integracao/solicitacao"

headers = {
    "Authorization": "Basic <encoded-value>",
    "api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Basic <encoded-value>', 'api-key': '<api-key>'}
};

fetch('https://api-vendas.taximachine.com.br/api/integracao/solicitacao', 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/integracao/solicitacao",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-vendas.taximachine.com.br/api/integracao/solicitacao"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-vendas.taximachine.com.br/api/integracao/solicitacao")
  .header("Authorization", "Basic <encoded-value>")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-vendas.taximachine.com.br/api/integracao/solicitacao")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "response": [
    {
      "id": "790",
      "data_hora_solicitacao": "2021-02-18 10:23:42",
      "data_hora_solicitacao_utc": "2021-02-18T13:23:42Z",
      "data_hora_chegada_local": "2021-02-18 10:24:42",
      "data_hora_chegada_local_utc": "2021-02-18T13:24:42Z",
      "status_solicitacao": "A",
      "cliente_id": "1",
      "nome_passageiro": "NOME DO CLIENTE",
      "empresa_id": null,
      "bandeira_chamada_id": "1",
      "data_hora_aceite": "2021-02-18 10:23:42",
      "data_hora_aceite_utc": "2021-02-18T13:23:42Z",
      "data_hora_finalizacao": null,
      "data_hora_finalizacao_utc": null,
      "data_hora_cancelamento": null,
      "data_hora_cancelamento_utc": null,
      "data_hora_pendencia": null,
      "data_hora_pendencia_utc": null,
      "distancia_coleta_km": "1.00",
      "valor_corrida": "0.00",
      "condutor_especificado": false,
      "com_retorno": false,
      "condutor_id": "1",
      "nome_condutor": "NOME DO CONDUTOR",
      "telefone_condutor": "(99) 99999-9999",
      "veiculo": "NOME DO VEICULO",
      "placa_veiculo": "ABC-1234",
      "cor_veiculo": "AZUL",
      "duracao_corrida": "0",
      "distancia_percorrida_km": "0.00",
      "data_hora_inicio": null,
      "tipo_pagamento": "D",
      "desconto": "0.00",
      "tarifa": "Tarifa padrão",
      "id_categoria": "71",
      "categoria": "Moto",
      "descricao_categoria": "Entregas rápidas",
      "nome_cliente": "NOME DO CLIENTE",
      "cpf_cliente": "111.222.333-44",
      "taxas_cancelamento": null,
      "paradas": [],
      "desejado": null
    }
  ]
}

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.

Query Parameters

integer

ID da solicitação. Caso seja informado os outros parâmetros serão ignorados.

status_solicitacao

enum<string>

Status da solicitação. Caso não seja informado, todos serão considerados. Valores possíveis: Distribuindo (D), Aguardando aceite (G), Pendente (P), Não atendida (N), Aceita (A), Arredores local (A), Cheguei ao local (C), Entrada do passageiro (E), Partida prolongada (O), Alteração de trajeto (T), Em espera (S), Em andamento (E), Parada confirmada (R), Finalizada (F), Cancelada (C), Aguardando pagamento (R).

Available options:

D,

G,

P,

N,

A,

C,

E,

O,

T,

S,

R,

F

taxista_id

integer

ID do taxista que aceitou a solicitação. Caso não seja informado, todos serão considerados.

cliente_id

integer

ID do cliente que aceitou a solicitação. Caso não seja informado, todos serão considerados.

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

data_hora_solicitacao_min

string<date-time>

Data/hora miníma da abertura da solicitação, intervalo máximo de 31 dias em relação ao data_hora_max.

data_hora_solicitacao_max

string<date-time>

Data/hora máxima da abertura da solicitação, intervalo máximo de 31 dias em relação ao data_hora_min.

empresa_id

integer

ID da empresa que aceitou a corrida.

limite

integer

default:20

Quantidade de solicitações retornadas. O limite padrão é 20 e o máximo é 100.

Required range: x <= 100

pagina

integer

default:1

Qual início da contagem para o limite. O padrão é 1.

Response

200 - application/json

Sucesso

The response is of type object.

Introdução

Cupons

Central

Saque automático

Dinâmica

Entregador

Webhooks

Categorias

Solicitação

Empresa

Obter Solicitações

Authorizations

Query Parameters

Response