Consultar Vendas

Consulte as vendas da sua Rede num intervalo de datas, de todas as lojas ou de uma loja específica.

Regras de período (fora delas a API retorna 400):

a janela end_date − start_date deve ter no máximo 15 dias;

start_date não pode ser anterior a 90 dias atrás;

end_date ≥ start_date.

Para períodos maiores, faça várias chamadas (um mês ≈ 2 janelas de 15 dias).

Privacidade. Nome do cliente e do atendente trazem apenas o primeiro nome; cartão e RFID trazem apenas os 5 primeiros caracteres.

Perfil do cliente (novo na v2). Com o customerId de uma venda, abra o perfil completo do cliente no painel: https://app.clubpetro.com/customers/manage/{{customerId}}. É preciso estar logado com um usuário da Rede. Vendas não fidelizadas (fidelizada = false) não têm cliente identificado.

Limites de uso. Os limites de requisições e volume de dados valem para o conjunto das chamadas. Consumo nos headers X-RateLimit-Remaining e X-Data-Used-Bytes e no endpoint GET /v1/usage. Ao exceder, a API responde 429 com Retry-After.

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

curl --location 'https://gateway.clubpetro.com/external-data/v1/sales?start_date=undefined&end_date=undefined&store_document=undefined&limit=undefined&offset=undefined' \ --header 'Authorization: Bearer <token>'

{ "data": [ { "nome_da_loja": "POSTO CENTRAL", "customerId": 1234567, "nome_do_cliente": "Maria", "cartao_do_cliente": "63920*******", "categoria_do_cliente": "OURO", "nome_do_atendente": "Joao", "rfid_do_atendente": "A1B2C******", "produto": "GASOLINA ADITIVADA", "categoria_do_produto": "COMBUSTIVEL", "quantidade_total_produto": 32.5, "valor_total_produto": 201.5, "desconto": 0, "voucher_aplicado_venda": "", "pontuacao_produto": 20, "data_da_compra": "2026-08-03 14:22:07", "fidelizada": true, "e_combustivel": true } ], "pagination": { "limit": 100, "offset": 0, "count": 1 } }

Requisição

Respostas