Clientes

Cadastrar Cliente

Cadastra um cliente na loja

POST

/v1/clientes

Escopo

clientes.escrever

WhatsApp ou e-mail já cadastrado: 409 cliente_existente, com o id do cadastro em campos.cliente_id.
O cliente é criado sem senha: para entrar na loja ele usa "Esqueci minha senha". Cada alteração fica no histórico do cadastro (origem API).

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

nomestringobrigatóriobody · application/json

Pelo menos 3 letras.

whatsappstringobrigatóriobody · application/json

Com DDD (10 a 13 dígitos).

emailstringbody · application/json

documentostringbody · application/json

CPF ou CNPJ válido.

tipo_pessoastringbody · application/json

PF ou PJ.

nascimentostringbody · application/json

AAAA-MM-DD.

tagsstring[]body · application/json

Etiquetas do CRM.

observacoesstringbody · application/json

Notas internas.

enderecoobjectbody · application/json

{ cep, rua, numero, complemento, bairro, referencia, cidade, estado (sigla) }.

bloqueadobooleanbody · application/json

Bloqueia compras.

bloqueio_motivostringbody · application/json

Resposta

201 — objeto { "dados": {...} } com um Cliente.

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.
`409`	`mesmo_status`	O pedido já está no status pedido.
`409`	`pedido_encerrado`	Pedido cancelado ou reembolsado não muda mais.
`409`	`estoque_insuficiente`	Saída maior que o saldo.
`409`	`limite_do_plano`	A loja atingiu o limite de produtos do plano.
`409`	`limite_webhooks`	A loja já tem 10 webhooks.
`409`	`limite_imagens`	O produto já tem 20 imagens.
`409`	`cliente_existente`	Já existe cliente com este WhatsApp ou e-mail (id em campos.cliente_id).
`409`	`saldo_insuficiente`	Débito de cashback maior que o saldo do cliente.
`409`	`limite_enderecos`	O cliente já tem 20 endereços.
`409`	`limite_faixas`	A loja já tem 300 faixas de frete.
`409`	`meio_indisponivel`	O meio de pagamento não está instalado, ligado e configurado na loja.
`409`	`pedido_nao_pendente`	Só pedido pendente recebe link de pagamento.
`409`	`aplicativo_nao_instalado`	Instale o aplicativo no painel antes de gravar as regras.
`409`	`canal_inativo`	O canal de marketplace não está ativo na loja.
`409`	`canal_sem_pedidos`	O canal só recebe o catálogo (feed), não tem pedidos.
`422`	`fornecedor_recusou`	O fornecedor (AliExpress) recusou ou a conta não está conectada; a mensagem traz o motivo.
`409`	`categoria_em_uso`	A categoria tem produtos ou subcategorias.
`409`	`conflito`	O recurso mudou durante a chamada: consulte e tente de novo.
`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/clientes' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"nome": "Marina Duarte", "whatsapp": "41999990000", "email": "[email protected]", "tags": ["atacado"]}'

import os, requests resposta = requests.post( "https://api.hoteldaslojas.com.br/v1/clientes", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "nome": "Marina Duarte", "whatsapp": "41999990000", "email": "[email protected]", "tags": [ "atacado" ] }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/clientes'); 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([ 'nome' => 'Marina Duarte', 'whatsapp' => '41999990000', 'email' => '[email protected]', 'tags' => ['atacado'] ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 512, "nome": "Marina Duarte", "email": "[email protected]", "whatsapp": "41999990000", "documento": "", "tipo_pessoa": "PF", "nascimento": null, "endereco": { "cep": "", "rua": "", "numero": "", "complemento": "", "bairro": "", "referencia": "", "cidade": "", "estado": "" }, "total_pedidos": 0, "tags": [ "atacado" ], "bloqueado": false, "criado_em": "2026-10-28T02:52:29-03:00", "ultimo_login": null } }

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