Alterar banner
Altera a descrição, o link ou liga/desliga um banner.
Corpo
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
bannerIdobrigatório | texto | — | O id do banner, no caminho. |
descricao | texto | — | Até 120 caracteres. null limpa. |
link | texto | — | Endereço http(s). null tira o link. |
ativo | booleano | — | false tira o banner da vitrine sem apagá-lo. |
Exemplo
curl -X PATCH "https://api.otlshoes.com.br/v1/loja-hub/banners/cmh1b2c3d0001" \
-H "Authorization: Bearer otl_prod_SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ativo": false
}'curl -X PATCH "https://api-sandbox.otlshoes.com.br/v1/loja-hub/banners/cmh1b2c3d0001" \
-H "Authorization: Bearer otl_sbx_SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ativo": false
}'const resposta = await fetch('https://api.otlshoes.com.br/v1/loja-hub/banners/cmh1b2c3d0001', {
method: 'PATCH',
headers: {
Authorization: 'Bearer otl_prod_SEU_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"ativo": false
}),
});
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/loja-hub/banners/cmh1b2c3d0001', {
method: 'PATCH',
headers: {
Authorization: 'Bearer otl_sbx_SEU_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"ativo": false
}),
});
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/loja-hub/banners/cmh1b2c3d0001');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer otl_prod_SEU_TOKEN',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
'ativo' => false,
]));
$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/loja-hub/banners/cmh1b2c3d0001');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer otl_sbx_SEU_TOKEN',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
'ativo' => false,
]));
$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.patch(
"https://api.otlshoes.com.br/v1/loja-hub/banners/cmh1b2c3d0001",
headers={
"Authorization": "Bearer otl_prod_SEU_TOKEN",
},
json={
"ativo": False
},
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.patch(
"https://api-sandbox.otlshoes.com.br/v1/loja-hub/banners/cmh1b2c3d0001",
headers={
"Authorization": "Bearer otl_sbx_SEU_TOKEN",
},
json={
"ativo": False
},
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
200 OK, com o banner:
{
"id": "cmh1b2c3d0001",
"imagemUrl": "https://cdn.otlshoes.com.br/otl-catalog/hub/banners/inverno.webp",
"descricao": "Promoção de inverno",
"link": "https://hubshoes.com.br/joao-calcados?marca=casual",
"posicao": 0,
"ativo": false,
"criadoEm": "2026-09-10T10:00:00-03:00"
}
A imagem não é trocada por aqui: remova o banner e envie outro.
Erros possíveis
| HTTP | codigo |
Quando |
|---|---|---|
| 400 | VALIDACAO |
Campo fora do formato, ou corpo sem campo conhecido |
| 404 | NAO_ENCONTRADO |
O banner não existe — ou é de outra loja |
| 403 | LOJA_HUB_NAO_LIBERADA |
A OTL ainda não liberou a loja no HUB para este parceiro |
| 403 | ESCOPO_INSUFICIENTE |
A integração não tem loja-hub:escrever |
