Fidelidade

Emitir Cartão-presente

Gera um código com saldo (enviado por e-mail)

POST

/v1/cartoes-presente

Escopo

fidelidade.escrever

Bom para trocas, cortesias e campanhas. O cliente usa o código no fechamento do pedido (o aplicativo Cartão-presente precisa estar instalado na loja).

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.

Corpo da requisição

valornumberobrigatóriobody · application/json

De 1 a 10.000 reais.

emailstringbody · application/json

Recebe o código por e-mail.

nomestringbody · application/json

Resposta

201 — objeto { "dados": {...} } com um Cartão-presente.

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.
`422`	`fornecedor_recusou`	O fornecedor (AliExpress) recusou ou a conta não está conectada; a mensagem traz o motivo.
`422`	`imagem_invalida`	A imagem não pôde ser baixada ou não é JPG, PNG, WEBP ou GIF de até 5 MB.
`422`	`validacao`	Campos inválidos: veja o objeto "campos".

curl --request POST \ --url 'https://api.hoteldaslojas.com.br/v1/cartoes-presente' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"valor": 50, "email": "[email protected]", "nome": "Joana"}'

import os, requests resposta = requests.post( "https://api.hoteldaslojas.com.br/v1/cartoes-presente", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "valor": 50, "email": "[email protected]", "nome": "Joana" }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/cartoes-presente'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'valor' => 50, 'email' => '[email protected]', 'nome' => 'Joana' ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 2, "codigo": "7W89-9DLS-962X", "valor": 50.0, "saldo": 50.0, "email": "[email protected]", "nome": "Joana", "pedido_origem_id": null, "cancelado": false, "criado_em": "2026-10-28T02:52:32-03:00" } }

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