Relatórios

Exportar Planilha

Pedidos, clientes ou produtos em CSV (abre no Excel)

GET

/v1/exportacoes/{tipo}

Escopo

relatorios.ler

Até 5.000 linhas por chamada. Os cabeçalhos X-Total-Linhas e X-Limite-Atingido (true/false) dizem se é preciso dividir o período com desde/ate.
Colunas de pedidos: pedido, data, status, cliente, email, whatsapp, documento, subtotal, desconto, frete, total, cupom, pagamento, entrega, rastreio, cidade, estado.
Clientes: id, nome, email, whatsapp, documento, tipo, nascimento, cep, cidade, estado, pedidos, etiquetas, cadastro. Produtos: id, sku, nome, marca, categoria, preco, preco_promocional, ativo, estoque, peso_kg, url, atualizado.

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 caminho

tipostringobrigatóriopath

pedidos, clientes ou produtos.

Parâmetros de consulta

desdestringquery

Criados a partir desta data.

atestringquery

Criados até esta data.

Resposta

200 — objeto { "dados": ... } com o arquivo CSV (text/csv; separador ; e UTF-8 com BOM).

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/exportacoes/pedidos", 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/exportacoes/pedidos'); 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);

{ "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" } }