curl --request GET \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/cupons \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/cupons"
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/v2/integracao/cupons', 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/cupons",
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/v2/integracao/cupons"
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/v2/integracao/cupons")
.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/v2/integracao/cupons")
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,
"data": [
{
"id": 1042,
"codigo": "DESCONTO10",
"status": "ativo",
"data_hora_inicio": "2026-09-01 00:00:00",
"data_hora_fim": "2026-10-01 23:59:59",
"tipo_desconto": "percentual",
"desconto": "10.00",
"tipo_limite_cupom": "ate_n_vezes_por_passageiro",
"limite_uso_individual": 3,
"valor_maximo": "20.00",
"valor_maximo_corrida": "50.00",
"gerador_cupom_desconto_id": 17,
"quantidade_usuarios_utilizaram": 12,
"vezes_utilizado": 27
},
{
"id": 1043,
"codigo": "BEMVINDO",
"status": "aguardo",
"data_hora_inicio": "2026-10-05 00:00:00",
"data_hora_fim": "2026-11-05 23:59:59",
"tipo_desconto": "valor_fixo",
"desconto": "5.00",
"tipo_limite_cupom": "apenas_primeira_corrida",
"limite_uso_individual": null,
"valor_maximo": null,
"valor_maximo_corrida": null,
"gerador_cupom_desconto_id": 18,
"quantidade_usuarios_utilizaram": 0,
"vezes_utilizado": 0
}
]
}{
"success": false,
"errors": [
{
"code": 0,
"message": "'id': Informe exatamente um dos parâmetros: id ou codigo."
}
]
}Consultar cupons
Consulta os cupons de desconto da bandeira autenticada.
Informe id ou codigo para buscar um cupom específico — os dois parâmetros são mutuamente exclusivos. Quando nenhum dos dois é informado, o endpoint lista todos os cupons da bandeira. A busca por codigo e a listagem geral retornam até 10 cupons por página, navegados pelo parâmetro pagina; a busca por id retorna no máximo um cupom e ignora a paginação.
O campo status do retorno é derivado da vigência do cupom: aguardo antes de data_hora_inicio, ativo durante a vigência e inativo a partir de data_hora_fim. quantidade_usuarios_utilizaram conta passageiros distintos e vezes_utilizado conta todos os usos do cupom.
Requer Api-Key (bandeira) + autenticação HTTP Basic de um gestor ativo da bandeira.
curl --request GET \
--url https://api-vendas.taximachine.com.br/api/v2/integracao/cupons \
--header 'Authorization: Basic <encoded-value>' \
--header 'api-key: <api-key>'import requests
url = "https://api-vendas.taximachine.com.br/api/v2/integracao/cupons"
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/v2/integracao/cupons', 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/cupons",
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/v2/integracao/cupons"
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/v2/integracao/cupons")
.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/v2/integracao/cupons")
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,
"data": [
{
"id": 1042,
"codigo": "DESCONTO10",
"status": "ativo",
"data_hora_inicio": "2026-09-01 00:00:00",
"data_hora_fim": "2026-10-01 23:59:59",
"tipo_desconto": "percentual",
"desconto": "10.00",
"tipo_limite_cupom": "ate_n_vezes_por_passageiro",
"limite_uso_individual": 3,
"valor_maximo": "20.00",
"valor_maximo_corrida": "50.00",
"gerador_cupom_desconto_id": 17,
"quantidade_usuarios_utilizaram": 12,
"vezes_utilizado": 27
},
{
"id": 1043,
"codigo": "BEMVINDO",
"status": "aguardo",
"data_hora_inicio": "2026-10-05 00:00:00",
"data_hora_fim": "2026-11-05 23:59:59",
"tipo_desconto": "valor_fixo",
"desconto": "5.00",
"tipo_limite_cupom": "apenas_primeira_corrida",
"limite_uso_individual": null,
"valor_maximo": null,
"valor_maximo_corrida": null,
"gerador_cupom_desconto_id": 18,
"quantidade_usuarios_utilizaram": 0,
"vezes_utilizado": 0
}
]
}{
"success": false,
"errors": [
{
"code": 0,
"message": "'id': Informe exatamente um dos parâmetros: id ou codigo."
}
]
}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.
Query Parameters
Identificador interno do cupom. Não pode ser combinado com codigo.
1042
Código do cupom, com até 21 caracteres e sem emojis. Não pode ser combinado com id. Pode retornar mais de um cupom, porque o mesmo código pode ter sido cadastrado em cupons diferentes.
"DESCONTO10"
Filtra os cupons pela vigência.
ativo, inativo, aguardo "ativo"
Página da listagem, com 10 cupons por página. Padrão 1.
x >= 11
Response
Sucesso
The response is of type object.
