VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Configurações do seller

Vitrine própria do seller

Lê a configuração da vitrine própria (microsite) que um seller montou, com marca, cores, domínio e SEO.

Além de vender dentro da loja, um seller pode montar uma vitrine própria (um "microsite") com logo, banner, cores, links sociais, SEO e até um domínio dele. O seller edita isso pelo painel dele; o administrador só lê, por esta rota. Exige manage_vendor_storefronts ou manage_vendors.

Ler a vitrine de um seller

GET/api/v1/admin/vendors/{vendorId}/storefront-configAdmin

Lê a configuração da vitrine própria de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
200Configuração da vitrine
json
{
  "id": "a1b0051f-cd43-4e8e-b27a-b0f88a03bd42",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "custom_domain": "loja.exemplo.com.br",
  "logo_url": "https://cdn.exemplo.com.br/logo.png",
  "banner_url": "https://cdn.exemplo.com.br/banner.png",
  "color_scheme": { "primary": "#FF6600", "secondary": "#0f172a" },
  "description": "Cadernos e papelaria artesanal.",
  "seo_title": "Papelaria Aurora",
  "seo_description": "Cadernos, agendas e papelaria artesanal.",
  "social_links": { "instagram": "https://instagram.com/papelariaaurora", "whatsapp": "5511999998888" },
  "custom_css": "body { color: #222; }",
  "is_published": false,
  "created_at": "2026-07-11T07:47:59Z",
  "updated_at": "2026-07-19T19:18:01Z"
}

Campos da resposta

iduuid
Id da configuração. Vazio quando o seller nunca configurou a vitrine.
vendor_iduuid
Seller.
custom_domainstring
Domínio próprio. Ausente se não há.
logo_urlstring
Logo da vitrine.
banner_urlstring
Banner.
color_schemeobject
Cores, por nome (primary, secondary). Vem {} quando não há.
descriptionstring
Descrição da vitrine.
seo_titlestring
Título da página.
seo_descriptionstring
Meta descrição.
social_linksobject
Links de redes sociais por nome. Vem {} quando não há.
custom_cssstring
CSS próprio do seller.
is_publishedboolean
Se a vitrine está publicada.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração.

Erros

StatusQuandoCorpo de exemplo
500Falha ao consultar.{"error":"STOREFRONT_GET_FAILED","detail":"..."}
401 / 403Sem token ou sem privilégio.{"error":"missing authorization header"}
Seller sem vitrine devolve um objeto vazio, não 404

Para um seller que nunca configurou nada (ou um UUID que não é de nenhum seller), a resposta é 200 com id vazio, color_scheme e social_links como {} e is_published: false.

O CSS próprio vem como o seller escreveu

custom_css é texto livre do seller. Se você o mostrar numa tela do painel, trate como conteúdo não confiável: não o injete na página.

Veja também

  • Cadastro do seller
  • Visão geral
Anterior
Reputação do seller
Próxima
Representantes comerciais
Nesta página
  • Ler a vitrine de um seller
  • Erros
  • Veja também