Marketing

Criar Promoção

Leve X pague Y, desconto por quantidade ou acima de um valor

POST

/v1/promocoes

Escopo

marketing.escrever

As promoções não somam entre si: vale a melhor para o cliente. O cupom soma por cima.

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

tipostringobrigatóriobody · application/json

leve_pague, progressivo ou valor.

leveintegerbody · application/json

leve_pague: leve (2 a 99).

pagueintegerbody · application/json

leve_pague: pague (menor que leve).

quantidade_minimaintegerbody · application/json

progressivo: a partir de quantas unidades.

percentualnumberbody · application/json

progressivo e valor: % de desconto.

valor_minimonumberbody · application/json

valor: a partir de quantos reais.

categoriasinteger[]body · application/json

Só nestas categorias.

iniciostringbody · application/json

fimstringbody · application/json

ativobooleanbody · application/json

Padrão true.

Resposta

201 — objeto { "dados": {...} } com um Promoção.

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/promocoes' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"nome": "Leve 3 pague 2", "tipo": "leve_pague", "leve": 3, "pague": 2, "fim": "2026-11-30T23:59:59-03:00"}'

import os, requests resposta = requests.post( "https://api.hoteldaslojas.com.br/v1/promocoes", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "nome": "Leve 3 pague 2", "tipo": "leve_pague", "leve": 3, "pague": 2, "fim": "2026-11-30T23:59:59-03:00" }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/promocoes'); 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' => 'Leve 3 pague 2', 'tipo' => 'leve_pague', 'leve' => 3, 'pague' => 2, 'fim' => '2026-11-30T23:59:59-03:00' ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 98, "nome": "Leve 3 pague 2", "tipo": "leve_pague", "categorias": [], "leve": 3, "pague": 2, "quantidade_minima": null, "percentual": null, "valor_minimo": null, "inicio": null, "fim": "2026-11-30T23:59:59-03:00", "ativo": true, "criado_em": "2026-10-28T02:52:31-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" } }