API atual/Referência completa/Sellers e microsites

Microsite

Devolve o microsite público de um seller, por slug ou por domínio próprio.

O microsite é a "loja dentro da loja" do seller: uma página com a identidade visual dele, banners, páginas de conteúdo, posts de blog e as categorias que ele usa. Só existe quando o seller publicou a "Minha Loja" no painel (ou nunca a tocou: sem configuração, o padrão é publicado).

Por slug

GET/api/v1/storefront/vendors/{slug}/micrositePública

Microsite do seller por slug

Devolve o microsite do seller identificado pelo slug. Só aceita slug (não UUID).

Parâmetros de caminho

slugstringobrigatório

Slug do seller.

Por domínio próprio

GET/api/v1/storefront/vendor-microsite/domain/{domain}Pública

Microsite do seller por domínio próprio

Quando o seller aponta um domínio próprio (por exemplo www.modacarioca.com.br) para a Minha Loja dele, o front-end descobre de qual seller é o domínio com esta rota e recebe o mesmo microsite.

Parâmetros de caminho

domainstringobrigatório

Domínio cadastrado pelo seller, sem https:// e sem barra (www.modacarioca.com.br). Igualdade exata.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/moda-carioca/microsite"

Resposta

200Microsite

json

{
  "vendor_id": "c0000000-0000-0000-0000-000000000002",
  "company_name": "Moda Carioca",
  "slug": "moda-carioca",
  "logo_url": "https://cdn.example.com/moda-carioca/logo.png",
  "banner_url": "https://cdn.example.com/moda-carioca/banner.jpg",
  "description": "A melhor moda do Rio de Janeiro para você.",
  "color_scheme": { "primary": "#e11d48" },
  "social_links": { "instagram": "https://instagram.com/modacarioca" },
  "seo_title": "Moda Carioca",
  "product_count": 128,
  "city": "Rio de Janeiro",
  "state": "RJ",
  "created_at": "2026-03-06T10:25:37.86958Z",
  "banners": [],
  "blog_posts": [],
  "pages": [],
  "categories": []
}

Campos da resposta

vendor_iduuid

Id do seller.

company_namestring

Nome fantasia.

slugstring

Slug.

logo_urlstring

Logotipo. Ausente se não houver.

banner_urlstring

Banner. Ausente se não houver.

descriptionstring

Descrição. Ausente se não houver.

color_schemeobject

Cores. {} se o seller não definiu.

social_linksobject

Redes sociais. {} se o seller não definiu.

custom_cssstring

CSS próprio. Ausente se não houver.

seo_titlestring

Título para buscadores. Na falta, o nome fantasia.

seo_descriptionstring

Meta descrição. Ausente se não houver.

product_countinteger

Produtos ativos.

citystring

Cidade.

statestring

UF.

created_atstring

RFC 3339.

bannersobject[]

Banners ativos do seller. [] se não houver.

pagesobject[]

Páginas de conteúdo publicadas do seller. [] se não houver.

blog_postsobject[]

Posts de blog publicados do seller. [] se não houver.

categoriesobject[]

Categorias ativas do próprio seller. [] se não houver. Rascunhos e inativas só aparecem no painel dele.

Erros

Status	Quando	Corpo
404	Seller sem microsite: inexistente, inativo, com a Minha Loja despublicada, ou (por domínio) nenhum seller usa esse domínio.	`{"error":"MICROSITE_NOT_FOUND","detail":"vendor microsite not found"}`
500	Falha ao ler o microsite.	`{"error":"MICROSITE_GET_FAILED","detail":"..."}`

Por domínio, a mensagem de detail do 404 é no vendor configured for this domain.

Veja também

Microsite

Devolve o microsite público de um seller, por slug ou por domínio próprio.

Por slug

GET/api/v1/storefront/vendors/{slug}/micrositePública

Microsite do seller por slug

Devolve o microsite do seller identificado pelo slug. Só aceita slug (não UUID).

Parâmetros de caminho

slugstringobrigatório

Slug do seller.

Por domínio próprio

GET/api/v1/storefront/vendor-microsite/domain/{domain}Pública

Microsite do seller por domínio próprio

Parâmetros de caminho

domainstringobrigatório

Domínio cadastrado pelo seller, sem https:// e sem barra (www.modacarioca.com.br). Igualdade exata.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/moda-carioca/microsite"

Resposta

200Microsite

json

{
  "vendor_id": "c0000000-0000-0000-0000-000000000002",
  "company_name": "Moda Carioca",
  "slug": "moda-carioca",
  "logo_url": "https://cdn.example.com/moda-carioca/logo.png",
  "banner_url": "https://cdn.example.com/moda-carioca/banner.jpg",
  "description": "A melhor moda do Rio de Janeiro para você.",
  "color_scheme": { "primary": "#e11d48" },
  "social_links": { "instagram": "https://instagram.com/modacarioca" },
  "seo_title": "Moda Carioca",
  "product_count": 128,
  "city": "Rio de Janeiro",
  "state": "RJ",
  "created_at": "2026-03-06T10:25:37.86958Z",
  "banners": [],
  "blog_posts": [],
  "pages": [],
  "categories": []
}

Campos da resposta

vendor_iduuid

Id do seller.

company_namestring

Nome fantasia.

slugstring

Slug.

logo_urlstring

Logotipo. Ausente se não houver.

banner_urlstring

Banner. Ausente se não houver.

descriptionstring

Descrição. Ausente se não houver.

color_schemeobject

Cores. {} se o seller não definiu.

social_linksobject

Redes sociais. {} se o seller não definiu.

custom_cssstring

CSS próprio. Ausente se não houver.

seo_titlestring

Título para buscadores. Na falta, o nome fantasia.

seo_descriptionstring

Meta descrição. Ausente se não houver.

product_countinteger

Produtos ativos.

citystring

Cidade.

statestring

UF.

created_atstring

RFC 3339.

bannersobject[]

Banners ativos do seller. [] se não houver.

pagesobject[]

Páginas de conteúdo publicadas do seller. [] se não houver.

blog_postsobject[]

Posts de blog publicados do seller. [] se não houver.

categoriesobject[]

Categorias ativas do próprio seller. [] se não houver. Rascunhos e inativas só aparecem no painel dele.

Erros

Status	Quando	Corpo
404	Seller sem microsite: inexistente, inativo, com a Minha Loja despublicada, ou (por domínio) nenhum seller usa esse domínio.	`{"error":"MICROSITE_NOT_FOUND","detail":"vendor microsite not found"}`
500	Falha ao ler o microsite.	`{"error":"MICROSITE_GET_FAILED","detail":"..."}`

Por domínio, a mensagem de detail do 404 é no vendor configured for this domain.