Cupons

Editar Cupom

Altera só os campos enviados

PATCH

/v1/cupons/{id}

Escopo

cupons.escrever

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

idintegerobrigatóriopath

Identificador do cupom.

Corpo da requisição

valornumberbody · application/json

quantidade_disponivelintegerbody · application/json

validadestringbody · application/json

frete_gratisbooleanbody · application/json

…body · application/json

Os mesmos campos da criação.

Resposta

200 — objeto { "dados": {...} } com um Cupom.

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.
`422`	`validacao`	Campos inválidos: veja o objeto "campos".

curl --request PATCH \ --url 'https://api.hoteldaslojas.com.br/v1/cupons/381' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"quantidade_disponivel": 50, "validade": "2027-01-31"}'

import os, requests resposta = requests.patch( "https://api.hoteldaslojas.com.br/v1/cupons/381", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "quantidade_disponivel": 50, "validade": "2027-01-31" }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/cupons/381'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'quantidade_disponivel' => 50, 'validade' => '2027-01-31' ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 381, "codigo": "VOLTA15", "nome": "VOLTA15", "descricao": "", "tipo": "porcentagem", "valor": 15.0, "desconto_maximo": null, "pedido_minimo": null, "quantidade_disponivel": 5, "validade": "2027-12-31T23:59:59-03:00", "primeira_compra": false, "frete_gratis": true, "categorias": [ 783 ], "limite_por_cliente": 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" } }