VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Conta do cliente

Personalização

Controle de privacidade do cliente sobre a personalização da vitrine.

Lojas podem personalizar a ordem dos produtos para cada cliente logado, com base no que ele já viu e comprou. Estas quatro rotas são o controle de privacidade do cliente sobre isso (a base é o consentimento da LGPD): ver o que a loja aprendeu, desligar, religar e apagar o perfil aprendido. Funcionam sempre, mesmo em lojas que não usam personalização (nesse caso não há nada para ver).

GET/api/v1/storefront/account/personalizationCliente

Vê o perfil de personalização do cliente

bash
curl "$BASE_URL/api/v1/storefront/account/personalization" \
  -H "Authorization: Bearer $TOKEN"
200Perfil de personalização
json
{
  "enabled": true,
  "top_brands": [ { "id": "brand-123", "weight": 0.42 } ],
  "top_categories": [ { "id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9", "weight": 0.31 } ],
  "price_band_cents": {}
}

Campos da resposta

enabledboolean
false quando o cliente desligou a personalização.
top_brandsarray
Marcas de maior afinidade: { id, weight }, com peso entre 0 e 1. Vazio enquanto a loja não aprendeu nada.
top_categoriesarray
Categorias de maior afinidade, no mesmo formato.
price_band_centsobject
Faixa de preço preferida, em centavos. {} quando não há.
StatusQuandoCorpo
401Sem token, ou token inválido ou expirado{"error":"missing authorization header"} / {"error":"invalid or expired token"}
POST/api/v1/storefront/account/personalization/optoutCliente

Desliga a personalização

O cliente deixa de receber a ordem personalizada; a vitrine volta à ordem editorial. O perfil aprendido não é apagado. É idempotente: chamar de novo não muda nada.

bash
curl -X POST "$BASE_URL/api/v1/storefront/account/personalization/optout" \
  -H "Authorization: Bearer $TOKEN"
200Desligada
json
{ "status": "opted_out" }
POST/api/v1/storefront/account/personalization/optinCliente

Religa a personalização

Desfaz o optout. Também é idempotente. Se o perfil aprendido tiver sido apagado, a loja começa a aprender de novo do zero.

bash
curl -X POST "$BASE_URL/api/v1/storefront/account/personalization/optin" \
  -H "Authorization: Bearer $TOKEN"
200Ligada
json
{ "status": "opted_in" }
DELETE/api/v1/storefront/account/personalizationCliente

Apaga o perfil aprendido

Apaga o que a loja aprendeu sobre o cliente e o deixa desligado (enabled: false), para a loja não começar a aprender de novo sem um novo consentimento. É o "direito de apagar" da LGPD. Para religar depois, chame optin.

bash
curl -X DELETE "$BASE_URL/api/v1/storefront/account/personalization" \
  -H "Authorization: Bearer $TOKEN"
200Apagado
json
{ "status": "deleted" }
StatusQuandoCorpo
401Sem token, ou token inválido ou expirado{"error":"missing authorization header"} / {"error":"invalid or expired token"}
500Falha ao gravar a escolha{"error":"failed","detail":"..."}
Uma tela só

Mostre um interruptor "Personalizar minha loja" ligado a enabled, e um botão "Apagar o que a loja aprendeu" ligado ao DELETE. A primeira chamada de leitura já diz o estado atual.

Veja também

  • Perfil
  • Conta do cliente
Anterior
Campos do perfil
Próxima
Sellers e microsites
Nesta página
  • Veja também