Aplicativos

Definir Regras do Aplicativo

Substitui as regras de um aplicativo de vendas ou do gestor de frete

PUT

/v1/aplicativos/{slug}/regras

Escopo

aplicativos.escrever

Envia a lista inteira: ela substitui as regras atuais (lista vazia apaga todas). Até 100 regras.
O aplicativo precisa estar instalado no painel (409 aplicativo_nao_instalado).
Brindes e cartão-presente precisam ser produtos sem opções (tamanho, cor...).

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

slugstringobrigatóriopath

compre-junto, brinde-por-valor, brinde-por-produto, limitacao-de-compra, gestor-de-frete ou cartao-presente.

Corpo da requisição

regrasobject[]body · application/json

compre-junto: { nome, produto_id, itens: [produto_id], desconto_percentual (até 90) }. brinde-por-produto: { produto_id, quantidade, brinde_produto_id }. limitacao-de-compra: { produto_id, minimo, maximo, maximo_por_cliente }. gestor-de-frete: { nome, cep_inicio, cep_fim, peso_min, peso_max, valor_min, valor_max, preco, gratis_acima, prazo_dias }.

faixasobject[]body · application/json

brinde-por-valor: { valor_minimo, brinde_produto_id }.

produtosinteger[]body · application/json

cartao-presente: produtos que viram cartão-presente quando vendidos.

geraisobjectbody · application/json

limitacao-de-compra: { minimo_itens_pedido, maximo_itens_pedido, minimo_por_produto, maximo_por_produto } (0 = sem limite).

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.
`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.
`404`	`sem_cobranca`	O pedido não tem cobrança em um meio de pagamento.
`409`	`categoria_em_uso`	A categoria tem produtos ou subcategorias.
`409`	`conflito`	O recurso mudou durante a chamada: consulte e tente de novo.
`404`	`sem_rastreio`	O pedido ainda não tem código de rastreio.
`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 PUT \ --url 'https://api.hoteldaslojas.com.br/v1/aplicativos/compre-junto/regras' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"regras": [{"nome": "Combo leitura", "produto_id": 2291, "itens": [2268], "desconto_percentual": 10}]}'

import os, requests resposta = requests.put( "https://api.hoteldaslojas.com.br/v1/aplicativos/compre-junto/regras", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "regras": [ { "nome": "Combo leitura", "produto_id": 2291, "itens": [ 2268 ], "desconto_percentual": 10 } ] }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/aplicativos/compre-junto/regras'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'PUT', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'regras' => [[ 'nome' => 'Combo leitura', 'produto_id' => 2291, 'itens' => [2268], 'desconto_percentual' => 10 ]] ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "slug": "compre-junto", "nome": "Compre junto", "categoria": "vendas", "descricao": "Combos na página do produto, com desconto para quem leva os produtos juntos.", "instalado": true, "ativo": true, "regras_pela_api": true, "configuracao": { "regras": [ { "nome": "Combo leitura", "produto_id": 2291, "itens": [ 2268 ], "desconto_percentual": 10.0 } ] } } }

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