Skip to content

Avise-me & Sob Consulta

Visão Geral

O módulo Avise-me & Sob Consulta permite que um cliente registre interesse em um produto específico 📩.

Ele atende a duas situações principais:

1. Avise-me: Quando um produto está fora de estoque ou o cliente deseja adquirir futuramente, ele pode cadastrar seu e-mail (não sendo necessário criar conta) para receber notificações e atualizações sobre aquele item.

2. Sob Consulta: Caso o produto não tenha preço definido, o interesse cadastrado indica uma solicitação de serviço ou orçamento, permitindo que a comunicação com o cliente seja feita de forma mais personalizada para viabilizar a compra.

Dessa forma, o módulo cumpre o propósito duplo de manter clientes informados sobre produtos indisponíveis e facilitar solicitações de produtos sob consulta.

Cadastrar Interesse no Produto

POST /publics/products/interests

Registra interesse de cliente em produto específico para notificação

Descrição

Endpoint responsável por cadastrar um interesse de cliente 📩.

Ao registrar o interesse, o cliente passa a receber notificações sobre atualizações relacionadas ao produto alvo, como reposição de estoque, promoções ou mudanças de preço.

Parâmetros de query

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
productIdint✅Identificador do produto para vínculo
originenum✅Determina origem do cadastro (notify-me: Interesse no produto para compra futura, on-request: solicitação direta de serviço/orçamento)
namestring✅Nome do indivíduo interessado (max: 50)
emailstring✅E-mail do indivíduo interessado (max: 50)
phonestring❌Telefone do indivíduo interessado
messagestring❌Mensagem para detalhar mais sobre o interesse (max: 300)

Exemplo de Requisição

1curl --request POST \
2 --url {{MAIN_URL}}/publics/products/interests \
3 --data '{
4 "productId": 1,
5 "origin": "on-request",
6 "name": "Carlos",
7 "email": "email.address@email.com"
8 "phone": "+5512123451234",
9 "message": "Preciso de 15 unidades desse produto"
10 }'

✅ Resposta de Sucesso

1{
2 "id": 567,
3 "productId": 1234,
4 "origin": "notify-me",
5 "name": "João Silva",
6 "email": "joao.silva@email.com",
7 "phone": "(11) 99999-9999",
8 "message": "Gostaria de ser notificado quando este produto estiver disponível novamente.",
9 "repliedAt": null,
10 "createdAt": "2024-04-10 14:30:00",
11 "simpleProduct": null,
12 "createdAt": "2024-04-08 10:30:00",
13}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

1{
2 "status": false,
3 "data": {
4 "code": 404,
5 "errorCode": "UAPPI_STORE_PRODUCT_NOT_FOUND",
6 "message": "The requested product was not found."
7 }
8}

Uappi é a melhor opção para o crescimento da sua loja!

;