Exportação do cadastro de clientes para o sistema do posto e programa de fidelidade (cupons, extrato, parceiros).
Autenticação em todos os exemplos: veja Autenticação. Teste no navegador pelo Swagger ou importe a coleção do Postman.
| Endpoint | Métodos | Para que serve |
|---|---|---|
ediClientes |
GET | Cadastro de clientes do app para o sistema do posto (EDI) |
fidelidadeCupom |
GET, POST | Programa de fidelidade: cupons dos parceiros e baixa (consumo) de cupom por token |
fidelidadeExtrato |
GET | Programa de fidelidade: extrato das trocas/consumos de cupons |
fidelidadeParceiro |
GET | Programa de fidelidade: cadastro dos parceiros |
Cadastro de clientes do app para o sistema do posto (EDI). Exporta os clientes do app para o sistema de frente de caixa do posto: identificação (código EAN-13 de cada cliente), cadastro completo ou o código de um cliente. Lista só clientes ativos, com cadastro completo e nome, criados ou alterados nas últimas data_range horas. CADPES (CPF/CNPJ, endereço, telefones e e-mail) respeita o escopo do acesso: app vê os clientes do app; rede, os que abasteceram nos postos da rede; posto, os que abasteceram no posto; cliente e pessoa recebem 403.
/v1/terceiro/ediClientesExportação conforme a ação
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
acao |
string | sim | EI (identificação: código EAN-13 por cliente), CADPES (cadastro de pessoas) ou EAN13 (código de um cliente, por id_tx_pessoa). |
data_range |
integer | não | EI/CADPES: horas para trás (criados ou alterados). Padrão 24. |
pagina |
integer | não | EI/CADPES: 0 (padrão) = tudo de uma vez; n = página n de 50. |
codigo_pj / codigo_pf |
string | não | CADPES: código da classe para PJ e PF (padrão 71 e 61). |
tipo_pj / tipo_pf |
string | não | CADPES: nome da classe para PJ e PF (padrão CLIENTE FIEL PJ e CLIENTE FIEL). |
id_tx_pessoa |
integer | não | EAN13: cliente. Fixo no acesso de pessoa. |
curl -s -X GET "$BASE/v1/terceiro/ediClientes?$AUTH&acao=EI"
Resposta:
{
"data": [
{
"identificacao": "1234567890128",
"tipo_entidade": "IAPP",
"pessoa": "CLIENTE EXEMPLO",
"portador": "",
"liberado": "S"
}
],
"status": "ok"
}
Erros específicos: 400 — {registro: 'Falha ao localizar: Ação inválida'}: acao ausente ou desconhecida.; 400 — {registro: 'Falha EAN13: Não localizado'}: cliente não encontrado no app.; 401 — credencial inválida.; 403 — sem permissão..
Programa de fidelidade: cupons dos parceiros e baixa (consumo) de cupom por token. Para o parceiro do programa de fidelidade (loja/serviço conveniado) consultar os cupons e dar baixa no cupom que o cliente apresenta. A fidelidade é recurso do GAS4US (pontos, cupons, parceiros). Permitido para todos os tipos de terceiro. O POST identifica o parceiro pela pessoa (id_tx_pessoa do escopo; num terceiro rede/estabelecimento vem do parâmetro id_tx_pessoa).
/v1/terceiro/fidelidadeCupomLista de cupons do app (paginada)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_fidelidade_parceiro |
integer | não | Só cupons ativos desse parceiro (ausente = todos os cupons do app). |
ativo |
string | não | S, N ou * (padrão). |
valor_troca_inicial / valor_troca_final |
number | não | Faixa (padrão 0 a 999999999,99). |
valor_custo_inicial / valor_custo_final |
number | não | Faixa. |
valor_credito_inicial / valor_credito_final |
number | não | Faixa. |
data_troca_inicial / data_troca_final |
date | não | Período de troca contido no intervalo. |
data_consumo_inicial / data_consumo_final |
date | não | Período de consumo contido no intervalo. |
limite_<geral\|pessoa\|dia\|semana\|mes\|ano>_inicial / _final |
integer | não | Faixas dos limites. |
size |
integer | não | Tamanho da página (padrão 50). |
page |
integer | não | Página (padrão 1). |
curl -s -X GET "$BASE/v1/terceiro/fidelidadeCupom?$AUTH"
Resposta:
{
"status": "ok",
"data": [
{
"id_fidelidade_cupom": 10,
"id_fidelidade_cupom_template": 3,
"token_imagem": "<token>",
"descricao": "LAVAGEM SIMPLES",
"codigo_interno": "LAV01",
"observacao": "",
"valor_troca": 100,
"data_hora_inicio_troca": "2026-11-01 00:00:00",
"data_hora_fim_troca": "2026-12-31 23:59:59",
"data_hora_inicio_consumo": "2026-11-01 00:00:00",
"data_hora_fim_consumo": "2027-01-31 23:59:59",
"valor_custo": 15.0,
"valor_credito": 0,
"limite_quantidade_pessoa": 1,
"limite_quantidade_dia": 0,
"limite_quantidade_semana": 0,
"limite_quantidade_mes": 0,
"limite_quantidade_ano": 0,
"limite_quantidade_geral": 100,
"ativo": "S",
"ponto_tipo": "PONTOS",
"parceiros": [
{
"id_fidelidade_parceiro": 4,
"nome": "PARCEIRO EXEMPLO",
"endereco1": "RUA EXEMPLO, 100",
"endereco2": "CIDADE/UF",
"latitude": -23.0,
"longitude": -51.0,
"telefone": "0000000000",
"celular": "00000000000",
"email": "parceiro@exemplo.com.br"
}
],
"auto_consumivel": "N"
}
],
"param": {
"_count": 1,
"_pages": 1
}
}
Erros específicos: 401; 403.
/v1/terceiro/fidelidadeCupomConsulta (e com acao=REGISTRAR, consome) o cupom pelo token de 9 dígitos
Perfis: App, Rede, Posto, Cliente, Pessoa
Ações (parâmetro acao):
| Ação | O que faz |
|---|---|
(padrão) |
Só devolve os dados do cupom do token. |
REGISTRAR |
Marca o cupom como consumido por este parceiro (data_hora_consumo, consumido = S) e devolve os dados. Quando o cupom é de um tipo integrado à EVO, antes gera a senha na EVO e a devolve (senha, id_evo, expires_at); se a EVO recusar, nada é consumido. |
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
token |
string | sim | Token de 9 dígitos que o cliente mostra (válido só no dia; gerado a partir da operação de troca). |
acao |
string | não | REGISTRAR = marca o cupom como consumido por este parceiro; ausente = só consulta. |
id_tx_pessoa |
integer | não | Pessoa do parceiro (já fixada quando o terceiro é do tipo pessoa). |
curl -s -X POST "$BASE/v1/terceiro/fidelidadeCupom?$AUTH&token="
Resposta:
{
"status": "ok",
"id_fidelidade_operacao": 7001,
"cpf_cnpj": "000.***.***-00",
"nome_razao_social": "CLIENTE EXEMPLO",
"codigo_interno": "LAV01",
"descricao": "LAVAGEM SIMPLES",
"valor_troca": 100,
"valor_custo": 15.0,
"valor_credito": 0,
"consumido": "S"
}
Erros específicos: 403 {"errors":{"acesso":"Negado"}} pessoa não é parceiro ativo; 400 token 'Inválido' (não tem 9 dígitos); 400 token 'Inválido ou fora do período de consumo' (já consumido, de outro dia, cupom não vinculado ao parceiro ou fora do período); 400 token 'Este cupom é consumido pelo próprio cliente no app' (cupom autoconsumível não é baixado pelo parceiro); 400 evo '' (falha ao gerar a senha na EVO; o cupom não é consumido).
Programa de fidelidade: extrato das trocas/consumos de cupons. Lista as operações de cupom (troca e consumo) do app com resumo (quantidade e soma do custo). Atenção ao filtro de pessoa: id_tx_pessoa filtra o CLIENTE da operação; num terceiro do tipo pessoa ele fica fixo na pessoa do terceiro, então para um parceiro use um terceiro rede/estabelecimento com id_fidelidade_parceiro. Permitido para todos os tipos de terceiro.
/v1/terceiro/fidelidadeExtratoExtrato paginado
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_fidelidade_parceiro |
integer | não | Parceiro que consumiu. |
id_fidelidade_cupom |
integer | não | Cupom. |
id_tx_pessoa |
integer | não | Cliente da operação (fixo no escopo para terceiro pessoa). |
data_troca_inicial / data_troca_final |
date | não | |
data_consumo_inicial / data_consumo_final |
date | não | Só consumo informado = ordena por consumo. |
trocado |
string | não | S/N |
consumido |
string | não | S/N |
expirado |
string | não | S = não consumido e vencido; N = consumido ou ainda no prazo |
size |
integer | não | padrão 50 |
page |
integer | não | padrão 1 |
curl -s -X GET "$BASE/v1/terceiro/fidelidadeExtrato?$AUTH"
Resposta:
{
"status": "ok",
"data": [
{
"id_fidelidade_operacao": 7001,
"id_fidelidade_parceiro": 4,
"parceiro": "PARCEIRO EXEMPLO",
"id_tx_pessoa": 555,
"pessoa": "CLIENTE EXEMPLO",
"id_fidelidade_cupom": 10,
"cupom": "LAVAGEM SIMPLES",
"codigo_interno": "LAV01",
"data_hora_troca": "2026-11-10 10:00:00",
"data_hora_consumo": "2026-11-11 15:30:00",
"valor": 15.0
}
],
"param": {
"_count": 1,
"_pages": 1
},
"resume": {
"quantidade": 1,
"total": 15.0
}
}
Erros específicos: 401; 403.
Programa de fidelidade: cadastro dos parceiros. Lista os parceiros do programa de fidelidade do app (lojas/serviços onde o cupom é consumido). Terceiro do tipo pessoa vê só o próprio parceiro (id_tx_pessoa fixo). Permitido para todos os tipos de terceiro.
/v1/terceiro/fidelidadeParceiroLista paginada de parceiros
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_tx_pessoa |
integer | não | Pessoa do parceiro (fixa para terceiro pessoa). |
ativo |
string | não | S, N ou * (padrão). |
size |
integer | não | padrão 50 |
page |
integer | não | padrão 1 |
curl -s -X GET "$BASE/v1/terceiro/fidelidadeParceiro?$AUTH"
Resposta:
{
"status": "ok",
"data": [
{
"id_fidelidade_parceiro": 4,
"id_tx_pessoa": 777,
"pessoa": "PARCEIRO EXEMPLO LTDA",
"nome": "PARCEIRO EXEMPLO",
"endereco1": "RUA EXEMPLO, 100",
"endereco2": "CIDADE/UF",
"latitude": -23.0,
"longitude": -51.0,
"telefone": "0000000000",
"celular": "00000000000",
"email": "parceiro@exemplo.com.br",
"ativo": "S"
}
],
"param": {
"_count": 1,
"_pages": 1
}
}
Erros específicos: 401; 403.