Relatórios

Resumo de Vendas

Faturamento, ticket médio, itens, clientes novos e pedidos por status

GET

/v1/relatorios/resumo

Escopo

relatorios.ler

Pedidos cancelados e reembolsados ficam fora do faturamento. faturamento_pago soma os pedidos pagos, aceitos, enviados, prontos e concluídos.

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Parâmetros de consulta

desdestringquery

Início (padrão: 30 dias antes de ate).

atestringquery

Fim (padrão: hoje). Período máximo de 366 dias.

Resposta

200 — objeto { "dados": ... } (veja o exemplo).

Erros possíveis

HTTP	código	quando
`400`	`json_invalido`	O corpo não é um JSON válido (confira também a codificação UTF-8).
`400`	`parametro_invalido`	Um parâmetro de consulta tem formato errado (ex.: data).
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.

import os, requests resposta = requests.get( "https://api.hoteldaslojas.com.br/v1/relatorios/resumo", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/relatorios/resumo'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE')], ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "desde": "2026-09-29T00:00:00-03:00", "ate": "2026-10-28T23:59:59-03:00", "pedidos": 142, "pedidos_cancelados": 6, "faturamento": 18342.7, "faturamento_pago": 17120.4, "ticket_medio": 129.17, "descontos": 812.3, "fretes": 2104.5, "itens_vendidos": 311, "clientes_novos": 58, "pedidos_por_status": { "concluido": 101, "enviado": 17, "pago": 9, "pendente": 9, "cancelado": 6 } } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }