VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Promoções e cupons

Cancelar alerta de preço

Cancela um alerta de preço, o aviso por e-mail que o comprador pediu para quando um produto chegar a um preço-alvo.

Na página de um produto o comprador pode pedir "avise-me quando custar até R$ X". Isso cria um alerta de preço ligado a um e-mail. Quando o preço cai até o alvo, a loja envia o aviso. Esta rota cancela o alerta. Ela é a que o link "parar de receber este aviso" do e-mail usa e também serve para uma tela "Meus alertas".

O alerta é criado por POST /api/v1/storefront/products/{id}/price-alerts (rota da página de produto, fora desta seção), que devolve {"id": "...", "status": "active"}. Guarde esse id.

DELETE/api/v1/storefront/price-alerts/{id}Pública

Cancel a price alert

Marca o alerta como cancelled. A rota é pública: a prova de que o chamador pode cancelar é conhecer o id do alerta e o e-mail dele. Cliente logado pode omitir email: usa-se o e-mail da conta.

Parâmetros de caminho

iduuidobrigatório
Id do alerta, devolvido na criação.

Parâmetros de consulta

emailstring
E-mail que cadastrou o alerta. Obrigatório para visitante; opcional com login (usa o e-mail da conta). Maiúsculas e minúsculas não importam.

Exemplo de requisição

bash
curl -X DELETE "$BASE_URL/api/v1/storefront/price-alerts/$ALERT_ID?email=maria.souza@example.com"

Resposta

200Alerta cancelado
json
{ "cancelled": true }

Campos da resposta

cancelledboolean
Sempre true quando a chamada termina sem erro.

Erros

StatusQuandoCorpo
400Sem email (e sem login){"error":"id and email required"}
500O id não é um UUID válido{"error":"failed to cancel alert","detail":"o valor \"not-a-uuid\" não é um uuid válido. ..."}
Sucesso não prova que algo foi cancelado

A resposta é {"cancelled": true} mesmo se o e-mail não for o do alerta, se o alerta já estava cancelado ou se o id não existe: nesses casos nada muda. Não use essa resposta para confirmar o estado. Além disso, um id mal formado sai como 500 em vez de 400; valide que ele é um UUID antes de chamar. O detail desse 500 é uma frase em português, como o servidor devolve.

Veja também

  • Listar e simular promoções
  • Visão geral de promoções e alertas
Anterior
Cupons automáticos do cliente
Próxima
Marca e configuração do tema
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também