Cupons

Usos do Cupom

Pedidos em que o cupom foi usado

GET

/v1/cupons/{id}/usos

Escopo

cupons.ler

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

idintegerobrigatóriopath

Identificador do cupom.

Parâmetros de consulta

paginaintegerquery

Página (padrão 1).

por_paginaintegerquery

Itens por página, de 1 a 100 (padrão 20).

Resposta

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

Erros possíveis

HTTP	código	quando
`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.
`404`	`nao_encontrado`	O recurso não existe nesta loja.
`404`	`rota_nao_encontrada`	Endereço inexistente na API v1.
`404`	`sem_cobranca`	O pedido não tem cobrança em um meio de pagamento.
`404`	`sem_rastreio`	O pedido ainda não tem código de rastreio.

import os, requests resposta = requests.get( "https://api.hoteldaslojas.com.br/v1/cupons/381/usos", 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/cupons/381/usos'); 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": [ { "pedido_id": 2175, "em": "2026-10-26T16:10:00-03:00", "status": "concluido", "cliente": { "id": 512, "nome": "Marina Duarte", "email": "[email protected]", "whatsapp": "41999990000", "documento": "" }, "desconto": 15.0, "total": 134.9 } ], "paginacao": { "pagina": 1, "por_pagina": 20, "total": 1, "paginas": 1 } }

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