API atual/Referência completa/Sellers e microsites

Consultar seller

Devolve a ficha pública de um seller, por UUID ou por slug.

Devolve a ficha pública de um seller: o que a página dele precisa para o cabeçalho. Se o seller editou a "Minha Loja", logotipo, banner e descrição vêm de lá, junto com as cores, as redes sociais, o CSS e o SEO dele.

Por UUID ou slug

GET/api/v1/storefront/vendors/{id}Pública

Consulta um seller por UUID ou slug

Aceita o UUID ou o slug em {id}; o servidor decide pelo formato.

Parâmetros de caminho

idstringobrigatório

UUID ou slug do seller.

Somente por slug

GET/api/v1/storefront/vendors/by-slug/{slug}Pública

Consulta um seller por slug

Igual à rota anterior, mas só entende slug. Útil quando o seu código já sabe que o trecho da URL é um slug e não quer ambiguidade.

Parâmetros de caminho

slugstringobrigatório

Slug do seller.

Exemplo de requisição

bash

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

Resposta

200Ficha do seller

json

{
  "id": "c0000000-0000-0000-0000-000000000002",
  "display_id": 1,
  "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ê.",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "product_count": 128,
  "min_order_amount": 15000,
  "is_on_vacation": false,
  "created_at": "2026-03-06T10:25:37.86958Z",
  "color_scheme": { "primary": "#e11d48" },
  "social_links": { "instagram": "https://instagram.com/modacarioca" },
  "seo_title": "Moda Carioca | Roupas do Rio"
}

Campos da resposta

iduuid

Id do seller.

display_idinteger

Número curto sequencial.

company_namestring

Nome fantasia.

slugstring

Slug.

logo_urlstring

Logotipo (da Minha Loja, se houver; senão da ficha). Ausente se não houver.

banner_urlstring

Banner, com a mesma regra. Ausente se não houver.

descriptionstring

Descrição, com a mesma regra. Ausente se não houver.

citystring

Cidade.

statestring

UF.

product_countinteger

Produtos ativos.

min_order_amountinteger

Pedido mínimo do seller em centavos. Ausente (equivale a 0) quando não há mínimo.

is_on_vacationboolean

Seller em modo férias.

vacation_messagestring

Mensagem de férias, quando houver.

created_atstring

RFC 3339.

color_schemeobject

Cores da Minha Loja (nome da cor para valor CSS). Só aparece quando o seller definiu.

social_linksobject

Redes sociais (nome da rede para URL). Só aparece quando o seller definiu.

custom_cssstring

CSS próprio da Minha Loja. Aplique com cuidado: é conteúdo do seller.

seo_titlestring

Título da página para buscadores.

seo_descriptionstring

Meta descrição para buscadores.

Erros

Status	Quando	Corpo
400	Slug vazio em `by-slug`.	`{"error":"slug is required"}`
401	Loja que exige login para navegar e chamada sem token.	`{"error":"shopping_requires_login","message":"this storefront requires login to browse"}`
404	Seller inexistente, inativo, apagado, com a Minha Loja despublicada, restrito a outro grupo de clientes, ou que não entrega ao cliente. Sempre a mesma resposta, para não revelar quais existem.	`{"error":"vendor not found"}`
500	Falha ao ler o seller.	`{"error":"failed to get vendor","detail":"..."}`

Veja também

Consultar seller

Devolve a ficha pública de um seller, por UUID ou por slug.

Por UUID ou slug

GET/api/v1/storefront/vendors/{id}Pública

Consulta um seller por UUID ou slug

Aceita o UUID ou o slug em {id}; o servidor decide pelo formato.

Parâmetros de caminho

idstringobrigatório

UUID ou slug do seller.

Somente por slug

GET/api/v1/storefront/vendors/by-slug/{slug}Pública

Consulta um seller por slug

Igual à rota anterior, mas só entende slug. Útil quando o seu código já sabe que o trecho da URL é um slug e não quer ambiguidade.

Parâmetros de caminho

slugstringobrigatório

Slug do seller.

Exemplo de requisição

bash

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

Resposta

200Ficha do seller

json

{
  "id": "c0000000-0000-0000-0000-000000000002",
  "display_id": 1,
  "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ê.",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "product_count": 128,
  "min_order_amount": 15000,
  "is_on_vacation": false,
  "created_at": "2026-03-06T10:25:37.86958Z",
  "color_scheme": { "primary": "#e11d48" },
  "social_links": { "instagram": "https://instagram.com/modacarioca" },
  "seo_title": "Moda Carioca | Roupas do Rio"
}

Campos da resposta

iduuid

Id do seller.

display_idinteger

Número curto sequencial.

company_namestring

Nome fantasia.

slugstring

Slug.

logo_urlstring

Logotipo (da Minha Loja, se houver; senão da ficha). Ausente se não houver.

banner_urlstring

Banner, com a mesma regra. Ausente se não houver.

descriptionstring

Descrição, com a mesma regra. Ausente se não houver.

citystring

Cidade.

statestring

UF.

product_countinteger

Produtos ativos.

min_order_amountinteger

Pedido mínimo do seller em centavos. Ausente (equivale a 0) quando não há mínimo.

is_on_vacationboolean

Seller em modo férias.

vacation_messagestring

Mensagem de férias, quando houver.

created_atstring

RFC 3339.

color_schemeobject

Cores da Minha Loja (nome da cor para valor CSS). Só aparece quando o seller definiu.

social_linksobject

Redes sociais (nome da rede para URL). Só aparece quando o seller definiu.

custom_cssstring

CSS próprio da Minha Loja. Aplique com cuidado: é conteúdo do seller.

seo_titlestring

Título da página para buscadores.

seo_descriptionstring

Meta descrição para buscadores.

Erros

Status	Quando	Corpo
400	Slug vazio em `by-slug`.	`{"error":"slug is required"}`
401	Loja que exige login para navegar e chamada sem token.	`{"error":"shopping_requires_login","message":"this storefront requires login to browse"}`
404	Seller inexistente, inativo, apagado, com a Minha Loja despublicada, restrito a outro grupo de clientes, ou que não entrega ao cliente. Sempre a mesma resposta, para não revelar quais existem.	`{"error":"vendor not found"}`
500	Falha ao ler o seller.	`{"error":"failed to get vendor","detail":"..."}`