API Obter Relatório do PDV
Obter o relatório de vendas do PDV da sua empresa no período, com os totais e as quebras por produto, categoria, atendente, forma de pagamento e dia.
API: Todas
Endpoint
https://{BACKEND_URL}/api/pdv/relatorio?de={dataInicio}&ate={dataFim}&userId={userId}
Método
GET
Autenticação
Bearer {seutokenaqui}
Payload
// sem payload — os filtros vão na própria URL
Esta chamada não tem payload. Os filtros são informados como query na URL, e todos são opcionais.
de e ate: o primeiro e o último dia do período, no formato
AAAA-MM-DD. Sem os dois, vêm os últimos 30 dias, até hoje; só com de, vai até hoje; só com ate, começa 29 dias antes.
O período vai até um ano. Mais longo, ou com
de depois de ate, a chamada é recusada.
Data em outro formato, como
31/10/2026, é ignorada sem aviso, e a chamada usa o período padrão no lugar dela. Confira o periodo que volta na resposta.
userId: só os pedidos daquele atendente (o id do usuário). Um id sem pedidos devolve o relatório zerado.
O relatório é da empresa inteira, qualquer que seja a Conexão do token.
O
resumo traz os totais do período — vendido, recebido, estornado, a receber, cancelados, custo e margem —, e as quebras vêm em porProduto, porCategoria, porAtendente, porForma e porDia.
Os valores vêm em reais, com o ponto separando os centavos; a
margem vem em %.
O
porDia traz todos os dias do período, também os sem venda.
Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://{BACKEND_URL}/api/pdv/relatorio?de={dataInicio}&ate={dataFim}&userId={userId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;