VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Cadastro de sellers

Vitrines dos sellers

Lista as configurações de vitrine própria (microsite) dos sellers, com domínio, identidade visual, SEO e publicação.

Além de vender dentro da loja principal, o seller pode montar uma vitrine própria, um microsite com logo, banner, cores, descrição, redes sociais, CSS próprio e até um domínio personalizado. O seller edita isso pelo painel dele; o administrador só lê. Esta rota é o inventário: quem configurou o quê, qual domínio pediu e se está publicado.

Exige manage_vendor_storefronts ou manage_vendors.

Listar vitrines

Devolve as configurações de vitrine existentes, da mais recentemente alterada para a mais antiga, com paginação. Só aparece quem já salvou alguma configuração.

GET/api/v1/admin/vendor-storefrontsAdmin

Lista as vitrines dos sellers

Parâmetros de consulta

pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página. Use valores positivos: a rota não corrige 0 nem negativos.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/vendor-storefronts?per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Vitrines retornadas
json
{
  "page": 1,
  "per_page": 20,
  "storefronts": [
    {
      "id": "a1b0051f-cd43-4e8e-b27a-b0f88a03bd42",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "custom_domain": "loja.exemplo.com.br",
      "logo_url": "https://exemplo.com/logo.png",
      "banner_url": "https://exemplo.com/banner.png",
      "color_scheme": { "primary": "#FF6600", "secondary": "#0f172a" },
      "description": "Loja de artesanato em cerâmica.",
      "seo_title": "Cerâmica Artesanal",
      "seo_description": "Peças feitas à mão.",
      "social_links": { "instagram": "https://instagram.com/exemplo", "whatsapp": "5511999998888" },
      "custom_css": "body { color: #222; }",
      "is_published": false,
      "created_at": "2026-07-11T07:47:59.67484Z",
      "updated_at": "2026-07-19T19:18:01.610661Z"
    }
  ],
  "total": 2,
  "total_pages": 1
}

Campos da resposta

storefrontsarray
Configurações da página. Vazio ([]) quando não há nenhuma.
totalinteger
Total de configurações, em todas as páginas.
pageinteger
Página devolvida.
per_pageinteger
Itens por página, como enviado.
total_pagesinteger
Número de páginas.
storefronts[].iduuid
Id da configuração.
storefronts[].vendor_iduuid
Seller dono da vitrine.
storefronts[].custom_domainstring
Domínio personalizado pedido. Ausente se não houver.
storefronts[].logo_urlstring
Logo. Ausente se não houver.
storefronts[].banner_urlstring
Banner. Ausente se não houver.
storefronts[].color_schemeobject
Cores, como pares nome e valor (primary, secondary...). {} se vazio.
storefronts[].descriptionstring
Descrição da loja.
storefronts[].seo_titlestring
Título para buscadores.
storefronts[].seo_descriptionstring
Descrição para buscadores.
storefronts[].social_linksobject
Redes sociais, como pares nome e endereço. {} se vazio.
storefronts[].custom_cssstring
CSS próprio do seller.
storefronts[].is_publishedboolean
Se a vitrine está publicada.
storefronts[].created_atstring
Criação, RFC 3339 em UTC.
storefronts[].updated_atstring
Última alteração, RFC 3339 em UTC.

Erros

StatusQuandoCorpo
401 / 403Sem token ou sem privilégio{"error":"insufficient privileges", ...}
500Falha interna{"error":"STOREFRONTS_LIST_FAILED","detail":"..."}
CSS próprio é conteúdo do seller

custom_css é texto livre escrito por quem vende. Se você exibir ou injetar esse CSS em alguma tela sua, trate-o como conteúdo não confiável.

per_page zero

Com per_page=0 a lista volta vazia e total_pages vem com um número absurdo (negativo). Não envie zero nem valores negativos.

Veja também

  • Candidaturas
  • Cadastro de sellers: visão geral
Anterior
Termos de uso dos sellers
Próxima
Planos de seller
Nesta página
  • Listar vitrines
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também