VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Preço e estoque

POSTAlerta de preço

Registra um e-mail para ser avisado quando o preço de um produto cair até o valor desejado.

Cria um alerta do tipo "me avise quando custar até R$ X". Serve para o comprador que achou o produto caro e não quer voltar todo dia à página. Quando o preço do produto chegar ao valor alvo ou abaixo, a loja envia um e-mail para o endereço cadastrado.

Visitantes e clientes logados podem criar alertas. Para quem está logado, o email do corpo é opcional (usa o e-mail da conta).

POST/api/v1/storefront/products/{id}/price-alertsPública

Cria um alerta de preço

Parâmetros de caminho

iduuidobrigatório
Id do produto (UUID completo).

Corpo da requisição

target_price_centsintegerobrigatório
Preço desejado, em centavos. Precisa ser maior que 0 e menor que o preço atual do produto.
emailstring
E-mail que recebe o aviso. Obrigatório para visitantes; para cliente logado, o padrão é o e-mail da conta. O endereço é validado e guardado em minúsculas.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/storefront/products/5e833a7f-1a77-402c-835a-32594350d7a7/price-alerts" \
  -H "Content-Type: application/json" \
  -d '{"email": "maria.souza@example.com", "target_price_cents": 4500}'

Resposta

201Alerta criado
json
{"id":"1ce04013-18e0-4c96-92b8-425502f5714d","status":"active"}

Campos da resposta

iduuid
Id do alerta.
statusstring
active
Estado do alerta criado: active.

Erros

StatusQuandoCorpo de exemplo
400Corpo inválido, e-mail ausente ou inválido, ou alvo fora da faixa.{"error":"invalid target price"}, {"error":"email required"}, {"error":"invalid email"}
404O produto não existe.{"error":"product not found"}
409Já existe um alerta ativo deste e-mail para este produto.{"error":"alert already exists"}
429O e-mail já tem 5 alertas ativos.{"error":"too many active alerts"}
Limites

Cada e-mail pode ter no máximo 5 alertas ativos e um por produto. O alvo precisa ser menor que o preço atual; um alvo igual ou maior responde 400 invalid target price.

Veja também

  • Histórico de preço
  • Aviso de volta ao estoque
Anterior
Histórico de preço
Próxima
Preço por estado
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também