🔔 Preferências do Cliente

📋 Visão Geral

O módulo de Preferências do Cliente permite que o cliente autenticado gerencie suas preferências de comunicação com a loja.

As preferências são organizadas em dois eixos:

Canal de comunicação — o cliente pode optar por receber notificações via e-mail ou via SMS, de forma independente para cada tipo de conteúdo.

Tipo de conteúdo — as preferências distinguem dois tipos de mensagens:

• Comunicações promocionais — e-mails e SMS de marketing, campanhas, ofertas e promoções da loja.
• Notificações de pedido — atualizações transacionais sobre o status dos pedidos realizados pelo cliente.

🔄 Entidades Envolvidas

As preferências do cliente são representadas por quatro campos booleanos independentes:

Preferências promocionais

Controlam o recebimento de comunicações de marketing da loja, como campanhas, ofertas e promoções.

• sendPromotionalEmail — define se o cliente aceita receber comunicações promocionais por e-mail. Padrão: false.
• sendPromotionalSms — define se o cliente aceita receber comunicações promocionais por SMS. Padrão: false.

Preferências de pedido

Controlam o recebimento de notificações transacionais sobre os pedidos do cliente.

• sendOrderEmail — define se o cliente aceita receber atualizações de pedidos por e-mail. Padrão: true.
• sendOrderSms — define se o cliente aceita receber atualizações de pedidos por SMS. Padrão: false.

📌 Notas e Considerações

• Todos os quatro campos são obrigatórios na requisição de atualização — não é possível atualizar apenas um subconjunto das preferências.
• Efeito na newsletter — ao habilitar qualquer flag promocional (sendPromotionalEmail ou sendPromotionalSms), o cliente é inscrito automaticamente na newsletter da loja. Ao desativar ambas as flags promocionais, a inscrição na newsletter é removida.

✏️ Atualizar Preferências do Cliente

📋 Descrição

Endpoint responsável por atualizar as preferências de comunicação do cliente autenticado junto à loja.

As preferências controlam quais tipos de mensagens o cliente deseja receber e por qual canal:

• E-mail promocional — campanhas, ofertas e comunicações de marketing
• SMS promocional — campanhas e ofertas enviadas via mensagem de texto
• E-mail de pedido — atualizações transacionais sobre o status dos pedidos
• SMS de pedido — atualizações sobre pedidos enviadas via mensagem de texto

Ao habilitar qualquer preferência promocional (sendPromotionalEmail ou sendPromotionalSms), o cliente é inscrito automaticamente na newsletter da loja. Ao desativar ambas as flags promocionais, a inscrição na newsletter é removida.

🔐 Permissão

• CustomerAuth — autenticação do cliente via token JWT

📝 Parâmetros

🏷️ Headers Obrigatórios

📦 Parâmetros do Corpo

💡 Exemplo de Requisição

1curl --request PUT \
2  --url '{{MAIN_URL}}/customer/flag' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --header 'Content-Type: application/json' \
5  --data '{
6    "sendPromotionalEmail": true,
7    "sendPromotionalSms": false,
8    "sendOrderEmail": true,
9    "sendOrderSms": false
10  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": {
4    "sendPromotionalEmail": true,
5    "sendPromotionalSms": false,
6    "sendOrderEmail": true,
7    "sendOrderSms": false
8  }
9}

⚠️ Possíveis Erros

> Os cenários abaixo representam os principais erros que podem ocorrer neste endpoint, servindo como referência para entendimento e tratamento das falhas.