API atual/Referência completa/Identidade e configurações da loja

Relatório de personalização

Mostra quanto da demanda personalizada dos compradores se alinha às categorias, marcas e faixa de preço do catálogo do próprio seller.

A loja pode personalizar a vitrine para cada comprador (o que aparece primeiro na home, na categoria e na busca), com base no perfil de interesse dele. Ligar ou desligar isso é decisão do administrador. Este relatório é só leitura e mostra ao seller se o catálogo dele combina com o que os compradores procuram. Traz apenas totais: nenhum dado de comprador individual.

GET/api/v1/vendor/personalization/reportSeller

Aderência do catálogo à demanda

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/personalization/report" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Relatório

json

{
  "profiles_total": 18420,
  "profiles_reached": 9310,
  "price_aligned": 12080,
  "vendor_products": 128,
  "vendor_categories": 6,
  "vendor_brands": 14,
  "price_min_cents": 1990,
  "price_max_cents": 249900,
  "top_categories": [
    {
      "key": "54227821-63c2-45f8-aa1c-4dc40e599f8c",
      "label": "Casa e Cozinha",
      "profiles": 4120,
      "demand": 1385.4
    }
  ],
  "top_brands": [
    {
      "key": "b1a0c7de-2f43-4f4e-8c8b-0a0c6c5b7f21",
      "label": "Marca Exemplo",
      "profiles": 1210,
      "demand": 402.7
    }
  ],
  "generated_at": "2026-10-11T21:40:12Z"
}

Campos da resposta

profiles_totalinteger

Perfis de interesse de toda a loja que podem ser usados (quem pediu para não ser personalizado fica de fora).

profiles_reachedinteger

Perfis com afinidade a pelo menos uma categoria ou marca do seller.

price_alignedinteger

Perfis cuja faixa de preço preferida se sobrepõe à faixa dos produtos do seller.

vendor_productsinteger

Produtos do seller considerados (não excluídos).

vendor_categoriesinteger

Categorias-raiz distintas do seller.

vendor_brandsinteger

Marcas distintas do seller.

price_min_centsinteger

Menor preço do catálogo, em centavos. 0 sem produtos com preço.

price_max_centsinteger

Maior preço do catálogo, em centavos.

top_categoriesarray

Até 10 categorias-raiz do seller com mais demanda.

keystring

Id da categoria-raiz ou da marca.

labelstring

Nome legível (igual a key quando o nome não é encontrado).

profilesinteger

Perfis de comprador com afinidade maior que zero.

demandnumber

Soma dos pesos de afinidade: demanda relativa, sem unidade.

top_brandsarray

Até 10 marcas do seller com mais demanda.

keystring

Id da categoria-raiz ou da marca.

labelstring

Nome legível (igual a key quando o nome não é encontrado).

profilesinteger

Perfis de comprador com afinidade maior que zero.

demandnumber

Soma dos pesos de afinidade: demanda relativa, sem unidade.

generated_atstring

RFC 3339. Momento do cálculo (é recalculado a cada chamada).

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário tem papel de seller, mas não está ligado a nenhum seller.	`{"error":"no vendor account associated with this user"}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_catalog`, `vendor_view_catalog`, `vendor_manage_products`, `vendor_manage_master`, `vendor_manage_mix`, `vendor_manage_quotes`, `vendor_manage_features`, `vendor_import_products`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}`
500	Falha ao montar o relatório.	`{"error":"failed to build personalization report"}`

Relatório de personalização

Mostra quanto da demanda personalizada dos compradores se alinha às categorias, marcas e faixa de preço do catálogo do próprio seller.

GET/api/v1/vendor/personalization/reportSeller

Aderência do catálogo à demanda

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/personalization/report" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Relatório

json

{
  "profiles_total": 18420,
  "profiles_reached": 9310,
  "price_aligned": 12080,
  "vendor_products": 128,
  "vendor_categories": 6,
  "vendor_brands": 14,
  "price_min_cents": 1990,
  "price_max_cents": 249900,
  "top_categories": [
    {
      "key": "54227821-63c2-45f8-aa1c-4dc40e599f8c",
      "label": "Casa e Cozinha",
      "profiles": 4120,
      "demand": 1385.4
    }
  ],
  "top_brands": [
    {
      "key": "b1a0c7de-2f43-4f4e-8c8b-0a0c6c5b7f21",
      "label": "Marca Exemplo",
      "profiles": 1210,
      "demand": 402.7
    }
  ],
  "generated_at": "2026-10-11T21:40:12Z"
}

Campos da resposta

profiles_totalinteger

Perfis de interesse de toda a loja que podem ser usados (quem pediu para não ser personalizado fica de fora).

profiles_reachedinteger

Perfis com afinidade a pelo menos uma categoria ou marca do seller.

price_alignedinteger

Perfis cuja faixa de preço preferida se sobrepõe à faixa dos produtos do seller.

vendor_productsinteger

Produtos do seller considerados (não excluídos).

vendor_categoriesinteger

Categorias-raiz distintas do seller.

vendor_brandsinteger

Marcas distintas do seller.

price_min_centsinteger

Menor preço do catálogo, em centavos. 0 sem produtos com preço.

price_max_centsinteger

Maior preço do catálogo, em centavos.

top_categoriesarray

Até 10 categorias-raiz do seller com mais demanda.

keystring

Id da categoria-raiz ou da marca.

labelstring

Nome legível (igual a key quando o nome não é encontrado).

profilesinteger

Perfis de comprador com afinidade maior que zero.

demandnumber

Soma dos pesos de afinidade: demanda relativa, sem unidade.

top_brandsarray

Até 10 marcas do seller com mais demanda.

keystring

Id da categoria-raiz ou da marca.

labelstring

Nome legível (igual a key quando o nome não é encontrado).

profilesinteger

Perfis de comprador com afinidade maior que zero.

demandnumber

Soma dos pesos de afinidade: demanda relativa, sem unidade.

generated_atstring

RFC 3339. Momento do cálculo (é recalculado a cada chamada).

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário tem papel de seller, mas não está ligado a nenhum seller.	`{"error":"no vendor account associated with this user"}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_catalog`, `vendor_view_catalog`, `vendor_manage_products`, `vendor_manage_master`, `vendor_manage_mix`, `vendor_manage_quotes`, `vendor_manage_features`, `vendor_import_products`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}`
500	Falha ao montar o relatório.	`{"error":"failed to build personalization report"}`