Detalhar cliente
Um cliente da agenda, pelo identificador.
Parâmetros
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
idobrigatório | texto | — | O identificador do cliente, no caminho. |
Exemplo
curl "https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003" \
-H "Authorization: Bearer otl_prod_SEU_TOKEN"curl "https://api-sandbox.otlshoes.com.br/v1/clientes/cmg7h2k9x0003" \
-H "Authorization: Bearer otl_sbx_SEU_TOKEN"const resposta = await fetch('https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003', {
headers: {
Authorization: 'Bearer otl_prod_SEU_TOKEN',
},
});
if (!resposta.ok) {
const { erro } = await resposta.json();
throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();const resposta = await fetch('https://api-sandbox.otlshoes.com.br/v1/clientes/cmg7h2k9x0003', {
headers: {
Authorization: 'Bearer otl_sbx_SEU_TOKEN',
},
});
if (!resposta.ok) {
const { erro } = await resposta.json();
throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();<?php
$ch = curl_init('https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer otl_prod_SEU_TOKEN',
]);
$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}<?php
$ch = curl_init('https://api-sandbox.otlshoes.com.br/v1/clientes/cmg7h2k9x0003');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer otl_sbx_SEU_TOKEN',
]);
$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}import requests
resposta = requests.get(
"https://api.otlshoes.com.br/v1/clientes/cmg7h2k9x0003",
headers={
"Authorization": "Bearer otl_prod_SEU_TOKEN",
},
timeout=30,
)
if not resposta.ok:
erro = resposta.json()["erro"]
raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()import requests
resposta = requests.get(
"https://api-sandbox.otlshoes.com.br/v1/clientes/cmg7h2k9x0003",
headers={
"Authorization": "Bearer otl_sbx_SEU_TOKEN",
},
timeout=30,
)
if not resposta.ok:
erro = resposta.json()["erro"]
raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()Testar agora no ambiente de testes
A chamada é feita de verdade, do seu navegador para a API de testes (https://api-sandbox.otlshoes.com.br/v1). Use um token otl_sbx_…: ele fica só nesta aba, e some ao fechá-la. Token de produção não é aceito aqui.
Resposta
{
"id": "cmg7h2k9x0003",
"nome": "Maria da Silva",
"whatsapp": "5551999990000",
"endereco": {
"cep": "90000000",
"rua": "Rua das Flores",
"numero": "10",
"complemento": "ap 2",
"bairro": "Centro",
"cidade": "Porto Alegre",
"uf": "RS"
},
"criadoEm": "2026-09-20T09:15:00-03:00",
"atualizadoEm": "2026-09-29T14:03:00-03:00"
}
Os campos são os mesmos de cada item de Listar clientes.
Erros possíveis
| HTTP | codigo |
Quando |
|---|---|---|
| 404 | NAO_ENCONTRADO |
O cliente não existe — ou é de outro parceiro. A API não diferencia os dois casos |
| 403 | ESCOPO_INSUFICIENTE |
A integração não tem clientes:ler |
